Updated on 2024-06-19 GMT+08:00

Adding CTS Resource Tags in Batches

Function

This API is used to add CTS resource tags in batches.

URI

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

Table 1 Path parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID. For details, see Obtaining an Account ID and Project ID.

resource_id

Yes

String

Resource ID.

resource_type

Yes

String

Resource type of CTS. Currently, only cts-tracker is supported.

Value:

  • cts-tracker

Request Parameters

Table 2 Request body parameter

Parameter

Mandatory

Type

Description

tags

No

Array of Tags objects

List of tags.

Table 3 Tags

Parameter

Mandatory

Type

Description

key

No

String

Tag key, which can contain a maximum of 128 Unicode characters. A tag value can contain letters, digits, spaces, and special characters (_.:/=+-@). It cannot start or end with a space, or start with _sys_.

value

No

String

Tag value, which can contain a maximum of 255 Unicode characters. If value is specified, tags are deleted by key and value. If value is not specified, tags are deleted by key. A tag value can contain letters, digits, spaces, and special characters (_.:/=+-@) but cannot start or end with a space.

Response Parameters

Status code: 401

Table 4 Response body parameters

Parameter

Type

Description

error_code

String

Error code. Format: CTS.XXX.

error_msg

String

Error message.

Status code: 403

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Error code. Format: CTS.XXX.

error_msg

String

Error message.

Status code: 404

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code. Format: CTS.XXX.

error_msg

String

Error message.

Status code: 500

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error code. Format: CTS.XXX.

error_msg

String

Error message.

Status code: 503

Table 8 Response body parameters

Parameter

Type

Description

error_code

String

Error code. Format: CTS.XXX.

error_msg

String

Error message.

Example Request

Example of creating a tracker tag:

POST https://{endpoint}/v3/{project_id}/{resource_type}/{resource_id}/tags/create

{
  "tags" : [ {
    "key" : "111",
    "value" : "33"
  } ]
}

Example Response

None

Status Codes

Status Code

Description

200

The creation is successful.

401

The request is rejected due to authentication failure.

403

The server understood the request but refused to authorize it.

404

The requested resource does not exist.

500

Failed to complete the request because of an internal service error.

503

The requested service is invalid. The client should not repeat the request without modifications.

Error Codes

For details, see Error Codes.