DescribeDedicatedCluster - Data Transmission Service

Queries the information about a Data Transmission Service (DTS) dedicated cluster.

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	DescribeDedicatedCluster	The operation that you want to perform. Set the value to DescribeDedicatedCluster.
DedicatedClusterId	String	Yes	dtsCluster****	The ID of the cluster.
RegionId	String	No	cn-hangzhou	The ID of the region in which the instance resides.

Response parameters


Parameter	Type	Example	Description
HttpStatusCode	String	200	The HTTP status code.
RequestId	String	621BB4F8-3016-4FAA-8D5A-5D3163CC****	The request ID.
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.
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 DUs that exceeds the upper limit.
UsedDu	Long	5	The number of used DUs.
State	String	inti	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 instance resides.
NodeCount	Long	5	The number of nodes in the cluster.
DuUtilization	Long	16	The DU usage. Unit: percentage.
CpuUtilization	Long	30	The CPU utilization. Unit: percentage.
TotalCpuCore	Long	100	The total number of CPU cores.
UsedCpuCore	Long	30	The number of used CPU cores.
MemUtilization	Long	20	The used CPU capacity.
TotalMemGBSize	Long	256	The total amount of memory. Unit: GB.
UsedMemGBSize	Long	128	The amount of used memory. 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.
GmtCreated	Long	1642476144000	The time when the cluster was created.
GmtFinished	Long	1645200000000	The time when the cluster expires.
DtsInstanceID	String	dtsb8r****	The instance ID.

Examples

Sample requests

http(s)://dts.aliyuncs.com/?Action=DescribeDedicatedCluster
&DedicatedClusterId=dtsCluster****
&RegionId=cn-hangzhou
&Common request parameters

Sample success responses

XML format

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

<DescribeDedicatedClusterResponse>
    <code>200</code>
    <data>
        <UsedDu>14</UsedDu>
        <DuUtilization>46</DuUtilization>
        <UsedDiskGBSize>51</UsedDiskGBSize>
        <RequestId>1D1C3EFB-3338-143F-***</RequestId>
        <DedicatedClusterId>dtscluster_w4iv***</DedicatedClusterId>
        <NodeCount>2</NodeCount>
        <OversoldDu>30</OversoldDu>
        <TotalDiskGBSize>1006</TotalDiskGBSize>
        <DiskUtilization>6</DiskUtilization>
        <GmtFinished>1645200000000</GmtFinished>
        <UsedMemGBSize>63</UsedMemGBSize>
        <GmtCreated>1642476144000</GmtCreated>
        <DedicatedClusterName>dtscluster_w4iv***</DedicatedClusterName>
        <DtsInstanceID>dtsb84w***</DtsInstanceID>
        <Success>true</Success>
        <TotalMemGBSize>259</TotalMemGBSize>
        <MemUtilization>24</MemUtilization>
        <Du>30</Du>
        <State>running</State>
        <HttpStatusCode>200</HttpStatusCode>
        <UsedCpuCore>64</UsedCpuCore>
        <TotalCpuCore>32</TotalCpuCore>
        <RegionId>cn-hangzhou</RegionId>
        <CpuUtilization>2</CpuUtilization>
    </data>
    <httpStatusCode>200</httpStatusCode>
    <requestId>1D1C3EFB-3338-143F-8CF2-***</requestId>
    <successResponse>true</successResponse>
</DescribeDedicatedClusterResponse>

JSON format

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

{
  "code" : "200",
  "data" : {
    "UsedDu" : 14,
    "DuUtilization" : 46,
    "UsedDiskGBSize" : 51,
    "RequestId" : "1D1C3EFB-3338-143F-***",
    "DedicatedClusterId" : "dtscluster_w4iv***",
    "NodeCount" : 2,
    "OversoldDu" : 30,
    "TotalDiskGBSize" : 1006,
    "DiskUtilization" : 6,
    "GmtFinished" : 1645200000000,
    "UsedMemGBSize" : 63,
    "GmtCreated" : 1642476144000,
    "DedicatedClusterName" : "dtscluster_w4iv***",
    "DtsInstanceID" : "dtsb84w***",
    "Success" : true,
    "TotalMemGBSize" : 259,
    "MemUtilization" : 24,
    "Du" : 30,
    "State" : "running",
    "HttpStatusCode" : 200,
    "UsedCpuCore" : 64,
    "TotalCpuCore" : 32,
    "RegionId" : "cn-hangzhou",
    "CpuUtilization" : 2
  },
  "httpStatusCode" : "200",
  "requestId" : "1D1C3EFB-3338-143F-8CF2-***",
  "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.