← Resource Tagging / resource-tagging
Začínáme
Tento návod vás provede ověřením, že tagování ve vašem účtu funguje, a provedením prvních volání API.
Předpoklady
- Alespoň jeden uživatel s rolí Super Administrator, Workers Admin nebo Tag Admin. Tyto role umožňují vytvářet, aktualizovat a mazat tagy.
- API je preferované rozhraní pro správu tagů. Můžete také použít dashboard v části Manage Account > Značkování prostředků, ale měli byste umět bez problémů vytvářet ověřené HTTP požadavky pro automatizované postupy.
- API token s potřebnými oprávněními. Account Owned Tokens se doporučují pro automatizaci.
1. Ověřte, že je označování tagy povolené
Otestujte API a ověřte, že je tagování ve vašem účtu aktivní:
curl -X GET "https://api.cloudflare.com/client/v4/accounts/$ACCOUNT_ID/tags/keys" \
-H "Authorization: Bearer $API_TOKEN" \
-H "Content-Type: application/json"Interpretace odpovědi
| Odpověď | Význam | Akce |
|---|---|---|
200 OK hodnotou {"success": true, "result": [...]} |
Tagování je povoleno. Prázdné pole je normální, pokud zatím žádné tagy neexistují. | Pokračujte dalším krokem. |
| 403 zmiňující "permission" nebo "role" | Volající nemá požadovaná oprávnění. | Ověřte, že volající má roli Super Admin, Workers Admin nebo Tag Admin, případně že token má #com.cloudflare.api.account.tag.list rozsah. |
| 403 zmiňující "feature" nebo "gate" | Pro tento účet není tagování povoleno. | Kontaktujte podpora Cloudflare s žádostí o pomoc. |
| 401 Unauthorized | Ověření selhalo. | Ověřte, že token je platný, nevypršel a je správně naformátován v Authorization: Bearer hlavička. |
| Jakákoli jiná odpověď | Neočekávaná chyba. | Zachyťte celé tělo odpovědi a kontaktujte podpora Cloudflare s ID účtu, podrobnostmi požadavku a časovým razítkem. |
2. Vytvořte první tagy
Nastavte tagy na zdroji pomocí PUT:
curl -X PUT "https://api.cloudflare.com/client/v4/accounts/$ACCOUNT_ID/tags" \
-H "Authorization: Bearer $API_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"resource_type": "worker",
"resource_id": "'"$RESOURCE_ID"'",
"tags": {
"environment": "production",
"team": "platform"
}
}'Poté načtěte tagy:
curl -X GET "https://api.cloudflare.com/client/v4/accounts/$ACCOUNT_ID/tags?resource_type=worker&resource_id=$RESOURCE_ID" \
-H "Authorization: Bearer $API_TOKEN" \
-H "Content-Type: application/json"3. Zobrazte seznam označených prostředků
Dotazujte se na všechny označené zdroje v účtu, volitelně s filtrováním podle tagu:
# All tagged resources
curl -X GET "https://api.cloudflare.com/client/v4/accounts/$ACCOUNT_ID/tags/resources" \
-H "Authorization: Bearer $API_TOKEN"
# Filter: only resources with environment=production
curl -X GET "https://api.cloudflare.com/client/v4/accounts/$ACCOUNT_ID/tags/resources?tag=environment=production" \
-H "Authorization: Bearer $API_TOKEN"Další kroky
- Seznamte se s úplným syntaxe filtrování podle značek pro složité dotazy.
- Seznamte se s Postup GET, sloučení, PUT pro úpravu jednotlivých tagů.
- Zkontrolujte podporované typy prostředků a jejich povinná pole.
- Zkontrolujte Limity API a pravidla validace.