ListDedicatedCluster - Data Transmission Service

Queries all clusters that are created within an Alibaba Cloud account. You can also query clusters based on the specified conditions.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters


Parameter	Type	Required	Example	Description
Action	String	Yes	ListDedicatedCluster	The operation that you want to perform. Set the value to ListDedicatedCluster.
RegionId	String	No	cn-hangzhou	The ID of the region.
Type	String	No	NAME	The type of the query condition. Valid values: NAME: the name of the cluster. INSTANCE: the ID of a cluster instance. DEDICATEDCLUSTERID: the ID of the dedicated cluster. Note You must specify Params to specify the content of the query condition.
Params	String	No	dtspk3f13r731m****	The content of the query condition. Note You must specify Type to specify the type of the query condition.
State	String	No	init	The status of the cluster. Valid values: init: The cluster is being initialized. schedule: The cluster is pending scheduling. running: The cluster is running. upgrade: The cluster is being upgraded. downgrade: The cluster is being downgraded. locked: The cluster is locked. releasing: The cluster is being released. released: The cluster is released.
OrderDirection	String	No	asc	The order in which you want to sort the retrieved entries. Valid values: asc (default): sorts the retrieved entries in ascending order. desc: sorts the retrieved entries in descending order.
OrderColumn	String	No	gmtCreated	The basis on which the retrieved entries are sorted if multiple Data Transmission Service (DTS) dedicated clusters are returned. Valid values: gmtCreated: the time when a cluster was created. orderCount: the number of nodes in a cluster.
PageSize	Integer	No	10	The number of entries per page.
PageNumber	Integer	No	1	The page number. The value of this parameter must be an integer that is greater than 0. Default value: 1.

Response parameters


Parameter	Type	Example	Description
HttpStatusCode	String	200	The HTTP status code.
RequestId	String	621BB4F8-3016-4FAA-8D5A-5D3163CC****	The ID of the request.
ErrCode	String	InternalError	The error code returned if the request failed.
Success	String	true	Indicates whether the request was successful.
ErrMessage	String	The Value of Input Parameter %s is not valid.	The error message returned if the request failed.
PageRecordCount	Integer	20	The number of entries per page.
TotalRecordCount	Integer	15	The total number of clusters that meet the query condition.
PageNumber	Integer	1	The page number. The value is an integer that is greater than 0. Default value: 1.
DedicatedClusterStatusList	Array of DedicatedClusterStatus		The status of all clusters.
DedicatedClusterStatus
DtsInstanceID	String	dtsi03e3zty16i****	The ID of the DTS instance.
DedicatedClusterId	String	dtscluster*******	The ID of the cluster.
DedicatedClusterName	String	daily_test	The name of the cluster.
Du	Long	30	The number of DTS units (DUs).
OversoldDu	Long	60	The number of overcommitted DUs.
UsedDu	Long	5	The number of used DUs.
State	String	init	The status of the cluster. Valid values: init: The cluster is being initialized. schedule: The cluster is pending scheduling. running: The cluster is running. upgrade: The cluster is being upgraded. downgrade: The cluster is being downgraded. locked: The cluster is locked. releasing: The cluster is being released. released: The cluster is released.
RegionId	String	cn-hangzhou	The ID of the region in which the DTS instance resides.
GmtCreated	Long	1647424384606	The time when the cluster was created.
NodeCount	Long	5	The number of nodes in the cluster.
DuUtilization	Long	16.6667	The DU usage. Unit: %.
CpuUtilization	Long	30	The CPU utilization. Unit: %.
TotalCpuCore	Long	100	The total number of CPU cores.
UsedCpuCore	Long	30	The number of used CPU cores.
MemUtilization	Long	20	The memory usage.
TotalMemGBSize	Long	256	The total memory size. Unit: GB.
UsedMemGBSize	Long	128	The used memory size. Unit: GB.
DiskUtilization	Long	50	The disk usage.
TotalDiskGBSize	Long	2048	The total disk size. Unit: GB.
UsedDiskGBSize	Long	1024	The used disk size. Unit: GB.

Examples

Sample requests

http(s)://dts.aliyuncs.com/?Action=ListDedicatedCluster
&RegionId=cn-hangzhou
&Type=NAME
&Params=dtspk3f13r731m****
&State=init
&OrderDirection=asc
&OrderColumn=gmtCreated
&PageSize=10
&PageNumber=1
&Common request parameters

Sample success responses

XML format

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 format

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
}

Error codes


HTTP status code	Error code	Error message	Description
400	Throttling.User	Request was denied due to user flow control.	The number of requests reached the limit and the request was rejected. Try again later.
500	ServiceUnavailable	The request has failed due to a temporary failure of the server.	The response of the server timed out or the server was unavailable. Try again. If the error persists, contact technical support.
403	InvalidSecurityToken.Expired	Specified SecurityToken is expired.	The signature expired. Use a new signature.

For a list of error codes, see Service error codes.