Help Center/ Database Security Service/ API Reference/ API/ TMS Tag/ Batch Tagging Resources
Updated on 2025-09-10 GMT+08:00
View PDF
Share

Batch Tagging Resources

Function

Batch Tagging Resources

URI

POST /v1/{project_id}/{resource_type}/{resource_id}/tags/create

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition:

Project ID. You can obtain the value by calling the IAM API for querying the project list of a specified IAM user.

Constraints

N/A

Range:

The value is subject to the return value of the IAM service interface. The value contains 32 to 64 characters.

** Default value**:

N/A

resource_type

Yes

String

Definition:

Resource type

** Restrictions**:

N/A

Range:

  • auditInstance: audit

** Default value**:

N/A

resource_id

Yes

String

Definition:

Resource ID. You can obtain the value from the resource_id field in the API for querying the instance list.

Constraints

N/A

Range:

The value is obtained by calling the API for querying the instance list. The value contains 32 to 64 characters.

Default Value:

N/A

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

** Parameter description**:

User token. You can obtain the token by calling the IAM API used to query the user token. The token is the value of X-Subject-Token in the response header.

** Restrictions**:

N/A

** Value range**:

Used by the IAM service to query the user token.

** Default value**:

N/A
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

tags

No

Array of tags objects

Tag list.

This field is mandatory when the tenant permission is used. For the op_service permission, choose either this field or sys_tags.

sys_tags

No

Array of sys_tags objects

System tag list.

This field is only available to the op_service permission. Choose either this field or tags.

Currently, TMS invokes only one resource_tag structure. The key is fixed as _sys_enterprise_project_id.

The value is UUID or 0. 0 indicates the default enterprise project.
Table 4 tags

Parameter

Mandatory

Type

Description

key

Yes

String

Key. It can contain a maximum of 128 characters.

value

Yes

String

Value. Each value can contain a maximum of 255 characters.
Table 5 sys_tags

Parameter

Mandatory

Type

Description

key

Yes

String

Key. It can contain a maximum of 128 characters.

value

Yes

String

Value. Each value can contain a maximum of 255 characters.

Response Parameters

Status code: 204

Success

Status code: 400

Table 6 Response body parameters

Parameter

Type

Description

details

Array of DbssErrorDetail objects

PDP5 authentication exception information

encoded_authorization_message

String

PDP5 authentication exception information

error_code

String

Error Codes

error_msg

String

Error message.
Table 7 DbssErrorDetail

Parameter

Type

Description

error_code

String

Error Codes

error_msg

String

PDP5 error information

Status code: 403

Table 8 Response body parameters

Parameter

Type

Description

details

Array of DbssErrorDetail objects

PDP5 authentication exception information

encoded_authorization_message

String

PDP5 authentication exception information

error_code

String

Error Codes

error_msg

String

Error message.
Table 9 DbssErrorDetail

Parameter

Type

Description

error_code

String

Error Codes

error_msg

String

PDP5 error information

Status code: 500

Table 10 Response body parameters

Parameter

Type

Description

details

Array of DbssErrorDetail objects

PDP5 authentication exception information

encoded_authorization_message

String

PDP5 authentication exception information

error_code

String

Error Codes

error_msg

String

Error message.
Table 11 DbssErrorDetail

Parameter

Type

Description

error_code

String

Error Codes

error_msg

String

PDP5 error information

Example Requests

/v1/{project_id}/{resource_type}/{resource_id}/tags/create

{
  "tags" : [ {
    "key" : "key1",
    "value" : "value1"
  } ]
}

Example Responses

None

Status Codes

Status Code

Description

204

Success

400

Failed

403

Authorization failed.

500

Server error.

Error Codes

See Error Codes.

Parent topic: TMS Tag