Querying Tags of an Associated Resource¶

Function¶

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

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

None

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.

**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 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 letters, digits, hyphens (-), and underscores (_).

Status code: 400

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

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

Status code: 200

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

Status code: 400

Bad Request

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

Status Code	Description
200	OK
400	Bad Request

last updated: 2024-09-07 01:00