查询集群列表 - 数据传输服务 DTS

调试

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

请求参数


名称	类型	是否必选	示例值	描述
Action	String	是	ListDedicatedCluster	系统规定参数。取值：ListDedicatedCluster。
RegionId	String	否	cn-hangzhou	区域，指定的查询条件。
Type	String	否	NAME	查询的键，取值为： NAME：集群名称。 INSTANCE：集群实例ID。 DEDICATEDCLUSTERID：专属集群ID。说明您需要传入Params，指定查询条件的具体内容。
Params	String	否	dtspk3f13r731m****	查询条件的具体内容。说明您需要提前传入Type，指定查询条件。
State	String	否	init	集群状态，取值为： init：初始化。 schedule：待调度。 running：运行中。 upgrade：升级中。 downgrade,：降级中。 locked：已锁定。 releasing：释放中。 released：已经释放。
OrderDirection	String	否	asc	排序方向，取值为： asc：正序，为默认值。 desc：倒序。
OrderColumn	String	否	gmtCreated	当返回结果包含多个DTS专属集群实例时，传入本参数指定实例的排序依据，取值： gmtCreated：创建时间 orderCount：节点数
PageSize	Integer	否	10	每页记录集群数量。
PageNumber	Integer	否	1	页码，取值为大于0且不超过Integer数据类型的最大值，默认值为1。

返回数据


名称	类型	示例值	描述
HttpStatusCode	String	200	状态码。
RequestId	String	621BB4F8-3016-4FAA-8D5A-5D3163CC****	请求ID。
ErrCode	String	InternalError	调用出错时返回的错误码。
Success	String	true	请求是否成功。
ErrMessage	String	The Value of Input Parameter %s is not valid.	调用错误时返回的错误信息。
PageRecordCount	Integer	20	当前页可展示的最大记录数。
TotalRecordCount	Integer	15	所有符合条件的集群数量。
PageNumber	Integer	1	页码，取值为大于0且不超过Integer数据类型的最大值，默认值为1。
DedicatedClusterStatusList	Array of DedicatedClusterStatus		查询所有集群的状态。
DedicatedClusterStatus
DtsInstanceID	String	dtsi03e3zty16i****	DTS实例ID。
DedicatedClusterId	String	dtscluster*******	集群ID。
DedicatedClusterName	String	daily_test	集群名称。
Du	Long	30	DU数。
OversoldDu	Long	60	超配DU的数量。
UsedDu	Long	5	已使用DU数量。
State	String	init	集群状态，取值为： init：初始化。 schedule：待调度。 running：运行中。 upgrade：升级中。 downgrade,：降级中。 locked：已锁定。 releasing：释放中。 released：已经释放。
RegionId	String	cn-hangzhou	实例所在区域。
GmtCreated	Long	1647424384606	创建时间。
NodeCount	Long	5	集群节点数。
DuUtilization	Long	16.6667	DU使用百分比。
CpuUtilization	Long	30	CPU使用百分比。
TotalCpuCore	Long	100	CPU总核数。
UsedCpuCore	Long	30	已使用CPU核数。
MemUtilization	Long	20	CPU使用量。
TotalMemGBSize	Long	256	内存总大小（GB）。
UsedMemGBSize	Long	128	已使用内存大小（GB）。
DiskUtilization	Long	50	磁盘使用量。
TotalDiskGBSize	Long	2048	磁盘总大小（GB）。
UsedDiskGBSize	Long	1024	已使用磁盘大小（GB）。

示例

请求示例

http(s)://dts.aliyuncs.com/?Action=ListDedicatedCluster
&RegionId=cn-hangzhou
&Type=NAME
&Params=dtspk3f13r731m****
&State=init
&OrderDirection=asc
&OrderColumn=gmtCreated
&PageSize=10
&PageNumber=1
&公共请求参数

正常返回示例

XML格式

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

<ListDedicatedClusterResponse>
    <code>200</code>
    <data>
        <TotalRecordCount>2</TotalRecordCount>
        <PageRecordCount>20</PageRecordCount>
        <RequestId>49BCBE1F-3AB4-***</RequestId>
        <PageNumber>1</PageNumber>
        <DedicatedClusterStatusList>
            <DedicatedClusterStatus>
                <UsedDu>14</UsedDu>
                <DuUtilization>46</DuUtilization>
                <DedicatedClusterId>dtscluster_***</DedicatedClusterId>
                <NodeCount>2</NodeCount>
                <UsedDiskGBSize>51</UsedDiskGBSize>
                <OversoldDu>30</OversoldDu>
                <TotalDiskGBSize>1006</TotalDiskGBSize>
                <DiskUtilization>6</DiskUtilization>
                <UsedMemGBSize>63</UsedMemGBSize>
                <GmtCreated>1642476144000</GmtCreated>
                <DtsInstanceID>dtsb84w12e2188ya1r</DtsInstanceID>
                <DedicatedClusterName>dtscluster_***</DedicatedClusterName>
                <TotalMemGBSize>259</TotalMemGBSize>
                <Du>30</Du>
                <MemUtilization>24</MemUtilization>
                <State>running</State>
                <UsedCpuCore>0</UsedCpuCore>
                <TotalCpuCore>32</TotalCpuCore>
                <RegionId>cn-hangzhou</RegionId>
                <CpuUtilization>2</CpuUtilization>
            </DedicatedClusterStatus>
            <DedicatedClusterStatus>
                <UsedDu>0</UsedDu>
                <DuUtilization>0</DuUtilization>
                <DedicatedClusterId>dtsCluster***</DedicatedClusterId>
                <NodeCount>0</NodeCount>
                <UsedDiskGBSize>0</UsedDiskGBSize>
                <OversoldDu>60</OversoldDu>
                <TotalDiskGBSize>0</TotalDiskGBSize>
                <DiskUtilization>0</DiskUtilization>
                <UsedMemGBSize>0</UsedMemGBSize>
                <GmtCreated>1641377381000</GmtCreated>
                <DedicatedClusterName>dedicatedCluster_***</DedicatedClusterName>
                <TotalMemGBSize>0</TotalMemGBSize>
                <Du>40</Du>
                <MemUtilization>0</MemUtilization>
                <State>releasing</State>
                <UsedCpuCore>0</UsedCpuCore>
                <TotalCpuCore>0</TotalCpuCore>
                <RegionId>cn-hangzhou</RegionId>
                <CpuUtilization>0</CpuUtilization>
            </DedicatedClusterStatus>
        </DedicatedClusterStatusList>
        <HttpStatusCode>200</HttpStatusCode>
        <Success>true</Success>
    </data>
    <httpStatusCode>200</httpStatusCode>
    <requestId>49BCBE1F-3AB4-****</requestId>
    <successResponse>true</successResponse>
</ListDedicatedClusterResponse>

JSON格式

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

{
  "code" : "200",
  "data" : {
    "TotalRecordCount" : 2,
    "PageRecordCount" : 20,
    "RequestId" : "49BCBE1F-3AB4-***",
    "PageNumber" : 1,
    "DedicatedClusterStatusList" : {
      "DedicatedClusterStatus" : [ {
        "UsedDu" : 14,
        "DuUtilization" : 46,
        "DedicatedClusterId" : "dtscluster_***",
        "NodeCount" : 2,
        "UsedDiskGBSize" : 51,
        "OversoldDu" : 30,
        "TotalDiskGBSize" : 1006,
        "DiskUtilization" : 6,
        "UsedMemGBSize" : 63,
        "GmtCreated" : 1642476144000,
        "DtsInstanceID" : "dtsb84w12e2188ya1r",
        "DedicatedClusterName" : "dtscluster_***",
        "TotalMemGBSize" : 259,
        "Du" : 30,
        "MemUtilization" : 24,
        "State" : "running",
        "UsedCpuCore" : 0,
        "TotalCpuCore" : 32,
        "RegionId" : "cn-hangzhou",
        "CpuUtilization" : 2
      }, {
        "UsedDu" : 0,
        "DuUtilization" : 0,
        "DedicatedClusterId" : "dtsCluster***",
        "NodeCount" : 0,
        "UsedDiskGBSize" : 0,
        "OversoldDu" : 60,
        "TotalDiskGBSize" : 0,
        "DiskUtilization" : 0,
        "UsedMemGBSize" : 0,
        "GmtCreated" : 1641377381000,
        "DedicatedClusterName" : "dedicatedCluster_***",
        "TotalMemGBSize" : 0,
        "Du" : 40,
        "MemUtilization" : 0,
        "State" : "releasing",
        "UsedCpuCore" : 0,
        "TotalCpuCore" : 0,
        "RegionId" : "cn-hangzhou",
        "CpuUtilization" : 0
      } ]
    },
    "HttpStatusCode" : 200,
    "Success" : true
  },
  "httpStatusCode" : "200",
  "requestId" : "49BCBE1F-3AB4-****",
  "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.	签名已经过期，请更新签名

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