Querying Resource Tags

Updated on 2024-03-26 GMT+08:00

View PDF

Function

This API is used to query resource tags.

URI

GET /v2/{project_id}/{resource_type}/tags

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID. For details, see Obtaining a Project ID.
resource_type	Yes	String	Resource type. Enter "functions" here.

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	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.
Content-Type	Yes	String	Message body type (format).

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
tags	Array of TagItem objects	Tag list.
sys_tags	Array of TagItem objects	System tags.

**Table 4** TagItem
Parameter	Type	Description
key	String	Key.
values	Array of strings	Value.

Status code: 400

**Table 5** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Status code: 401

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Status code: 403

**Table 7** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Status code: 500

**Table 8** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Example Requests

Query resource tags.

GET https://{Endpoint}/v2/{project_id}/{resource_type}/tags

Example Responses

Status code: 200

{
  "tags" : [ {
    "key" : "xxx",
    "values" : [ "yyy", "zzz" ]
  } ],
  "sys_tags" : [ {
    "key" : "_sys_enterprise_project_id",
    "values" : [ "5aa119a8-d25b-45a7-8d1b-88e127885635" ]
  } ]
}