Querying Resources by Tag
Function
This API is used to query resources by tag.
Calling Method
For details, see Calling APIs.
URI
POST /v1.0/resource-instances/filter
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
Yes |
String |
Specifies the user token. TMS is a global service. When calling the Identity and Access Management (IAM) API to obtain a user token, set the scope field to domain. The value of X-Subject-Token in the response header is the user token. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
No |
String |
Specifies the project ID. This parameter is mandatory when resource_type is a region-specific service. |
resource_types |
Yes |
Array of strings |
Specifies the resource type. This parameter is case-sensitive. Examples include: ecs, scaling_group, images, disk,vpcs, security-groups, shared_bandwidth, eip, and cdn. For more details, see "Querying Service Supported by TMS". |
tags |
Yes |
Array of Tag objects |
Specifies tags. |
offset |
No |
Integer |
Specifies the index position. The query starts from the next data record specified by offset. The value must be a number and cannot be a negative number. The default value is 0. |
limit |
No |
Integer |
Specifies the number of records to be queried. If the value is not specified, its default value is 200. The maximum value of limit is 200 and the minimum value is 1. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
key |
Yes |
String |
Specifies the tag key. The value can contain up to 36 characters including letters, digits, hyphens (-), and underscores (_). |
values |
Yes |
Array of strings |
Specifies tag values.Each value can contain up to 43 characters including letters, digits, periods (.), hyphens (-), and underscores (_). It can be an empty string. |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
resources |
Array of Resources objects |
Specifies the resource list. |
errors |
Array of Errors objects |
Specifies errors. |
total_count |
Integer |
Specifies the total number of resources queried by tag. |
Parameter |
Type |
Description |
---|---|---|
project_id |
String |
ProjectID |
project_name |
String |
Specifies the Project name. |
resource_detail |
Object |
Specifies the resource details. |
resource_id |
String |
Specifies the resource ID. |
resource_name |
String |
Specifies the resource name. |
resource_type |
String |
Specifies the resource type. |
tags |
Array of FilterTagResponse objects |
Resource Tags |
Parameter |
Type |
Description |
---|---|---|
key |
String |
Specifies the tag key. The value can contain up to 36 characters including letters, digits, hyphens (-), and underscores (_). |
value |
String |
Specifies the tag value. The value can contain up to 43 characters including letters, digits, periods (.), hyphens (-), and underscores (_). It can be an empty string. |
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Specifies the error code. |
error_msg |
String |
Specifies the error message. |
project_id |
String |
ProjectID |
resource_type |
String |
Specifies the resource type. |
Status code: 400
Parameter |
Type |
Description |
---|---|---|
error |
RespErrorMessage object |
Response error information. |
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Request error code |
error_msg |
String |
Error message |
Status code: 401
Parameter |
Type |
Description |
---|---|---|
error |
RespErrorMessage object |
Response error information. |
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Request error code |
error_msg |
String |
Error message |
Status code: 402
Parameter |
Type |
Description |
---|---|---|
error |
RespErrorMessage object |
Response error information. |
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Request error code |
error_msg |
String |
Error message |
Status code: 403
Parameter |
Type |
Description |
---|---|---|
error |
RespErrorMessage object |
Response error information. |
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Request error code |
error_msg |
String |
Error message |
Status code: 404
Parameter |
Type |
Description |
---|---|---|
error |
RespErrorMessage object |
Response error information. |
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Request error code |
error_msg |
String |
Error message |
Status code: 405
Parameter |
Type |
Description |
---|---|---|
error |
RespErrorMessage object |
Response error information. |
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Request error code |
error_msg |
String |
Error message |
Status code: 406
Parameter |
Type |
Description |
---|---|---|
error |
RespErrorMessage object |
Response error information. |
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Request error code |
error_msg |
String |
Error message |
Status code: 407
Parameter |
Type |
Description |
---|---|---|
error |
RespErrorMessage object |
Response error information. |
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Request error code |
error_msg |
String |
Error message |
Status code: 408
Parameter |
Type |
Description |
---|---|---|
error |
RespErrorMessage object |
Response error information. |
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Request error code |
error_msg |
String |
Error message |
Status code: 409
Parameter |
Type |
Description |
---|---|---|
error |
RespErrorMessage object |
Response error information. |
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Request error code |
error_msg |
String |
Error message |
Status code: 500
Parameter |
Type |
Description |
---|---|---|
error |
RespErrorMessage object |
Response error information. |
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Request error code |
error_msg |
String |
Error message |
Status code: 501
Parameter |
Type |
Description |
---|---|---|
error |
RespErrorMessage object |
Response error information. |
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Request error code |
error_msg |
String |
Error message |
Status code: 502
Parameter |
Type |
Description |
---|---|---|
error |
RespErrorMessage object |
Response error information. |
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Request error code |
error_msg |
String |
Error message |
Status code: 503
Parameter |
Type |
Description |
---|---|---|
error |
RespErrorMessage object |
Response error information. |
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Request error code |
error_msg |
String |
Error message |
Status code: 504
Parameter |
Type |
Description |
---|---|---|
error |
RespErrorMessage object |
Response error information. |
Example Requests
Querying resources by tag
POST https://v1.0/resource-instances/filter { "project_id" : "e1eb7c40cbea4c8389cde527594a306d", "resource_types" : [ "disk", "ecs" ], "tags" : [ { "key" : "env", "values" : [ "dev", "prod" ] }, { "key" : "test", "values" : [ "test" ] } ], "offset" : 0, "limit" : 10 }
Example Responses
Status code: 200
OK
{ "resources" : [ { "project_id" : "e1eb7c40cbea4c8389cde527594a306d", "project_name" : "XXXX", "resource_type" : "disk", "resource_id" : "b621f5ae-b5c1-49d7-a660-752c445434b4", "resource_name" : "lhj1-volume-0001", "tags" : [ { "key" : "ENV", "value" : "dev" } ] }, { "project_id" : "e1eb7c40cbea4c8389cde527594a306d", "project_name" : "XXXX", "resource_type" : "disk", "resource_id" : "87c9edc9-f66c-48b8-a22f-372b2e22d579", "resource_name" : "lhj2-volume-0002", "tags" : [ { "key" : "prod", "value" : "disk" } ] } ], "errors" : [ { "project_id" : "e1eb7c40cbea4c8389cde527594a306d", "resource_type" : "disk", "error_code" : "TMS.0002", "error_msg" : "Bad request" } ], "total_count" : 2 }
Status Codes
Status Code |
Description |
---|---|
200 |
OK |
400 |
Bad Request |
401 |
Unauthorized |
402 |
Payment Required |
403 |
Forbidden |
404 |
Not Found |
405 |
Method Not Allowed |
406 |
Not Acceptable |
407 |
Proxy Authentication Required |
408 |
Request Timeout |
409 |
Conflict |
500 |
Internal Server Error |
501 |
Not Implemented |
502 |
Bad Gateway |
503 |
Service Unavailable |
504 |
Gateway Timeout |
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.