全部文档
当前文档
最近更新时间：2022-12-22 17:00:26
域名：monitor.api.ksyun.com
VPC内调用域名：monitor.internal.api.ksyun.com
接口名: ListMetrics
Version=2019-08-12
本接口适用于金山云容器引擎的监控指标。
以下请求参数列表仅列出了接口请求参数，正式调用时需要加上公共请求参数，见公共请求参数页面。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Namespace | 是 | String | 表示一类云产品，这里指定KCE。 |
| Dimensions.n.Name | 是 | String | 维度的名称，与 dimensions.n.value 配合使用 |
| Dimensions.n.Value | 是 | String | 对应的维度的值，与 dimensions.n.name 配合使用 |
| MetricName | 否 | String | 监控项名称，传入该参数将返回对应监控项的详细信息。 |
| PageIndex | 是 | Interger | 返回列表的分页索引 |
| PageSize | 否 | Interger | 返回列表显示的对象数量 |
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Metrics | Array | 监控指标的集合 |
| RequestId | String | 请求ID |
Metrics的内容：
| 参数名称 | 类型 | 描述 |
|---|---|---|
| InstanceId | String | 监控实例的ID |
| Interval | String | 监控周期 |
| MetricName | String | 指标名称 |
| Namespace | String | 云产品类型 |
| Type | String | 数值类型，Integer/Float |
| Unit | String | 指标单位 |
Dimensions.n.Name 和 Dimensions.n.Value 用来指定一个监控对象。有的对象需要多个维度才确定。
查询集群维度监控项，入参如下：
| 参数名称 | 描述 |
|---|---|
| Dimensions.0.Name | ClusterId |
| Dimensions.0.Value | 集群id |
MetricsName：
| 监控项 | 指标名称 | 单位 | 前端展示数据聚合方式 |
|---|---|---|---|
| 集群CPU利用率 | cluster.cpu.usage | % | Avg |
| 集群内存利用率 | cluster.memory.usage | % | Avg |
查询实例维度监控项，入参如下：
| 参数名称 | 描述 |
|---|---|
| Dimensions.0.Name | ClusterId |
| Dimensions.0.Value | 集群id |
| Dimensions.1.Name | NamespaceName |
| Dimensions.1.Value | pod实例所在Namespace的名称 |
| Dimensions.2.Name | WorkloadType |
| Dimensions.2.Value | Workload类型 |
| Dimensions.3.Name | WorkloadName |
| Dimensions.3.Value | Workload名称 |
| Dimensions.4.Name | PodName |
| Dimensions.4.Value | Pod实例的名称 |
MetricsName：
| 监控项 | 指标名称 | 单位 | 前端展示数据聚合方式 |
|---|---|---|---|
| 实例网络入流量 | pod.network.rx | MB | Sum |
| 实例网络出流量 | pod.network.tx | MB | Sum |
查询容器维度监控项，入参如下：
| 参数 | 描述 |
|---|---|
| Dimensions.0.Name | ClusterId |
| Dimensions.0.Value | 集群id |
| Dimensions.1.Name | Namespace |
| Dimensions.1.Value | 实例所在Namespace的名称 |
| Dimensions.2.Name | WorkloadType |
| Dimensions.2.Value | Workload类型 |
| Dimensions.3.Name | WorkloadName |
| Dimensions.3.Value | Workload名称 |
| Dimensions.4.Name | PodName |
| Dimensions.4.Value | 实例的名称 |
| Dimensions.5.Name | ContainerName |
| Dimensions.5.Value | 容器的名称 |
MetricsName：
| 监控项 | 指标名称 | 单位 | 前端展示数据聚合方式 |
|---|---|---|---|
| 容器CPU使用情况 | container.cpu.usage | 核 | max |
| 容器CPU使用率(占Request) | container.cpu.usage_for_request | % | max |
| 容器CPU使用率(占Limit) | container.cpu.usage_for_limit | % | max |
| 容器内存使用情况 | container.memory.usage | MiB | max |
| 容器内存使用率(占Request) | container.memory.usage_for_request | % | max |
| 容器内存使用率(占Limit) | container.memory.usage_for_limit | % | max |
输入（以集群维度的查询为例）
https://monitor.${region}.api.ksyun.com/?
Action=ListMetrics
&Version=2019-08-12
&Namespace=KCE
&Dimensions.0.Name=ClusterId
&Dimensions.0.Value=clusterId
&PageIndex=1
&公共参数
${region}可替换相应区域，详见region说明
输出（以集群维度的查询为例）
<ListMetricsResponse xmlns="https://ksyun.kingeyes.com/">
<ListMetricsResult>
<Metrics>
<member>
<InstanceId>InstanceId</InstanceId>
<Interval>60</Interval>
<MetricName>cluster.cpu.usage</MetricName>
<Namespace>KCE</Namespace>
<Type>long</Type>
<Unit>%</Unit>
</member>
<member>
<InstanceId>InstanceId</InstanceId>
<Interval>60</Interval>
<MetricName>cluster.memory.usage</MetricName>
<Namespace>KCE</Namespace>
<Type>long</Type>
<Unit>%</Unit>
</member>
</Metrics>
</ListMetricsResult>
<ResponseMetadata>
<RequestId>d7ba704b-a243-411e-a8d8-be2b8eb6eb76</RequestId>
</ResponseMetadata>
</ListMetricsResponse>
纯净模式