機能の概要
このAPIは、指定されたタグのキーと値を更新するために使用します。ここで、idパラメータはタグ値のID（つまりtagValueListの内側のid）であり、更新対象の完全なタグを表します。
呼び出しの説明
インターフェース制約
呼び出し元はマルチクラウドAPIにアクセスするためのキーを保有している必要があります。AccessKey IDとAccessKey Secretの取得方法については、アクセスキーの管理を参照してください。
リクエストパス
PUT /api/v2/tags
リクエストパラメータ
Query
パラメータ名 |
型 |
必須 |
説明 |
サンプル値 |
|---|---|---|---|---|
| Action | String | はい | インターフェースの動作です。UpdateIamTagに固定されています | UpdateIamTag |
Body
パラメータ名 |
型 |
必須 |
説明 |
サンプル値 |
|---|---|---|---|---|
| orgId | String | はい | 組織ID | uk******** |
| id | Integer | はい | タグvalueのID（内部ID）で、更新する完全なタグを表します。 | 244 |
| tagKey | String | はい | 更新後のタグkey | bxtest-key3 |
| tagValue | String | はい | 更新後のタグvalue | bxtest-value3 |
戻り結果
プロパティ |
型 |
説明 |
サンプル値 |
|---|---|---|---|
| requestId | String | リクエストID | - |
| data | Object | 更新後のタグまたは操作結果 | - |
| success | Boolean | 成功かどうか | true |
例
リクエスト例
curl --digest -u 'ak:sk' \
-X PUT \
'https://api-cloud.oceanbase.com/api/v2/tags?Action=UpdateIamTag' \
-H "Content-Type: application/json" \
-d '{
"orgId": "uk********",
"id": 244,
"tagKey": "bxtest-key3",
"tagValue": "bxtest-value3"
}'
返却例
JSON形式
{
"data": {},
"requestId": "",
"success": true
}