根据标签过滤资源
功能介绍
根据标签过滤资源。
调用方法
请参见如何调用API。
URI
POST /v1.0/resource-instances/filter
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
用户Token。说明:由于TMS是全局服务,因此调用IAM服务获取用户Token接口时需要注意作用域即scope字段应该设置为domain。响应消息头中X-Subject-Token的值即为用户Token。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
否 |
String |
项目ID,resource_type为region级别服务时为必选项。 |
resource_types |
是 |
Array of strings |
资源类型, 此参数为可输入的值(区分大小写)。例如:ecs,scaling_group, images, disk,vpcs,security-groups, shared_bandwidth,eip, cdn等,具体请参见“附录-标签支持的资源类型”章节。 |
tags |
是 |
Array of Tag objects |
标签列表 |
without_any_tag |
否 |
Boolean |
是否仅查询未带标签的资源。该字段为true时查询不带标签的资源。 |
offset |
否 |
Integer |
索引位置, 从offset指定的下一条数据开始查询,必须为数字,不能为负数,默认为0。 |
limit |
否 |
Integer |
查询记录数,不传默认为200,limit最多为200, 最小值为1。 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
resources |
Array of Resources objects |
资源列表 |
errors |
Array of Errors objects |
查询异常时返回的错误信息 |
total_count |
Integer |
标签下的资源总数 |
参数 |
参数类型 |
描述 |
---|---|---|
project_id |
String |
ProjectID |
project_name |
String |
Project名称 |
resource_detail |
Object |
资源详情 |
resource_id |
String |
资源ID |
resource_name |
String |
资源名称 |
resource_type |
String |
资源类型 |
tags |
Array of FilterTagResponse objects |
资源标签 |
参数 |
参数类型 |
描述 |
---|---|---|
key |
String |
键。 最大长度36个字符。 字符集:A-Z,a-z , 0-9,‘-’,‘_’,UNICODE字符(\u4E00-\u9FFF)。 |
value |
String |
值。 最大长度43个字符,可以为空字符串。 字符集:A-Z,a-z ,0-9,‘.’,‘-’,‘_’,UNICODE字符(\u4E00-\u9FFF)。 |
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 |
error_msg |
String |
错误描述 |
project_id |
String |
ProjectID |
resource_type |
String |
资源类型 |
状态码: 400
参数 |
参数类型 |
描述 |
---|---|---|
error |
RespErrorMessage object |
响应错误信息 |
状态码: 401
参数 |
参数类型 |
描述 |
---|---|---|
error |
RespErrorMessage object |
响应错误信息 |
状态码: 402
参数 |
参数类型 |
描述 |
---|---|---|
error |
RespErrorMessage object |
响应错误信息 |
状态码: 403
参数 |
参数类型 |
描述 |
---|---|---|
error |
RespErrorMessage object |
响应错误信息 |
状态码: 404
参数 |
参数类型 |
描述 |
---|---|---|
error |
RespErrorMessage object |
响应错误信息 |
状态码: 405
参数 |
参数类型 |
描述 |
---|---|---|
error |
RespErrorMessage object |
响应错误信息 |
状态码: 406
参数 |
参数类型 |
描述 |
---|---|---|
error |
RespErrorMessage object |
响应错误信息 |
状态码: 407
参数 |
参数类型 |
描述 |
---|---|---|
error |
RespErrorMessage object |
响应错误信息 |
状态码: 408
参数 |
参数类型 |
描述 |
---|---|---|
error |
RespErrorMessage object |
响应错误信息 |
状态码: 409
参数 |
参数类型 |
描述 |
---|---|---|
error |
RespErrorMessage object |
响应错误信息 |
状态码: 500
参数 |
参数类型 |
描述 |
---|---|---|
error |
RespErrorMessage object |
响应错误信息 |
状态码: 501
参数 |
参数类型 |
描述 |
---|---|---|
error |
RespErrorMessage object |
响应错误信息 |
状态码: 502
参数 |
参数类型 |
描述 |
---|---|---|
error |
RespErrorMessage object |
响应错误信息 |
状态码: 503
参数 |
参数类型 |
描述 |
---|---|---|
error |
RespErrorMessage object |
响应错误信息 |
状态码: 504
参数 |
参数类型 |
描述 |
---|---|---|
error |
RespErrorMessage object |
响应错误信息 |
请求示例
根据标签过滤资源。
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 }
响应示例
状态码: 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 }
SDK代码示例
SDK代码示例如下。
根据标签过滤资源。
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 |
package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.GlobalCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.tms.v1.region.TmsRegion; import com.huaweicloud.sdk.tms.v1.*; import com.huaweicloud.sdk.tms.v1.model.*; import java.util.List; import java.util.ArrayList; public class ListResourceSolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); ICredential auth = new GlobalCredentials() .withAk(ak) .withSk(sk); TmsClient client = TmsClient.newBuilder() .withCredential(auth) .withRegion(TmsRegion.valueOf("<YOUR REGION>")) .build(); ListResourceRequest request = new ListResourceRequest(); ResqTagResource body = new ResqTagResource(); List<String> listTagsValues = new ArrayList<>(); listTagsValues.add("test"); List<String> listTagsValues1 = new ArrayList<>(); listTagsValues1.add("dev"); listTagsValues1.add("prod"); List<Tag> listbodyTags = new ArrayList<>(); listbodyTags.add( new Tag() .withKey("env") .withValues(listTagsValues1) ); listbodyTags.add( new Tag() .withKey("test") .withValues(listTagsValues) ); List<String> listbodyResourceTypes = new ArrayList<>(); listbodyResourceTypes.add("disk"); listbodyResourceTypes.add("ecs"); body.withLimit(10); body.withOffset(0); body.withTags(listbodyTags); body.withResourceTypes(listbodyResourceTypes); body.withProjectId("e1eb7c40cbea4c8389cde527594a306d"); request.withBody(body); try { ListResourceResponse response = client.listResource(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } } |
根据标签过滤资源。
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 |
# coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import GlobalCredentials from huaweicloudsdktms.v1.region.tms_region import TmsRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdktms.v1 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = os.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] credentials = GlobalCredentials(ak, sk) client = TmsClient.new_builder() \ .with_credentials(credentials) \ .with_region(TmsRegion.value_of("<YOUR REGION>")) \ .build() try: request = ListResourceRequest() listValuesTags = [ "test" ] listValuesTags1 = [ "dev", "prod" ] listTagsbody = [ Tag( key="env", values=listValuesTags1 ), Tag( key="test", values=listValuesTags ) ] listResourceTypesbody = [ "disk", "ecs" ] request.body = ResqTagResource( limit=10, offset=0, tags=listTagsbody, resource_types=listResourceTypesbody, project_id="e1eb7c40cbea4c8389cde527594a306d" ) response = client.list_resource(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
根据标签过滤资源。
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 |
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/global" tms "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/tms/v1" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/tms/v1/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/tms/v1/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") auth := global.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). Build() client := tms.NewTmsClient( tms.TmsClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.ListResourceRequest{} var listValuesTags = []string{ "test", } var listValuesTags1 = []string{ "dev", "prod", } var listTagsbody = []model.Tag{ { Key: "env", Values: listValuesTags1, }, { Key: "test", Values: listValuesTags, }, } var listResourceTypesbody = []string{ "disk", "ecs", } limitResqTagResource:= int32(10) offsetResqTagResource:= int32(0) projectIdResqTagResource:= "e1eb7c40cbea4c8389cde527594a306d" request.Body = &model.ResqTagResource{ Limit: &limitResqTagResource, Offset: &offsetResqTagResource, Tags: listTagsbody, ResourceTypes: listResourceTypesbody, ProjectId: &projectIdResqTagResource, } response, err := client.ListResource(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
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 |
错误码
请参见错误码。