文档首页> 云连接 CC> API参考> 历史API> 标签管理> 查询资源实例

更新时间：2024-03-29 GMT+08:00

在线调试

CLI示例

查看PDF

查询资源实例

功能介绍

查询资源实例

调用方法

请参见如何调用API。

URI

POST /v3/{domain_id}/ccaas/{resource_type}/resource-instances/action

表1 路径参数
参数	是否必选	参数类型	描述
domain_id	是	String	账号ID。最小长度：10 最大长度：32
resource_type	是	String	资源类型: cloud-connection: 云连接 bandwidth-package: 带宽包

请求参数

表2 请求Header参数
参数	是否必选	参数类型	描述
X-Auth-Token	否	String	用户Token 最小长度：0 最大长度：102400

表3 请求Body参数
参数	是否必选	参数类型	描述
action	否	String	动作。\|- filter：过滤。 count：查询总条数。
limit	否	Integer	查询结果数量限制最小值：1 最大值：1000.0
offset	否	Integer	查询结果偏移最小值：0 最大值：999
tags	否	Array of AggTag objects	是否包含以下tag（多个key取"与"关系，多个value取"或"关系）数组长度：0 - 50
matches	否	Array of Tag objects	是否匹配以下tag，key必须为"resource_name"，value如果有值则模糊匹配，如果为空字符串则精确匹配数组长度：0 - 50

表4 AggTag
参数	是否必选	参数类型	描述
key	否	String	键最小长度：1 最大长度：128
values	否	Array of strings	相同键的值列表最小长度：0 最大长度：255 数组长度：1 - 10

表5 Tag
参数	是否必选	参数类型	描述
key	否	String	键最小长度：1 最大长度：128
value	否	String	值最小长度：0 最大长度：255

响应参数

状态码： 200

表6 响应Body参数
参数	参数类型	描述
resources	Array of FilterTagResource objects	资源实例实例列表。数组长度：0 - 2000
request_id	String	请求ID。最小长度：0 最大长度：36
total_count	Integer	符合过滤条件的资源总数量。最小值：0 最大值：2000.0

表7 FilterTagResource
参数	参数类型	描述
resource_id	String	资源ID 最小长度：0 最大长度：36
resource_name	String	资源名称最小长度：0 最大长度：64
resource_detail	String	资源详情最小长度：0 最大长度：255
tags	Array of Tag objects	资源下包含的标签数组长度：0 - 20

表8 Tag
参数	参数类型	描述
key	String	键最小长度：1 最大长度：128
value	String	值最小长度：0 最大长度：255

请求示例

根据指定筛选条件查询资源例详情

POST https://{cc_endpoint}/v3/{domain_id}/ccaas/{resource_type}/resource-instances/action

{
  "offset" : "0",
  "limit" : "100",
  "action" : "filter",
  "matches" : [ {
    "key" : "resource_name",
    "value" : "resource1"
  } ],
  "tags" : [ {
    "key" : "key1",
    "values" : [ "value1", "value2" ]
  } ]
}

根据指定筛选条件查询资源实例数量

POST https://{cc_endpoint}/v3/{domain_id}/ccaas/cloud-connection/resource-instances/action

{
  "action" : "count",
  "tags" : [ {
    "key" : "key1",
    "values" : [ "value1", "value2" ]
  }, {
    "key" : "key2",
    "values" : [ "value1", "value2" ]
  } ],
  "matches" : [ {
    "key" : "resource_name",
    "value" : "resource1"
  } ]
}

响应示例

状态码： 200

查询资源实例成功

{
  "resources" : [ {
    "resource_id" : "cdfs_cefs_wesas_12_dsad",
    "resource_name" : "resouece1",
    "tags" : [ {
      "key" : "key1",
      "value" : "value1"
    }, {
      "key" : "key2",
      "value" : "value1"
    } ]
  } ],
  "request_id" : "XXX",
  "total_count" : 1000
}

SDK代码示例

SDK代码示例如下。

根据指定筛选条件查询资源例详情

        
         
           
           
             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.cc.v2.region.CcRegion;
import com.huaweicloud.sdk.cc.v2.*;
import com.huaweicloud.sdk.cc.v2.model.*;

import java.util.List;
import java.util.ArrayList;

public class ListResourceByFilterTagSolution {

    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);

        CcClient client = CcClient.newBuilder()
                .withCredential(auth)
                .withRegion(CcRegion.valueOf("<YOUR REGION>"))
                .build();
        ListResourceByFilterTagRequest request = new ListResourceByFilterTagRequest();
        ListResourceByFilterTagRequestBody body = new ListResourceByFilterTagRequestBody();
        List<Tag> listbodyMatches = new ArrayList<>();
        listbodyMatches.add(
            new Tag()
                .withKey("resource_name")
                .withValue("resource1")
        );
        List<String> listTagsValues = new ArrayList<>();
        listTagsValues.add("value1");
        listTagsValues.add("value2");
        List<AggTag> listbodyTags = new ArrayList<>();
        listbodyTags.add(
            new AggTag()
                .withKey("key1")
                .withValues(listTagsValues)
        );
        body.withMatches(listbodyMatches);
        body.withTags(listbodyTags);
        body.withOffset(0);
        body.withLimit(100);
        body.withAction(ListResourceByFilterTagRequestBody.ActionEnum.fromValue("filter"));
        request.withBody(body);
        try {
            ListResourceByFilterTagResponse response = client.listResourceByFilterTag(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());
        }
    }
}

            

          

        
       

根据指定筛选条件查询资源实例数量

        
         
           
           
             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.cc.v2.region.CcRegion;
import com.huaweicloud.sdk.cc.v2.*;
import com.huaweicloud.sdk.cc.v2.model.*;

import java.util.List;
import java.util.ArrayList;

public class ListResourceByFilterTagSolution {

    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);

        CcClient client = CcClient.newBuilder()
                .withCredential(auth)
                .withRegion(CcRegion.valueOf("<YOUR REGION>"))
                .build();
        ListResourceByFilterTagRequest request = new ListResourceByFilterTagRequest();
        ListResourceByFilterTagRequestBody body = new ListResourceByFilterTagRequestBody();
        List<Tag> listbodyMatches = new ArrayList<>();
        listbodyMatches.add(
            new Tag()
                .withKey("resource_name")
                .withValue("resource1")
        );
        List<String> listTagsValues = new ArrayList<>();
        listTagsValues.add("value1");
        listTagsValues.add("value2");
        List<String> listTagsValues1 = new ArrayList<>();
        listTagsValues1.add("value1");
        listTagsValues1.add("value2");
        List<AggTag> listbodyTags = new ArrayList<>();
        listbodyTags.add(
            new AggTag()
                .withKey("key1")
                .withValues(listTagsValues1)
        );
        listbodyTags.add(
            new AggTag()
                .withKey("key2")
                .withValues(listTagsValues)
        );
        body.withMatches(listbodyMatches);
        body.withTags(listbodyTags);
        body.withAction(ListResourceByFilterTagRequestBody.ActionEnum.fromValue("count"));
        request.withBody(body);
        try {
            ListResourceByFilterTagResponse response = client.listResourceByFilterTag(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());
        }
    }
}

            

          

        
       

根据指定筛选条件查询资源例详情

        
         
           
           
             # coding: utf-8

from huaweicloudsdkcore.auth.credentials import GlobalCredentials
from huaweicloudsdkcc.v2.region.cc_region import CcRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkcc.v2 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 = __import__('os').getenv("CLOUD_SDK_AK")
    sk = __import__('os').getenv("CLOUD_SDK_SK")

    credentials = GlobalCredentials(ak, sk) \

    client = CcClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(CcRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = ListResourceByFilterTagRequest()
        listMatchesbody = [
            Tag(
                key="resource_name",
                value="resource1"
            )
        ]
        listValuesTags = [
            "value1",
            "value2"
        ]
        listTagsbody = [
            AggTag(
                key="key1",
                values=listValuesTags
            )
        ]
        request.body = ListResourceByFilterTagRequestBody(
            matches=listMatchesbody,
            tags=listTagsbody,
            offset=0,
            limit=100,
            action="filter"
        )
        response = client.list_resource_by_filter_tag(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

            

          

        
       

根据指定筛选条件查询资源实例数量

        
         
           
           
             # coding: utf-8

from huaweicloudsdkcore.auth.credentials import GlobalCredentials
from huaweicloudsdkcc.v2.region.cc_region import CcRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkcc.v2 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 = __import__('os').getenv("CLOUD_SDK_AK")
    sk = __import__('os').getenv("CLOUD_SDK_SK")

    credentials = GlobalCredentials(ak, sk) \

    client = CcClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(CcRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = ListResourceByFilterTagRequest()
        listMatchesbody = [
            Tag(
                key="resource_name",
                value="resource1"
            )
        ]
        listValuesTags = [
            "value1",
            "value2"
        ]
        listValuesTags1 = [
            "value1",
            "value2"
        ]
        listTagsbody = [
            AggTag(
                key="key1",
                values=listValuesTags1
            ),
            AggTag(
                key="key2",
                values=listValuesTags
            )
        ]
        request.body = ListResourceByFilterTagRequestBody(
            matches=listMatchesbody,
            tags=listTagsbody,
            action="count"
        )
        response = client.list_resource_by_filter_tag(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

            

          

        
       

根据指定筛选条件查询资源例详情

        
         
           
           
             package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/global"
    cc "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cc/v2"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cc/v2/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cc/v2/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 := cc.NewCcClient(
        cc.CcClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.ListResourceByFilterTagRequest{}
	keyMatches:= "resource_name"
	valueMatches:= "resource1"
	var listMatchesbody = []model.Tag{
        {
            Key: &keyMatches,
            Value: &valueMatches,
        },
    }
	var listValuesTags = []string{
        "value1",
	    "value2",
    }
	keyTags:= "key1"
	var listTagsbody = []model.AggTag{
        {
            Key: &keyTags,
            Values: &listValuesTags,
        },
    }
	offsetListResourceByFilterTagRequestBody:= int32(0)
	limitListResourceByFilterTagRequestBody:= int32(100)
	actionListResourceByFilterTagRequestBody:= model.GetListResourceByFilterTagRequestBodyActionEnum().FILTER
	request.Body = &model.ListResourceByFilterTagRequestBody{
		Matches: &listMatchesbody,
		Tags: &listTagsbody,
		Offset: &offsetListResourceByFilterTagRequestBody,
		Limit: &limitListResourceByFilterTagRequestBody,
		Action: &actionListResourceByFilterTagRequestBody,
	}
	response, err := client.ListResourceByFilterTag(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

            

          

        
       

根据指定筛选条件查询资源实例数量

        
         
           
           
             package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/global"
    cc "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cc/v2"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cc/v2/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cc/v2/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 := cc.NewCcClient(
        cc.CcClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.ListResourceByFilterTagRequest{}
	keyMatches:= "resource_name"
	valueMatches:= "resource1"
	var listMatchesbody = []model.Tag{
        {
            Key: &keyMatches,
            Value: &valueMatches,
        },
    }
	var listValuesTags = []string{
        "value1",
	    "value2",
    }
	var listValuesTags1 = []string{
        "value1",
	    "value2",
    }
	keyTags:= "key1"
	keyTags1:= "key2"
	var listTagsbody = []model.AggTag{
        {
            Key: &keyTags,
            Values: &listValuesTags1,
        },
        {
            Key: &keyTags1,
            Values: &listValuesTags,
        },
    }
	actionListResourceByFilterTagRequestBody:= model.GetListResourceByFilterTagRequestBodyActionEnum().COUNT
	request.Body = &model.ListResourceByFilterTagRequestBody{
		Matches: &listMatchesbody,
		Tags: &listTagsbody,
		Action: &actionListResourceByFilterTagRequestBody,
	}
	response, err := client.ListResourceByFilterTag(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

            

          

        
       

更多编程语言的SDK代码示例，请参见API Explorer的代码示例页签，可生成自动对应的SDK代码示例。

状态码

状态码	描述
200	查询资源实例成功

错误码

请参见错误码。

父主题：标签管理

上一篇：批量创建和删除资源标签

下一篇：查询资源标签

意见反馈

文档内容是否对您有帮助？

有帮助没帮助

提供反馈

提交成功！非常感谢您的反馈，我们会继续努力做到更好！您可在我的云声建议查看反馈及问题处理状态。

系统繁忙，请稍后重试

在使用文档中是否遇到以下问题

内容与产品页面不一致

内容不易理解

缺失示例代码

步骤不可操作

搜不到想要的内容

缺少最佳实践

意见反馈（选填）

0/500

请至少选择一项反馈信息并填写问题反馈

字符长度不能超过500

直接提交取消

如您有其它疑问，您也可以通过华为云社区问答频道来与我们联系探讨

智能客服提问云社区提问

查询资源实例

功能介绍

调用方法

URI

请求参数

响应参数

请求示例

响应示例

SDK代码示例

状态码

错误码

相关文档

相关产品

意见反馈

文档内容是否对您有帮助？

7*24

备案

专业服务

退订

建议反馈

售前咨询热线