調(diào)用ListClusters分頁查詢集群列表。
調(diào)試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
請求參數(shù)
名稱 | 類型 | 是否必選 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | ListClusters |
系統(tǒng)規(guī)定參數(shù)。取值:ListClusters。 |
RegionId | String | 是 | cn-hangzhou |
地域ID。 |
CreateType | String | 否 | ON-DEMAND |
集群創(chuàng)建類型。可選值: ON-DEMAND。 MANUAL。 |
MachineType | String | 否 | ECS |
機器類型。 |
IsDesc | Boolean | 否 | false |
是否倒序排列。 |
DepositType | String | 否 | HALF_MANAGED |
托管類型,標識集群是全托管還是半托管。枚舉值: HALF_MANAGED。 FULLY_MANAGED。 |
PageNumber | Integer | 否 | 1 |
分頁分數(shù),從1開始。 |
PageSize | Integer | 否 | 10 |
分頁大小。 |
DefaultStatus | Boolean | 否 | true |
是否查詢默認狀態(tài)為初始化中、等待構(gòu)建、空閑、運行中、釋放中、創(chuàng)建失敗的集群。 |
Name | String | 否 | cluster_name |
集群名。 |
ResourceGroupId | String | 否 | rg-bp67acfmxazb4p**** |
DDI實例和節(jié)點ECS實例所在的企業(yè)資源組ID |
Tag.N.Key | String | 否 | TestKey |
DDI實例和節(jié)點ECS實例的標簽鍵。 |
Tag.N.Value | String | 否 | TestValue |
DDI實例和節(jié)點ECS實例的標簽值。N的取值范圍:1~20。一旦傳入該值,可以為空字符串。標簽值的取值范圍1~128,不能以acs:開頭,不能包含http://或者https://。 |
返回數(shù)據(jù)
名稱 | 類型 | 示例值 | 描述 |
---|---|---|---|
PageSize | Integer | 10 |
分頁大小。 |
RequestId | String | BF4FBAC6-B03E-4BFB-B6DB-EB53C34F2E22 |
請求ID。 |
PageNumber | Integer | 1 |
分頁頁數(shù)。 |
TotalCount | Integer | 12 |
查詢總數(shù)。 |
Clusters | Array of ClusterInfo |
集群列表。 |
|
ClusterInfo | |||
Type | String | 標準型 |
集群類型。 |
Status | String | IDEL |
集群狀態(tài)。 |
RunningTime | Integer | 2345 |
已運行時間(秒)。 |
MetaStoreType | String | local |
統(tǒng)一元數(shù)據(jù)類型。 |
MachineType | String | ECS |
集群的主機類型,目前默認為ECS。 |
OrderList | String | 0 |
訂單列表。 |
CreateTime | Long | 1542784048000 |
創(chuàng)建時間。 |
ChargeType | String | PostPaid |
付費類型。 |
DepositType | String | HALF_MANAGED |
托管類型,標識集群是全托管還是半托管。枚舉值:HALF_MANAGED、FULLY_MANAGED。 |
Period | Integer | 10 |
包年包月時間(可選包月數(shù)量有:1、2、3、4、5、6、7、8、9、12、24、36。) |
K8sClusterId | String | [] |
K8s集群ID。 |
ExpiredTime | Long | 1542784048000 |
包年包月集群超時時間。 |
HasUncompletedOrder | Boolean | false |
是否有未完成的訂單。 |
Name | String | cluster_name |
集群名。 |
CreateResource | String | ECM_DDI |
自動附加到DDI集群的標簽。 |
Id | String | C-010A704DA760**** |
集群ID。 |
Tags | Array of Tag |
標簽。 |
|
Tag | |||
TagValue | String | [] |
標簽值。 |
TagKey | String | [] |
標簽鍵。 |
OrderTaskInfo | Object |
保留字段,訂單任務(wù)信息。 |
|
TargetCount | Integer | 0 |
保留字段。 |
CurrentCount | Integer | 0 |
保留字段。 |
OrderIdList | String | 0 |
保留字段。 |
FailReason | Object |
創(chuàng)建失敗原因。 |
|
ErrorMsg | String | The specified ImageId does not exist. |
錯誤信息。 |
RequestId | String | B8DC3A91-3953-4444-92BB-DBC29C47EC1A |
請求ID。 |
ErrorCode | String | InvalidImageId.NotFound |
錯誤碼。 |
示例
請求示例
http(s)://[Endpoint]/?Action=ListClusters
&RegionId=cn-hangzhou
&<公共請求參數(shù)>
正常返回示例
XML
格式
HTTP/1.1 200 OK
Content-Type:application/xml
<TotalCount>12</TotalCount>
<RequestId>BF4FBAC6-B03E-4BFB-B6DB-EB53C34F2E22</RequestId>
<PageSize>10</PageSize>
<PageNumber>1</PageNumber>
<Clusters>
<ClusterInfo>
<Status>IDEL</Status>
<CreateResource>ECM_DDI</CreateResource>
<CreateTime>1542784048000</CreateTime>
<MachineType>ECS</MachineType>
<DepositType>HALF_MANAGED</DepositType>
<Period>10</Period>
<MetaStoreType>local</MetaStoreType>
<K8sClusterId/>
<Name>cluster_name</Name>
<Type>標準型</Type>
<ChargeType>PostPaid</ChargeType>
<ExpiredTime>1542784048000</ExpiredTime>
<Id>C-010A704DA760****</Id>
<OrderList>0</OrderList>
<HasUncompletedOrder>false</HasUncompletedOrder>
<RunningTime>2345</RunningTime>
</ClusterInfo>
<ClusterInfo>
<Tags>
<Tag>
<TagKey/>
<TagValue/>
</Tag>
</Tags>
</ClusterInfo>
<ClusterInfo>
<OrderTaskInfo>
<OrderIdList>0</OrderIdList>
<TargetCount>0</TargetCount>
<RequestId>B8DC3A91-3953-4444-92BB-DBC29C47EC1A</RequestId>
<ErrorMsg>The specified ImageId does not exist.</ErrorMsg>
<CurrentCount>0</CurrentCount>
<ErrorCode>InvalidImageId.NotFound</ErrorCode>
</OrderTaskInfo>
<FailReason>
<OrderIdList>0</OrderIdList>
<TargetCount>0</TargetCount>
<RequestId>B8DC3A91-3953-4444-92BB-DBC29C47EC1A</RequestId>
<ErrorMsg>The specified ImageId does not exist.</ErrorMsg>
<CurrentCount>0</CurrentCount>
<ErrorCode>InvalidImageId.NotFound</ErrorCode>
</FailReason>
</ClusterInfo>
</Clusters>
JSON
格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"TotalCount" : 12,
"RequestId" : "BF4FBAC6-B03E-4BFB-B6DB-EB53C34F2E22",
"PageSize" : 10,
"PageNumber" : 1,
"Clusters" : {
"ClusterInfo" : [ {
"Status" : "IDEL",
"CreateResource" : "ECM_DDI",
"CreateTime" : 1542784048000,
"MachineType" : "ECS",
"DepositType" : "HALF_MANAGED",
"Period" : 10,
"MetaStoreType" : "local",
"K8sClusterId" : "",
"Name" : "cluster_name",
"Type" : "標準型",
"ChargeType" : "PostPaid",
"ExpiredTime" : 1542784048000,
"Id" : "C-010A704DA760****",
"OrderList" : 0,
"HasUncompletedOrder" : false,
"RunningTime" : 2345
}, {
"Tags" : {
"Tag" : {
"TagKey" : "",
"TagValue" : ""
}
}
}, {
"OrderTaskInfo" : {
"OrderIdList" : 0,
"TargetCount" : 0,
"RequestId" : "B8DC3A91-3953-4444-92BB-DBC29C47EC1A",
"ErrorMsg" : "The specified ImageId does not exist.",
"CurrentCount" : 0,
"ErrorCode" : "InvalidImageId.NotFound"
},
"FailReason" : {
"OrderIdList" : 0,
"TargetCount" : 0,
"RequestId" : "B8DC3A91-3953-4444-92BB-DBC29C47EC1A",
"ErrorMsg" : "The specified ImageId does not exist.",
"CurrentCount" : 0,
"ErrorCode" : "InvalidImageId.NotFound"
}
} ]
}
}
錯誤碼
HttpCode | 錯誤碼 | 錯誤信息 | 描述 |
---|---|---|---|
400 | EcmClusterId.NotFound | The cluster ID is invalid. | 指定集群Id不存在 |
400 | DB.Fail | A database access error occurred. | 數(shù)據(jù)庫訪問錯誤,請重試或者提工單 |
400 | RAM.Permission.NotAllow | You are not authorized to perform the operation. | 沒有權(quán)限執(zhí)行此操作,請聯(lián)系主賬號授權(quán) |
400 | InternalError | The request processing has failed due to some unknown error. | 內(nèi)部錯誤,請?zhí)峁?/td> |
400 | Invalid.Cluster.Status | The cluster status %s is invalid. | 指定集群狀態(tài)不合法 |
400 | Invalid.Cluster.Type | The cluster type %s is invalid. | 指定集群類型不合法 |
400 | User.OtherUserResource.NotAllow | You are not authorized to operate other users resource. | 不能操作其它用戶的資源 |
403 | Params.Illegal | The format of the specified parameter is invalid. | 參數(shù)格式錯誤 |
訪問錯誤中心查看更多錯誤碼。
訪問錯誤中心查看更多錯誤碼。