Updated on 2024-05-30 GMT+08:00

Adding a Resource Tag

Function

This API is used to add tags to specified real-time services. If a tag to be added has the same key as an existing tag, the tag will overwrite the existing one.

Debugging

You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.

URI

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

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID. For details, see Obtaining a Project ID and Name.

resource_id

Yes

String

Resource ID (service ID)

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

Content-Type

Yes

String

This field is set to application/json;charset=utf8.

X-Auth-Token

Yes

String

User token, which can be obtained by calling the IAM API that is used for obtaining a user token. The value of X-Subject-Token in the response header is the user token.

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

tags

Yes

Array of TmsTag objects

Specifies the TMS tag list.

Table 4 TmsTag

Parameter

Mandatory

Type

Description

key

Yes

String

TMS tag key The value contains a maximum of 128 characters, cannot start or end with a space, and cannot start with sys.

value

Yes

String

TMS tag value A maximum of 255 characters

Response Parameters

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Error codes of ModelArts.

error_msg

String

Error message.

Status code: 401

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error codes of ModelArts.

error_msg

String

Error message.

Status code: 403

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error codes of ModelArts.

error_msg

String

Error message.

Status code: 404

Table 8 Response body parameters

Parameter

Type

Description

error_code

String

Error codes of ModelArts.

error_msg

String

Error message.

Example Requests

The following is an example of how to add tags to a specified service. The TMS tags have been configured by setting the keys to test and model_version, and setting the corresponding values to service-gpu and 0.1.

https://{endpoint}/v1/{project_id}/services/a55eba18-1ebf-4e9a-8229-d2d3b593a3dc/tags/create

{
  "tags" : [ {
    "key" : "test",
    "value" : "service-gpu"
  }, {
    "key" : "model_version",
    "value" : "0.1"
  } ]
}

Example Responses

None

Status Codes

Status Code

Description

204

The tag is added.

400

Invalid parameter

401

Authentication failed.

403

Insufficient permissions

404

Resources not found

Error Codes

See Error Codes.