调用DescribeClusterUsedUtilization接口查看集群当前使用量。

调试

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

请求参数

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

系统规定参数。取值：DescribeClusterUsedUtilization。

DedicatedClusterId String 是 nodeid

当MetricType为CLUSTER填入独享集群ID，否则为nodeid。

Env String 否 ALIYUN

默认为ALIYUN。

MetricType String 否 NODE

查询集群或节点，取值：

  • CLUSTER（默认值）：集群。
  • NODE：节点
RegionId String 否 cn-hangzhou

实例所在地域。
DtsJobId String 否 k2gm967v16f****

迁移或同步任务ID。
ClientToken String 否 0c593ea1-3bea-11e9-b96b-88e9fe63****

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

AccountId String 否 12323344****

阿里云主账号ID，无需设置，该参数即将下线。

返回数据

名称 类型 示例值 描述
DedicatedClusterId String dtscluster_h3fl1cs217sx952

集群ID。
CpuTotal Float 50

集群CPU使用率，单位为%。
MemoryUsed Float 0

内存使用量，暂时返回0。
MemoryTotal Float 0

内存总量，暂时返回0。
DiskTotal Float 1024

集群磁盘总量，单位GB。
DiskUsed Float 96

集群磁盘使用量，单位GB。
DuTotal Integer 30

总DU量。
DuUsed Integer 2

DU使用量。
TaskRunning Integer 3

运行任务数。
Success Boolean true

调用结果是否成功。
Code String 200

后端错误码，数字递增。
ErrCode String InternalError

调用出错时返回的错误码。
ErrMessage String The Value of Input Parameter %s is not valid.

错误信息。
DynamicMessage String Type

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

状态码。
RequestId String 621BB4F8-3016-4FAA-8D5A-5D3163CC****

请求ID。
MemoryUsedPercentage Float 1.0

内存使用百分比。

示例

请求示例

http(s)://dts.aliyuncs.com/?Action=DescribeClusterUsedUtilization
&DedicatedClusterId=nodeid
&Env=ALIYUN
&MetricType=NODE
&RegionId=cn-hangzhou
&DtsJobId=k2gm967v16f****
&ClientToken=0c593ea1-3bea-11e9-b96b-88e9fe63****
&AccountId=12323344****
&公共请求参数

正常返回示例

XML格式 

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

<DescribeClusterUsedUtilizationResponse>
    <code>200</code>
    <data>
        <DedicatedClusterId>dtscluster_****</DedicatedClusterId>
        <RequestId>E2E2AD3E-B7A4-106C-9063-****</RequestId>
        <DuUsed>14</DuUsed>
        <Success>true</Success>
        <DuTotal>30</DuTotal>
        <DiskTotal>982.3013</DiskTotal>
        <HttpStatusCode>200</HttpStatusCode>
        <MemoryUsedPercentage>5.5200005</MemoryUsedPercentage>
        <MemoryUsed>0</MemoryUsed>
        <TaskRunning>3</TaskRunning>
        <DiskUsed>92.0647</DiskUsed>
        <MemoryTotal>0</MemoryTotal>
        <CpuTotal>1.7</CpuTotal>
    </data>
    <httpStatusCode>200</httpStatusCode>
    <requestId>E2E2AD3E-B7A4-106C-9063-****</requestId>
    <successResponse>true</successResponse>
</DescribeClusterUsedUtilizationResponse>

JSON格式 

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

{
  "code" : "200",
  "data" : {
    "DedicatedClusterId" : "dtscluster_****",
    "RequestId" : "E2E2AD3E-B7A4-106C-9063-****",
    "DuUsed" : 14,
    "Success" : true,
    "DuTotal" : 30,
    "DiskTotal" : 982.3013,
    "HttpStatusCode" : 200,
    "MemoryUsedPercentage" : 5.5200005,
    "MemoryUsed" : 0.0,
    "TaskRunning" : 3,
    "DiskUsed" : 92.0647,
    "MemoryTotal" : 0.0,
    "CpuTotal" : 1.7
  },
  "httpStatusCode" : "200",
  "requestId" : "E2E2AD3E-B7A4-106C-9063-****",
  "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. 签名已经过期，请更新签名

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