このガイドでは、アカウントでタグ付けが動くことを確認し、最初の API 呼び出しを行う手順を説明します。
- Super Administrator、Workers Admin、または Tag Admin ロールを持つユーザーが 1 人以上いること。これらのロールはタグの作成、更新、削除ができます。
- タグの管理には API を推奨します。ダッシュボードの Manage Account > Resource Tagging でも操作できますが、自動化ワークフローでは認証済み HTTP リクエストに慣れている必要があります。
- 必要な権限を持つ API トークン。自動化には Account Owned Tokens を推奨します。
API を試し、アカウントでタグ付けが有効であることを確認します。
curl -X GET "https://api.cloudflare.com/client/v4/accounts/$ACCOUNT_ID/tags/keys" \
-H "Authorization: Bearer $API_TOKEN" \
-H "Content-Type: application/json"| レスポンス | 意味 | 対応 |
|---|---|---|
200 OK と {"success": true, "result": [...]} |
タグ付けは有効です。タグがまだない場合、空配列は正常です。 | 次の手順へ進みます。 |
| 403 で "permission" または "role" と記載 | 呼び出し元に必要な権限がありません。 | 呼び出し元に Super Admin、Workers Admin、または Tag Admin ロールがあるか、トークンに #com.cloudflare.api.account.tag.list スコープがあるかを確認します。 |
| 403 で "feature" または "gate" と記載 | このアカウントではタグ付けが有効になっていません。 | Cloudflare サポート へ問い合わせてください。 |
| 401 Unauthorized | 認証に失敗しました。 | トークンが有効で期限切れでなく、Authorization: Bearer ヘッダーの形式が正しいかを確認します。 |
| その他のレスポンス | 想定外のエラーです。 | レスポンス本文をすべて保存し、Account ID、リクエスト内容、時刻を添えて Cloudflare サポート へ問い合わせてください。 |
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"
}
}'続いてタグを取得します。
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"アカウント内のタグ付きリソースをすべて照会します。タグで絞り込むこともできます。
# 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"- 複雑な照会向けの タグフィルター構文 を確認します。
- 個別タグを変更する GET、マージ、PUT の流れ を理解します。
- 対応リソースタイプ と必須フィールドを確認します。
- API の上限と検証ルール を確認します。