Overview
You can call this API to update the key and value of a specified tag. In this API, the id parameter specifies the ID of the tag value (the inner id in the tagValueList), which represents the complete tag to be updated.
API details
Constraints
The caller must have an AccessKey for accessing multi-cloud APIs. For information about how to obtain the AccessKey ID and AccessKey secret, see Manage AccessKeys.
Request path
PUT /api/v2/tags
Request parameters
Query
| Parameter | Type | Required | Description | Example value |
|---|---|---|---|---|
| Action | String | Yes | The API action. Valid value: UpdateIamTag. | UpdateIamTag |
Body
| Parameter | Type | Required | Description | Example value |
|---|---|---|---|---|
| orgId | String | Yes | The ID of the organization. | ukp31txz9tmk6yqckhoxl356 |
| id | Integer | Yes | The ID of the tag value (the inner id in the tagValueList), which represents the complete tag to be updated. | 244 |
| tagKey | String | Yes | The updated tag key. | bxtest-key3 |
| tagValue | String | Yes | The updated tag value. | bxtest-value3 |
Response parameters
| Parameter | Type | Description | Example value |
|---|---|---|---|
| requestId | String | The ID of the request. | - |
| data | Object | The updated tag or the operation result. | - |
| success | Boolean | Indicates whether the request was successful. | true |
Examples
Request example
curl --digest -u 'ak:sk' \
-X PUT \
'https://dev-api-cloud-cn.oceanbase.com/api/v2/tags?Action=UpdateIamTag' \
-H "Content-Type: application/json" \
-d '{
"orgId": "ukp31txz9tmk6yqckhoxl356",
"id": 244,
"tagKey": "bxtest-key3",
"tagValue": "bxtest-value3"
}'
Response example
JSON format
{
"data": {},
"requestId": "",
"success": true
}