Overview
You can call this API to modify the tags of an instance.
API details
Constraints
The caller must have an AccessKey for accessing APIs. For information about how to obtain the AccessKey ID and AccessKey secret, see Manage AccessKeys.
Request path
POST /api/v2/instances/{instanceId}/tagList
Request parameters
Path
Parameter |
Type |
Required |
Description |
Example value |
|---|---|---|---|---|
| instanceId | String | Yes | The ID of the instance. | obcluster-***** |
Query
Parameter |
Type |
Required |
Description |
Example value |
|---|---|---|---|---|
| requestId | String | Yes | The ID of the request. | dc302d76-66b5-48d8-ab53-a035******** |
Body
Parameter |
Type |
Required |
Description |
Example value |
|---|---|---|---|---|
| tagList | array | Yes | The list of tags. | [{"tagKey":"test1","tagValue":"test1"}] |
Response parameters
Parameter |
Type |
Description |
Example value |
|---|---|---|---|
| data | boolen | The result of the operation. | true |
Examples
Request example
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"
}
]
}'
Response example
JSON format
{
"data":true,
"requestId": "4c437bbe-d404-4b7a-afcb-88749e4d47a2",
"success":true
}