Querying Resource Tags
Function
This API is used to query tags of a specified instance. Before calling this API:
- Learn how to authorize and authenticate it.
- Obtain the required region and endpoint.
URI
GET /v3/{project_id}/instances/{instance_id}/tags
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Definition: Project ID of a tenant in a region. To obtain this value, see Obtaining a Project ID. Constraints: N/A Range: The value contains 32 characters. Only letters and digits are allowed. Default value: N/A |
instance_id |
Yes |
String |
Definition: Instance ID, which uniquely identifies an instance. Constraints: N/A Range: The value can contain 36 characters with a suffix of in07. Only letters and digits are allowed. Default value: N/A |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
offset |
No |
Integer |
Definition: Index offset. The query starts from the next piece of data indexed by this parameter. Constraints: The value cannot be a negative number. Range: ≥0 Default value: 0 |
limit |
No |
Integer |
Definition: Number of records to be queried. Constraints: The value cannot be a negative number. Range: 1–100 Default value: 100 |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
Yes |
String |
Definition: User token. To obtain this value, call the IAM API for obtaining a user token. The value of X-Subject-Token in the response header is the token value. Constraints: N/A Range: N/A Default value: N/A |
X-Language |
No |
String |
Definition: Request language type. Constraints: N/A Range: Default value: en-us |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
total_count |
Integer |
Definition: Total number of records. Range: N/A |
tags |
Array of ResourceTagItem objects |
Definition: Tag list. |
Parameter |
Type |
Description |
---|---|---|
key |
String |
Definition: Tag key. Range: It contains a maximum of 36 Unicode characters and cannot be null, an empty string, or a space. It is case-sensitive and can contain digits, letters, underscores (_), and hyphens (-). |
value |
String |
Definition: Tag value. Range: It contains a maximum of 43 Unicode characters. It can be an empty string but cannot be a space. It is case-sensitive and can contain digits, letters, underscores (_), periods (.), and hyphens (-). |
Status code: 400
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error message. |
Status code: 500
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error message. |
Example Request
Querying resource tags
GET https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/61a4ea66210545909d74a05c27a7179ein07/tags?offset=0&limit=2
Example Response
Status code: 200
Success.
{ "total_count" : 2, "tags" : [ { "key" : "key1", "value" : "value1" }, { "key" : "key2", "value" : "value2" } ] }
Status Code
For details, see Status Codes.
Error Code
For details, see Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.