機能の概要
このAPIは、指定されたOceanBaseクラスタ内の特定のテナントのタグ情報を変更するために使用されます。このAPIを使用して、リソースの分類と管理を目的としたテナントのタグリストを更新できます。
呼び出しの説明
インターフェース制約
呼び出し元はマルチクラウドAPIにアクセスするためのキーを保有している必要があります。AccessKey IDとAccessKey Secretの取得方法については、アクセスキーの管理をご参照ください。
リクエストパス
POST /api/v2/instances/{instanceId}/tenants/{tenantId}/tagList
リクエストパラメータ
Path
パラメータ名 |
型 |
必須 |
説明 |
サンプル値 |
|---|---|---|---|---|
| instanceId | String | はい | OceanBaseクラスタID | obcluster-***** |
| tenantId | String | はい | テナントID | t4louaeei**** |
Query
名前 |
型 |
必須 |
説明 |
サンプル値 |
|---|---|---|---|---|
| requestId | String | はい | リクエストID。追跡に使用されます | dc302d76-66b5-48d8-ab53-a035******** |
Header
名前 |
型 |
必須 |
説明 |
サンプル値 |
|---|---|---|---|---|
| X-Ob-Project-Id | String | はい | プロジェクトID | hxq3ztx3377nby3v87ry**** |
Body
名前 |
型 |
必須 |
説明 |
サンプル値 |
|---|---|---|---|---|
| tagList | Array | はい | タグのリスト | [ { "tagKey":"test1", "tagValue":"test1" } ] |
実行結果
名前 |
型 |
説明 |
サンプル値 |
|---|---|---|---|
| data | bool | 成功かどうか | true |
| requestId | string | リクエストID | 4c437bbe-d404-4b7a-afcb-88749e4d47a2 |
| success | bool | リクエストが成功したかどうか | true |
例
リクエスト例
curl --digest -u '<あなたのAK:SK>' \
-X POST \
-H 'Content-Type: application/json' \
-H 'X-Ob-Project-Id: hxq3ztx3377nby3v87ry****' \
'https://api-cloud.oceanbase.com/api/v2/instances/{instanceId}/tenants/{tenantId}/tagList?requestId={requestId}' \
--data '{ "tagList" : [ { "tagKey":"test1", "tagValue":"test1" } ]}'
実行結果例
JSON形式
{
"data": true,
"requestId": "4c437bbe-d404-4b7a-afcb-88749e4d47a2",
"success": true
}