调用DescribeMetricList接口查看集群监控信息。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String DescribeMetricList

系统规定参数。取值:DescribeMetricList

MetricType String NODE

查询集群或节点,取值:

  • CLUSTER:集群。
  • NODE:节点
MetricName String cpu_total
  • InternetOut:公网流出流量,单位为Byte。
  • diskusage_utilization:磁盘使用率。
  • IntranetInRate:内网流入流量,单位为Byte。
  • InternetIn:公网流入流量,单位为Byte。
  • cpu_total:CPU使用率。
  • memory_usedutilization:内存使用率。
  • IntranetOutRate:内网流出流量,单位为Byte。
Period Long 15

观测间隔(单位秒),最小间隔为15秒。

Param String nodeid

观测值,当MetricTypeNODE时,值为nodeid

StartTime Long 1642476144000

起始时间戳,单位毫秒。

EndTime Long 1642476194000

结束时间戳,单位毫秒。

Env String ALIYUN

默认为:ALIYUN

DtsJobId String k2gm967v16f****

迁移或同步任务ID。

ClientToken String 0c593ea1-3bea-11e9-b96b-88e9fe63****

保证请求幂等性。从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken只支持ASCII字符,且不能超过64个字符。

AccountId String 12323344****

阿里云主账号ID。

返回数据

名称 类型 示例值 描述
MetricType String CLUSTER

查询集群或节点,取值:

  • CLUSTER:集群。
  • NODE:节点
Param String ecs-jhjnjjn

观测值。

  • MetricTypeNODE时,值为nodeid
  • MetricTypeCLUSTER时为独享集群ID,可通过ListDedicatedCluster接口获取。
MetricName String cpu_total
  • InternetOut:公网流出流量,单位为Byte。
  • diskusage_utilization:磁盘使用率。
  • IntranetInRate:内网流入流量,单位为Byte。
  • InternetIn:公网流入流量,单位为Byte。
  • cpu_total:CPU使用率。
  • memory_usedutilization:内存使用率。
  • IntranetOutRate:内网流出流量,单位为Byte。
Period Long 15

观测间隔(单位为秒),最小间隔为15秒。

DataPoints Array of DataPoint

监控统计信息。

Timestamp Long 1650872310000

记录时间戳,单位毫秒。

Statistics Float 15.25

统计值。

Success Boolean true

调用是否成功。

Code String 403

后端错误码,数字递增。

ErrCode String InternalError

调用出错时返回的错误码。

ErrMessage String The Value of Input Parameter %s is not valid.

错误信息。

DynamicMessage String Type

动态错误信息,用于替换返回参数ErrMessage错误信息中的%s。

HttpStatusCode Integer 403

异常对应的状态码。

RequestId String 621BB4F8-3016-4FAA-8D5A-5D3163CC****

请求ID。

示例

请求示例

http(s)://dts.aliyuncs.com/?Action=DescribeMetricList
&MetricType=NODE
&MetricName=cpu_total
&Period=15
&Param=nodeid
&StartTime=1642476144000
&EndTime=1642476194000
&Env=ALIYUN
&DtsJobId=k2gm967v16f****
&ClientToken=0c593ea1-3bea-11e9-b96b-88e9fe63****
&AccountId=12323344****
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeMetricListResponse>
    <code>200</code>
    <data>
        <MetricName>diskusage_utilization</MetricName>
        <RequestId>36F33F1C-CF13-149E-AB05-****</RequestId>
        <MetricType>CLUSTER</MetricType>
        <HttpStatusCode>200</HttpStatusCode>
        <Period>15</Period>
        <DataPoints>
            <Timestamp>1651112970000</Timestamp>
            <Statistics>10.5</Statistics>
        </DataPoints>
        <DataPoints>
            <Timestamp>1651112985000</Timestamp>
            <Statistics>10.5</Statistics>
        </DataPoints>
        <DataPoints>
            <Timestamp>1651113000000</Timestamp>
            <Statistics>10.5</Statistics>
        </DataPoints>
        <DataPoints>
            <Timestamp>1651113015000</Timestamp>
            <Statistics>10.5</Statistics>
        </DataPoints>
        <DataPoints>
            <Timestamp>1651113030000</Timestamp>
            <Statistics>10.5</Statistics>
        </DataPoints>
        <DataPoints>
            <Timestamp>1651113045000</Timestamp>
            <Statistics>10.5</Statistics>
        </DataPoints>
        <DataPoints>
            <Timestamp>1651113060000</Timestamp>
            <Statistics>10.5</Statistics>
        </DataPoints>
        <DataPoints>
            <Timestamp>1651113075000</Timestamp>
            <Statistics>10.5</Statistics>
        </DataPoints>
        <DataPoints>
            <Timestamp>1651113090000</Timestamp>
            <Statistics>10.5</Statistics>
        </DataPoints>
        <DataPoints>
            <Timestamp>1651113105000</Timestamp>
            <Statistics>10.5</Statistics>
        </DataPoints>
        <DataPoints>
            <Timestamp>1651113120000</Timestamp>
            <Statistics>10.5</Statistics>
        </DataPoints>
        <DataPoints>
            <Timestamp>1651113135000</Timestamp>
            <Statistics>10.5</Statistics>
        </DataPoints>
        <DataPoints>
            <Timestamp>1651113150000</Timestamp>
            <Statistics>10.5</Statistics>
        </DataPoints>
        <DataPoints>
            <Timestamp>1651113165000</Timestamp>
            <Statistics>10.5</Statistics>
        </DataPoints>
        <DataPoints>
            <Timestamp>1651113180000</Timestamp>
            <Statistics>10.5</Statistics>
        </DataPoints>
        <DataPoints>
            <Timestamp>1651113195000</Timestamp>
            <Statistics>10.5</Statistics>
        </DataPoints>
        <DataPoints>
            <Timestamp>1651113210000</Timestamp>
            <Statistics>10.5</Statistics>
        </DataPoints>
        <DataPoints>
            <Timestamp>1651113225000</Timestamp>
            <Statistics>10.5</Statistics>
        </DataPoints>
        <DataPoints>
            <Timestamp>1651113240000</Timestamp>
            <Statistics>10.5</Statistics>
        </DataPoints>
        <DataPoints>
            <Timestamp>1651113255000</Timestamp>
            <Statistics>10.5</Statistics>
        </DataPoints>
        <DataPoints>
            <Timestamp>1651113270000</Timestamp>
            <Statistics>10.5</Statistics>
        </DataPoints>
        <DataPoints>
            <Timestamp>1651113285000</Timestamp>
            <Statistics>10.5</Statistics>
        </DataPoints>
        <DataPoints>
            <Timestamp>1651113300000</Timestamp>
            <Statistics>10.5</Statistics>
        </DataPoints>
        <DataPoints>
            <Timestamp>1651113315000</Timestamp>
            <Statistics>10.5</Statistics>
        </DataPoints>
        <DataPoints>
            <Timestamp>1651113330000</Timestamp>
            <Statistics>10.5</Statistics>
        </DataPoints>
        <DataPoints>
            <Timestamp>1651113345000</Timestamp>
            <Statistics>10.5</Statistics>
        </DataPoints>
        <DataPoints>
            <Timestamp>1651113360000</Timestamp>
            <Statistics>10.5</Statistics>
        </DataPoints>
        <DataPoints>
            <Timestamp>1651113375000</Timestamp>
            <Statistics>10.5</Statistics>
        </DataPoints>
        <DataPoints>
            <Timestamp>1651113390000</Timestamp>
            <Statistics>10.5</Statistics>
        </DataPoints>
        <DataPoints>
            <Timestamp>1651113405000</Timestamp>
            <Statistics>10.5</Statistics>
        </DataPoints>
        <DataPoints>
            <Timestamp>1651113420000</Timestamp>
            <Statistics>10.5</Statistics>
        </DataPoints>
        <DataPoints>
            <Timestamp>1651113435000</Timestamp>
            <Statistics>10.5</Statistics>
        </DataPoints>
        <DataPoints>
            <Timestamp>1651113450000</Timestamp>
            <Statistics>10.5</Statistics>
        </DataPoints>
        <DataPoints>
            <Timestamp>1651113465000</Timestamp>
            <Statistics>10.5</Statistics>
        </DataPoints>
        <DataPoints>
            <Timestamp>1651113480000</Timestamp>
            <Statistics>10.5</Statistics>
        </DataPoints>
        <DataPoints>
            <Timestamp>1651113495000</Timestamp>
            <Statistics>10.5</Statistics>
        </DataPoints>
        <DataPoints>
            <Timestamp>1651113510000</Timestamp>
            <Statistics>10.5</Statistics>
        </DataPoints>
        <DataPoints>
            <Timestamp>1651113525000</Timestamp>
            <Statistics>10.5</Statistics>
        </DataPoints>
        <DataPoints>
            <Timestamp>1651113540000</Timestamp>
            <Statistics>10.5</Statistics>
        </DataPoints>
        <DataPoints>
            <Timestamp>1651113555000</Timestamp>
            <Statistics>10.5</Statistics>
        </DataPoints>
        <Success>true</Success>
    </data>
    <httpStatusCode>200</httpStatusCode>
    <requestId>36F33F1C-CF13-149E-AB05-****</requestId>
    <successResponse>true</successResponse>
</DescribeMetricListResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "code" : "200",
  "data" : {
    "MetricName" : "diskusage_utilization",
    "RequestId" : "36F33F1C-CF13-149E-AB05-****",
    "MetricType" : "CLUSTER",
    "HttpStatusCode" : 200,
    "Period" : 15,
    "DataPoints" : [ {
      "Timestamp" : 1651112970000,
      "Statistics" : 10.5
    }, {
      "Timestamp" : 1651112985000,
      "Statistics" : 10.5
    }, {
      "Timestamp" : 1651113000000,
      "Statistics" : 10.5
    }, {
      "Timestamp" : 1651113015000,
      "Statistics" : 10.5
    }, {
      "Timestamp" : 1651113030000,
      "Statistics" : 10.5
    }, {
      "Timestamp" : 1651113045000,
      "Statistics" : 10.5
    }, {
      "Timestamp" : 1651113060000,
      "Statistics" : 10.5
    }, {
      "Timestamp" : 1651113075000,
      "Statistics" : 10.5
    }, {
      "Timestamp" : 1651113090000,
      "Statistics" : 10.5
    }, {
      "Timestamp" : 1651113105000,
      "Statistics" : 10.5
    }, {
      "Timestamp" : 1651113120000,
      "Statistics" : 10.5
    }, {
      "Timestamp" : 1651113135000,
      "Statistics" : 10.5
    }, {
      "Timestamp" : 1651113150000,
      "Statistics" : 10.5
    }, {
      "Timestamp" : 1651113165000,
      "Statistics" : 10.5
    }, {
      "Timestamp" : 1651113180000,
      "Statistics" : 10.5
    }, {
      "Timestamp" : 1651113195000,
      "Statistics" : 10.5
    }, {
      "Timestamp" : 1651113210000,
      "Statistics" : 10.5
    }, {
      "Timestamp" : 1651113225000,
      "Statistics" : 10.5
    }, {
      "Timestamp" : 1651113240000,
      "Statistics" : 10.5
    }, {
      "Timestamp" : 1651113255000,
      "Statistics" : 10.5
    }, {
      "Timestamp" : 1651113270000,
      "Statistics" : 10.5
    }, {
      "Timestamp" : 1651113285000,
      "Statistics" : 10.5
    }, {
      "Timestamp" : 1651113300000,
      "Statistics" : 10.5
    }, {
      "Timestamp" : 1651113315000,
      "Statistics" : 10.5
    }, {
      "Timestamp" : 1651113330000,
      "Statistics" : 10.5
    }, {
      "Timestamp" : 1651113345000,
      "Statistics" : 10.5
    }, {
      "Timestamp" : 1651113360000,
      "Statistics" : 10.5
    }, {
      "Timestamp" : 1651113375000,
      "Statistics" : 10.5
    }, {
      "Timestamp" : 1651113390000,
      "Statistics" : 10.5
    }, {
      "Timestamp" : 1651113405000,
      "Statistics" : 10.5
    }, {
      "Timestamp" : 1651113420000,
      "Statistics" : 10.5
    }, {
      "Timestamp" : 1651113435000,
      "Statistics" : 10.5
    }, {
      "Timestamp" : 1651113450000,
      "Statistics" : 10.5
    }, {
      "Timestamp" : 1651113465000,
      "Statistics" : 10.5
    }, {
      "Timestamp" : 1651113480000,
      "Statistics" : 10.5
    }, {
      "Timestamp" : 1651113495000,
      "Statistics" : 10.5
    }, {
      "Timestamp" : 1651113510000,
      "Statistics" : 10.5
    }, {
      "Timestamp" : 1651113525000,
      "Statistics" : 10.5
    }, {
      "Timestamp" : 1651113540000,
      "Statistics" : 10.5
    }, {
      "Timestamp" : 1651113555000,
      "Statistics" : 10.5
    } ],
    "Success" : true
  },
  "httpStatusCode" : "200",
  "requestId" : "36F33F1C-CF13-149E-AB05-****",
  "successResponse" : true
}

错误码

HttpCode 错误码 错误信息 描述
400 Throttling.User Request was denied due to user flow control. 由于请求频次达到阈值,请求被拒绝,请稍后重试。
500 ServiceUnavailable The request has failed due to a temporary failure of the server. 由于服务端响应超时或者不可用导致请求失败,请重试,重试后仍失败请联系技术支持。
403 InvalidSecurityToken.Expired Specified SecurityToken is expired. 签名已经过期,请更新签名

访问错误中心查看更多错误码。