Overview
You can call this API to modify the tags of a specific tenant in an OceanBase cluster. You can update the tag list of a tenant to classify and manage resources.
API details
Constraints
The caller must have an AccessKey for accessing the multi-cloud API. For information about how to obtain the AccessKey ID and AccessKey secret, see Manage AccessKeys.
Request path
POST /api/v2/instances/{instanceId}/tenants/{tenantId}/tagList
Request parameters
Path
Parameter |
Type |
Required |
Description |
Example value |
|---|---|---|---|---|
| instanceId | String | Yes | The ID of the OceanBase cluster. | obcluster-***** |
| tenantId | String | Yes | The ID of the tenant. | t4louaeei**** |
Query
Name |
Type |
Required |
Description |
Example value |
|---|---|---|---|---|
| requestId | String | Yes | The request ID for tracking. | dc302d76-66b5-48d8-ab53-a035******** |
Header
Name |
Type |
Required |
Description |
Example value |
|---|---|---|---|---|
| X-Ob-Project-Id | String | Yes | The project ID. | hxq3ztx3377nby3v87ry**** |
Body
Name |
Type |
Required |
Description |
Example value |
|---|---|---|---|---|
| tagList | Array | Yes | The tag list. | [ { "tagKey":"test1", "tagValue":"test1" } ] |
Response parameters
Parameter |
Type |
Description |
Example value |
|---|---|---|---|
| data | bool | Indicates whether the operation succeeded. | true |
| requestId | string | The request ID. | 4c437bbe-d404-4b7a-afcb-88749e4d47a2 |
| success | bool | Indicates whether the request was successful. | true |
Examples
Request example
curl --digest -u '<Your 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" } ]}'
Response example
JSON format
{
"data": true,
"requestId": "4c437bbe-d404-4b7a-afcb-88749e4d47a2",
"success": true
}