On this page

Show all

Help Center/ Cloud Backup and Recovery/ API Reference/ CBR APIs/ Tags/ Querying Tags of an Associated Resource

Querying Tags of an Associated Resource

Updated on 2022-09-19 GMT+08:00

View PDF

Function

This API is used to query tags of a specified resource. TMS uses this API to query all tags of a specified resource.

URI

GET /v3/{project_id}/vault/{vault_id}/tags

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID
vault_id	Yes	String	Resource ID

Request Parameters

None

Response Parameters

Status code: 200

**Table 2** Response body parameters
Parameter	Type	Description
tags	Array of Tag objects	Tag list Keys in the tag list must be unique.
sys_tags	Array of SysTag objects	Only users with the op_service permission can obtain this field. Currently, only resource_tag is included. key: _sys_enterprise_project_id value: enterprise project ID. Value 0 indicates the default enterprise project. This field is not returned in the non-op_service scenario.

**Table 3** Tag
Parameter	Type	Description
key	String	Key It can contain a maximum of 36 characters. It cannot be an empty string. Spaces before and after a key will be discarded. It cannot contain the following characters: ASCII (0-31), equal signs (=), asterisks (*), left angle brackets (<), right angle brackets (>), backslashes (), commas (,), vertical bars (\|), and slashes (/) It can contain only Chinese characters, letters, digits, hyphens (-), and underscores (_).
value	String	Value It is mandatory when a tag is added and optional when a tag is deleted. It can contain a maximum of 43 characters. It can be an empty string. Spaces before and after a value will be discarded. It cannot contain the following characters: ASCII (0-31), equal signs (=), asterisks (*), left angle brackets (<), right angle brackets (>), backslashes (), commas (,), vertical bars (\|), and slashes (/) It can contain only Chinese characters, letters, digits, hyphens (-), underscores (_), and periods (.).

**Table 4** SysTag
Parameter	Type	Description
key	String	Key Key of the system tag, which is obtained from the whitelist and cannot be defined randomly. Currently, only the _sys_enterprise_project_id field is supported, and the corresponding value indicates the enterprise project ID.
value	String	Value Currently, only the enterprise project ID is used. The default enterprise project ID is 0.

Status code: 400

**Table 5** Response body parameters
Parameter	Type	Description
error_code	String	For details, see Error Codes.
error_msg	String	Error message

Example Requests

GET  https://{endpoint}/v3/{project_id}/vault/{vault_id}/tags

Example Responses

Status code: 200

{
  "tags" : [ {
    "key" : "string",
    "value" : ""
  } ]
}

Status code: 400

Bad Request

{
  "error_code" : "BackupService.9900",
  "error_msg" : "Invalid vault_id provided."
}

Status Codes

Status Code	Description
200	OK
400	Bad Request

Error Codes

See Error Codes.

Parent topic: Tags

Previous topic: Deleting a Tag from an Associated Resource

Next topic: Querying Tags of a Vault Project

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.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel