This API is used to query resource tags.

Function

This API is used to obtain tag information about resources (such as models, datasets, and services). For example, in resource management or classification, you can query tags to learn about the usage, status, or other attributes of resources. By calling this API, you can obtain all tags of a specified resource by resource ID. You must have sufficient permissions and the target resource must exist. After the query is successful, the resource tag list is returned. If the query fails, error information 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::listTagsForResource	List	service *	g:EnterpriseProjectId g:ResourceTag/<tag-key>	modelarts:tag:list	-

URI

GET /v2/{project_id}/modelarts-service-v2/{resource_id}/tags

**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: 200

**Table 4** Response body parameters
Parameter	Type	Description
tags	Array of TmsTag objects	Definition List of returned resource tags.

**Table 5** TmsTag
Parameter	Type	Description
key	String	Definition Tag key field. Constraints N/A Range The value can contain 1 to 128 characters. Only letters, digits, spaces, and special characters (_.:=+-@) are allowed. However, the value cannot start or end with a space or start with *sys. Default Value* N/A
value	String	Definition Tag value field. Constraints Only letters, digits, underscores (_), dots (.), slashes (/), equal signs (=), plus signs (+), minus signs (–), and at signs (@) are allowed. Range The value can contain 0 to 255 characters. Default Value N/A

Status code: 400

**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: 401

**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.

Status code: 403

**Table 8** 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 9** 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

Query resource tags.

https://{endpoint}/v2/{project_id}/service/a55eba18-1ebf-4e9a-8229-d2d3b593a3dc/tags

Example Responses

Status code: 200

Response to a normal request.

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

Status Codes

Status Code	Description
200	Response to a normal request.
400	Invalid request parameter.
401	Authentication failed.
403	Insufficient permissions.
404	Resource not found.

Error Codes

See Error Codes.

Parent topic: Service Tag Management

Previous topic: Adding Tags

Next topic: Querying Tags of a Type of Resources

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

For any further questions, feel free to contact us through the chatbot.

Chatbot