機能の概要
このAPIは、指定されたOB Cloudデータベースインスタンスのタグリストを変更するために使用します。このAPIを使用して、インスタンスのタグ情報を更新し、リソース分類、コスト管理、権限制御などのシナリオで利用できます。
呼び出しの説明
インターフェース制約
呼び出し元はマルチクラウドAPIにアクセスするためのキーを保有している必要があります。AccessKey IDとAccessKey Secretの取得方法については、アクセスキーの管理をご参照ください。
リクエストパス
POST /api/v2/instances/{instanceId}/tagList
リクエストパラメータ
Path
名前 |
型 |
必須 |
説明 |
例値 |
|---|---|---|---|---|
| instanceId | String | はい | OB CloudデータベースインスタンスID | obcluster-***** |
Query
名前 |
型 |
必須 |
説明 |
例値 |
|---|---|---|---|---|
| requestId | String | はい | リクエストID。追跡に使用されます | dc302d76-66b5-48d8-ab53-a035******** |
Body
名前 |
型 |
必須 |
説明 |
例値 |
|---|---|---|---|---|
| tagList | array | はい | タグリスト | [{"tagKey":"test1","tagValue":"test1"}] |
戻り結果
名称 |
型 |
説明 |
示例値 |
|---|---|---|---|
| data | boolen | 操作結果 | true |
例
リクエスト例
curl --digest -u '<Your AK:SK>' \
-X POST \
'https://api-cloud.oceanbase.com/api/v2/instances/{instanceId}/tagList?requestId={requestId}' \
-H 'Content-Type: application/json' \
--data '{
"tagList" : [
{
"tagKey":"test1",
"tagValue":"test1"
}
]
}'
レスポンス例
JSON形式
{
"data":true,
"requestId": "4c437bbe-d404-4b7a-afcb-88749e4d47a2",
"success":true
}