# 列举资源概要 - CollectAllResourcesSummary #### 功能介绍 查询当前账号的资源概览。 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-rms/rms_03_0000.html)。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-rms/rms_05_0000.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | rms:resources:list | List | - | - | - | - | #### URI GET /v1/resource-manager/domains/{domain_id}/all-resources/summary 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | domain_id | 是 | String | **参数解释**： 账号ID。 **约束限制**： 不涉及 **取值范围**： 只能由英文字母、数字及"_"、"-"组成，且长度为\[1\~36\]个字符。 **默认取值**： 不涉及 最大长度：**36** | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | name | 否 | String | **参数解释**： 资源名称。 **约束限制**： 不涉及 **取值范围**： 长度为\[1\~256\]个字符 **默认取值**： 不涉及 最大长度：**256** | | type | 否 | Array of strings | **参数解释**： 资源类型列表，资源类型的格式为provider.type。 **约束限制**： 数组长度1-100 数组长度：**1 - 100** | | region_id | 否 | Array of strings | **参数解释**： 区域ID列表。 **约束限制**： 数组长度1-10 数组长度：**1 - 10** | | ep_id | 否 | Array of strings | **参数解释**： 企业项目ID列表。 **约束限制**： 数组长度1-10 数组长度：**1 - 10** | | project_id | 否 | Array of strings | **参数解释**： 项目ID。 **约束限制**： 数组长度1-10 数组长度：**1 - 10** | | tags | 否 | Array of strings | **参数解释**： 标签列表。 **约束限制**： 标签值的格式为key或key=value，数组长度1-5 数组长度：**1 - 5** | #### 请求参数 表3请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Security-Token | 否 | String | **参数解释**： 如果正在使用临时安全凭据，则此header是必需的，该值是临时安全凭据的安全令牌（会话令牌）。 **约束限制**： 不涉及 **取值范围**： 不涉及 **默认取值**： 不涉及 | #### 响应参数 **状态码：200** 表4响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | \[数组元素\] | Array of [ResourceSummaryResponseItem] objects | **参数解释**： 资源概要信息列表。 | 表5ResourceSummaryResponseItem | 参数 | 参数类型 | 描述 | |:---|:---|:---| | provider | String | **参数解释**： 云服务名称。 **取值范围**： 不涉及 | | types | Array of [types] objects | **参数解释**： 资源类型列表。 | 表6types | 参数 | 参数类型 | 描述 | |:---|:---|:---| | type | String | **参数解释**： 资源类型名称。 **取值范围**： 不涉及 | | regions | Array of [regions] objects | **参数解释**： 区域列表。 | 表7regions | 参数 | 参数类型 | 描述 | |:---|:---|:---| | region_id | String | **参数解释**： 区域ID。 **取值范围**： 不涉及 | | count | Long | **参数解释**： 该资源类型在当前区域的数量。 **取值范围**： 不涉及 | **状态码：400** 表8响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释**： 错误码。 **取值范围**： 不涉及 | | error_msg | String | **参数解释**： 错误消息内容。 **取值范围**： 不涉及 | **状态码：403** 表9响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释**： 错误码。 **取值范围**： 不涉及 | | error_msg | String | **参数解释**： 错误消息内容。 **取值范围**： 不涉及 | **状态码：500** 表10响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释**： 错误码。 **取值范围**： 不涉及 | | error_msg | String | **参数解释**： 错误消息内容。 **取值范围**： 不涉及 | #### 请求示例 ``` GET https://{endpoint}/v1/resource-manager/domains/059b5c937100d3e40ff0c00a7675a0a0/all-resources/summary ``` #### 响应示例 **状态码：200** 操作成功。 ``` [ { "provider" : "obs", "types" : [ { "type" : "buckets", "regions" : [ { "region_id" : "regionid1", "count" : 5 } ] } ] }, { "provider" : "ecs", "types" : [ { "type" : "cloudservers", "regions" : [ { "region_id" : "regionid2", "count" : 1 } ] } ] } ] ``` #### SDK代码示例 SDK代码示例如下。 #### Java ``` 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.config.v1.region.ConfigRegion; import com.huaweicloud.sdk.config.v1.*; import com.huaweicloud.sdk.config.v1.model.*; public class CollectAllResourcesSummarySolution { 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); ConfigClient client = ConfigClient.newBuilder() .withCredential(auth) .withRegion(ConfigRegion.valueOf("")) .build(); CollectAllResourcesSummaryRequest request = new CollectAllResourcesSummaryRequest(); try { CollectAllResourcesSummaryResponse response = client.collectAllResourcesSummary(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()); } } } ``` #### Python ``` # coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import GlobalCredentials from huaweicloudsdkconfig.v1.region.config_region import ConfigRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkconfig.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 = ConfigClient.new_builder() \ .with_credentials(credentials) \ .with_region(ConfigRegion.value_of("")) \ .build() try: request = CollectAllResourcesSummaryRequest() response = client.collect_all_resources_summary(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) ``` #### Go ``` package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/global" config "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/config/v1" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/config/v1/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/config/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, err := global.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). SafeBuild() if err != nil { fmt.Println(err) return } hcClient, err := config.ConfigClientBuilder(). WithRegion(region.ValueOf("")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := config.NewConfigClient(hcClient) request := &model.CollectAllResourcesSummaryRequest{} response, err := client.CollectAllResourcesSummary(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } ``` #### 更多 更多编程语言的SDK代码示例，请参见[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/Config/sdk?api=CollectAllResourcesSummary)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 操作成功。 | | 400 | 输入参数不合法。 | | 403 | 用户认证失败。 | | 500 | 服务器内部错误。 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-rms/ErrorCode.html)。