Updated on 2026-07-24 GMT+08:00

Adding Tags

Function

This API is used to add metadata tags for resources (such as models, datasets, and services). For example, in resource management or classification, you can add tags to mark the usage, status, or other attributes of resources. By calling this API, you can add tags in batches. If a tag key already exists, its value will be updated. You must have sufficient permissions and the target resource must exist. After the tags are added successfully, the resource contains the new tag information. If the tags fail to be added, an error message is returned. Common exceptions include permission verification errors, resource non-existence errors, and parameter verification errors.

Debugging

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

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

  • If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
  • If you are using identity policy-based authorization, the following identity policy-based permissions are required.

    Action

    Access Level

    Resource Type (*: required)

    Condition Key

    Alias

    Dependencies

    modelarts::tagResource

    Tagging

    service *

    • g:EnterpriseProjectId

    • g:ResourceTag/<tag-key>

    modelarts:tag:create

    -

    -

    • g:RequestTag/<tag-key>

    • g:TagKeys

URI

POST /v2/{project_id}/modelarts-service-v2/{resource_id}/tags/create

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

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

Constraints

N/A

Range

Project ID.

Default Value

N/A

resource_id

Yes

String

Definition

ID of the resource whose tags are to be created.

Constraints

N/A

Range

N/A

Default Value

N/A

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

workspace_id

No

String

Definition

Workspace ID. workspaceId will be set to null.

Constraints

N/A

Range

N/A

Default Value

N/A

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

Content-Type

Yes

String

Definition

Message body type or format.

Constraints

N/A

Range

  • application/json

  • application/json;charset=utf-8

Default Value

N/A

X-Auth-Token

Yes

String

Definition

User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token. For details about how to obtain the token, see Obtaining a User Token Through Password Authentication.

Constraints

N/A

Range

N/A

Default Value

N/A

Response Parameters

Status code: 204

Added.

Status code: 400

Table 4 Response body parameters

Parameter

Type

Description

error_code

String

  • Definition: ModelArts error code.

Range: N/A.

error_msg

String

Definition: Error message.

Range: N/A.

Status code: 401

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

  • Definition: ModelArts error code.

Range: N/A.

error_msg

String

Definition: Error message.

Range: N/A.

Status code: 403

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

  • Definition: ModelArts error code.

Range: N/A.

error_msg

String

Definition: Error message.

Range: N/A.

Status code: 404

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

  • Definition: ModelArts error code.

Range: N/A.

error_msg

String

Definition: Error message.

Range: N/A.

Example Requests

Add tags.

https://{endpoint}/v2/{project_id}/modelarts-service-v2/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

Added.

400

Invalid request parameter.

401

Authentication failed.

403

Insufficient permissions.

404

Resource not found.

Error Codes

See Error Codes.