调用DescribeDeploymentSets接口,并可以指定DeploymentSetIds、Strategy、DeploymentSetName等参数,查询一个或多个部署集的详细信息。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
当前API暂无授权信息透出。
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
RegionId | string | 是 | 部署集所属地域 ID。您可以调用 DescribeRegions 查看最新的阿里云地域列表。 | cn-hangzhou |
PageNumber | integer | 否 | 部署集列表的页码。 起始值为 1。 默认值为 1。 | 1 |
PageSize | integer | 否 | 分页查询时设置的每页行数。 最大值为 50。 默认值为 10。 | 10 |
DeploymentSetIds | string | 否 | 部署集 ID 列表。取值可以由多个部署集 ID 组成一个 JSON 数组,格式为 | ["ds-bp67acfmxazb4ph****", "ds-bp67acfmxazb4pi****", … "ds-bp67acfmxazb4pj****"] |
NetworkType | string | 否 | 说明
该参数已废弃。
| null |
Strategy | string | 否 | 部署策略。取值范围:
| Availability |
DeploymentSetName | string | 否 | 部署集名称。长度为 2~128 个英文或中文字符。必须以大小字母或中文开头,不能 | testDeploymentSetName |
Granularity | string | 否 | 说明
该参数已废弃。
| null |
Domain | string | 否 | 说明
该参数已废弃。
| null |
返回参数
示例
正常返回示例
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 数量大于 100。 |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2022-01-17 | OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |