調(diào)用DescribeDeploymentSets接口,并可以指定DeploymentSetIds、Strategy、DeploymentSetName等參數(shù),查詢一個或多個部署集的詳細信息。
調(diào)試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權(quán)信息
下表是API對應(yīng)的授權(quán)信息,可以在RAM權(quán)限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調(diào)用此API的權(quán)限。具體說明如下:
- 操作:是指具體的權(quán)限點。
- 訪問級別:是指每個操作的訪問級別,取值為寫入(Write)、讀取(Read)或列出(List)。
- 資源類型:是指操作中支持授權(quán)的資源類型。具體說明如下:
- 對于必選的資源類型,用背景高亮的方式表示。
- 對于不支持資源級授權(quán)的操作,用
全部資源
表示。
- 條件關(guān)鍵字:是指云產(chǎn)品自身定義的條件關(guān)鍵字。
- 關(guān)聯(lián)操作:是指成功執(zhí)行操作所需要的其他權(quán)限。操作者必須同時具備關(guān)聯(lián)操作的權(quán)限,操作才能成功。
操作 | 訪問級別 | 資源類型 | 條件關(guān)鍵字 | 關(guān)聯(lián)操作 |
---|---|---|---|---|
ecs:DescribeDeploymentSets | get | *DeploymentSet acs:ecs:{#regionId}:{#accountId}:deploymentset/* |
| 無 |
請求參數(shù)
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
RegionId | string | 是 | 部署集所屬地域 ID。您可以調(diào)用 DescribeRegions 查看最新的阿里云地域列表。 | cn-hangzhou |
PageNumber | integer | 否 | 部署集列表的頁碼。 起始值為 1。 默認值為 1。 | 1 |
PageSize | integer | 否 | 分頁查詢時設(shè)置的每頁行數(shù)。 最大值為 50。 默認值為 10。 | 10 |
DeploymentSetIds | string | 否 | 部署集 ID 列表。取值可以由多個部署集 ID 組成一個 JSON 數(shù)組,格式為 | ["ds-bp67acfmxazb4ph****", "ds-bp67acfmxazb4pi****", … "ds-bp67acfmxazb4pj****"] |
NetworkType | string | 否 | 說明
該參數(shù)已廢棄。
| null |
Strategy | string | 否 | 部署策略。取值范圍:
| Availability |
DeploymentSetName | string | 否 | 部署集名稱。長度為 2~128 個英文或中文字符。必須以大小字母或中文開頭,不能 | testDeploymentSetName |
Granularity | string | 否 | 說明
該參數(shù)已廢棄。
| null |
Domain | string | 否 | 說明
該參數(shù)已廢棄。
| null |
返回參數(shù)
示例
正常返回示例
JSON
格式
{
"PageSize": 1,
"PageNumber": 1,
"RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
"TotalCount": 1,
"RegionId": "cn-hangzhou",
"DeploymentSets": {
"DeploymentSet": [
{
"CreationTime": "2021-12-07T06:01:46Z",
"Strategy": "LooseDispersion",
"DeploymentSetId": "ds-bp67acfmxazb4ph****",
"DeploymentStrategy": "Availability",
"DeploymentSetDescription": "testDeploymentSetDescription",
"Domain": "default",
"GroupCount": 3,
"Granularity": "host",
"DeploymentSetName": "testDeploymentSetName",
"InstanceAmount": 3,
"InstanceIds": {
"InstanceId": [
"i-bp67acfmxazb4ph****"
]
},
"Capacities": {
"Capacity": [
{
"ZoneId": "cn-hangzhou-i",
"UsedAmount": 2,
"AvailableAmount": 18
}
]
}
}
]
}
}
錯誤碼
HTTP status code | 錯誤碼 | 錯誤信息 | 描述 |
---|---|---|---|
403 | InvalidDeploymentSetIds.TooManyInput | The parameter DeploymentSets size should less than 100. | 指定的 DeploymentSets 數(shù)量大于 100。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內(nèi)容概要 | 操作 |
---|---|---|
2022-01-17 | OpenAPI 錯誤碼發(fā)生變更、OpenAPI 返回結(jié)構(gòu)發(fā)生變更 | 查看變更詳情 |