查詢叢集列表 - Data Transmission Service

調試

您可以在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.	簽名已經到期，請更新簽名

訪問錯誤中心查看更多錯誤碼。