# 查询集群使用的指标列表 - ListMetrics #### 功能介绍 查询集群使用的指标列表。 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-dws/dws_02_0062.html)。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-dws/dws_02_0056.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | dws:cluster:getQueryPropertyForDMS | Read | cluster \* | - g:ResourceTag/\ - g:EnterpriseProjectId | dws:dmsDdlExamine:getOrCreate | - | #### URI GET /v1/{project_id}/clusters/{cluster_id}/dms/metrics 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释**： 项目ID。获取方法请参见[获取项目ID](https://support.huaweicloud.com/api-dws/dws_02_0011.html)。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | cluster_id | 是 | String | **参数解释**： 集群ID。获取方法请参见[获取集群ID](https://support.huaweicloud.com/api-dws/dws_02_00068.html)。 **约束限制**： 必须是有效的dws集群ID。 **取值范围**： 36位UUID。 **默认取值**： 不涉及。 | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | offset | 是 | Integer | **参数解释**： 分页偏移量，从0开始，页数减1。 **约束限制**： 不涉及。 **取值范围**： 大于等于0。 **默认取值**： 0 | | limit | 是 | Integer | **参数解释**： 分页单页大小。 **约束限制**： 不涉及。 **取值范围**： 大于0，最大1000。 **默认取值**： 不限制。 | | order_by | 否 | String | **参数解释**： 排序字段，固定取值。 **约束限制**： 不涉及。 **取值范围**： create_time：按创建时间排序。 **默认取值**： 不涉及。 | | sort_by | 否 | String | **参数解释**： 正序还是倒序，固定取值。 **约束限制**： 不涉及。 **取值范围**： asc：正序。 desc：倒序。 **默认取值**： 不涉及。 | #### 请求参数 无 #### 响应参数 **状态码：200** 表3响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | code | Integer | **参数解释**： 响应码。 **取值范围**： 不涉及。 | | msg | String | **参数解释**： 响应信息。 **取值范围**： 不涉及。 | | data | Array of [ClusterMetric] objects | **参数解释**： 指标列表。 **取值范围**： 不涉及。 | | count | Long | **参数解释**： 总列表大小。 **取值范围**： 不涉及。 | 表4ClusterMetric | 参数 | 参数类型 | 描述 | |:---|:---|:---| | scope | String | **参数解释**： 作用域。 **取值范围**： 不涉及。 | | fields | Array of [SimpleFieldDto] objects | **参数解释**： 指标表相关字段信息。 **取值范围**： 不涉及。 | | metric_name | String | **参数解释**： 指标名称。 **取值范围**： 不涉及。 | | collect_rate | Integer | **参数解释**： 采集速率。 **取值范围**： 不涉及。 | | collect_range | Array of strings | **参数解释**： 采集时间范围。 **取值范围**： 不涉及。 | | create_time | String | **参数解释**： 创建时间。 **取值范围**： 毫秒时间戳格式的字符串。 | 表5SimpleFieldDto | 参数 | 参数类型 | 描述 | |:---|:---|:---| | column_name | String | **参数解释**： 指标表对应字段名称。 **取值范围**： 不涉及。 | | column_type | String | **参数解释**： 指标表对应字段类型。 **取值范围**： - bigint：大范围的整数，别名为INT8。 - int：常用的整数，别名为INT4。 - varchar：变长字符串。 - text：变长字符串。 - numeric：任意精度型。 - double precision：双精度浮点数，不精准。 | #### 请求示例 查询集群使用的指标列表 ``` GET https://{Endpoint}/v1/{project_id}/clusters/{cluster_id}/dms/metrics?limit=1&offset=0&order_by=create_time&sort_by=desc ``` #### 响应示例 **状态码：200** ``` { "code" : 0, "msg" : "OK", "data" : [ { "scope" : "CN,ANY", "fields" : [ { "column_name" : "db_name", "column_type" : "text" }, { "column_name" : "schema_name", "column_type" : "text" }, { "column_name" : "table_name", "column_type" : "text" }, { "column_name" : "table_owner", "column_type" : "text" }, { "column_name" : "table_size", "column_type" : "bigint" }, { "column_name" : "dirty_page_rate", "column_type" : "double precision" } ], "metric_name" : "TableDirtyPageRate", "collect_rate" : 7200, "collect_range" : [ ], "create_time" : "1720250000000" } ], "count" : 1 } ``` #### SDK代码示例 SDK代码示例如下。 - [Java] ``` package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.BasicCredentials; 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.dws.v2.region.DwsRegion; import com.huaweicloud.sdk.dws.v2.*; import com.huaweicloud.sdk.dws.v2.model.*; public class ListMetricsSolution { 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"); String projectId = "{project_id}"; ICredential auth = new BasicCredentials() .withProjectId(projectId) .withAk(ak) .withSk(sk); DwsClient client = DwsClient.newBuilder() .withCredential(auth) .withRegion(DwsRegion.valueOf("")) .build(); ListMetricsRequest request = new ListMetricsRequest(); request.withClusterId("{cluster_id}"); try { ListMetricsResponse response = client.listMetrics(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 BasicCredentials from huaweicloudsdkdws.v2.region.dws_region import DwsRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkdws.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 = os.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] projectId = "{project_id}" credentials = BasicCredentials(ak, sk, projectId) client = DwsClient.new_builder() \ .with_credentials(credentials) \ .with_region(DwsRegion.value_of("")) \ .build() try: request = ListMetricsRequest() request.cluster_id = "{cluster_id}" response = client.list_metrics(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/basic" dws "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dws/v2" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dws/v2/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dws/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") projectId := "{project_id}" auth, err := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). SafeBuild() if err != nil { fmt.Println(err) return } hcClient, err := dws.DwsClientBuilder(). WithRegion(region.ValueOf("")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := dws.NewDwsClient(hcClient) request := &model.ListMetricsRequest{} request.ClusterId = "{cluster_id}" response, err := client.ListMetrics(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } ``` - [更多] 更多编程语言的SDK代码示例，请参见[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/DWS/sdk?api=ListMetrics)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 查询成功。 | | 400 | 请求错误。 | | 401 | 鉴权失败 | | 403 | 没有操作权限 | | 500 | 内部服务错误 | | 503 | 服务不可用 |