Querying the Tag List
Function
This API is used to query the tag list.
Calling Method
For details, see Calling APIs.
URI
GET /v1/{resource_type}/tags
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
resource_type |
Yes |
Object |
Specifies the resource type. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
limit |
No |
Integer |
Specifies the number of results on each page. |
offset |
No |
Integer |
Specifies the number of bytes to skip before starting to read data. |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
Yes |
String |
Specifies the user token. The token can be obtained by calling the IAM API. The value of X-Subject-Token in the response header is the user token. |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
tags |
Array of Tag objects |
Specifies the tag list. |
total_count |
Integer |
Specifies the total number of resources. |
request_id |
String |
Specifies the request ID. |
Example Requests
Querying the Tag List
GET https://{ga_endpoint}/v1/{resource_type}/tags
Example Responses
Status code: 200
Operation successful.
{ "tags" : [ { "key" : "tagKey", "values" : [ "tagValue" ] } ], "total_count" : 1, "request_id" : "ac1bf54f-6a23-4074-af77-800648d25bc9" }
Status Codes
Status Code |
Description |
---|---|
200 |
Operation successful. |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.