文档中心

云服务器

请输入

部署集

DescribeDeploymentSets - 查询部署集列表

调用 DescribeDeploymentSets 接口查询部署集的属性。

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

下方仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

Action string 必选示例值：DescribeDeploymentSets

要执行的操作，取值：DescribeDeploymentSets。

Version string 必选示例值：2020-04-01

API的版本，取值：2020-04-01。

DeploymentSetIds.N string[] 可选示例值：DeploymentSetIds.1=dps-yc1o9aahks5m57nk****&DeploymentSetIds.2=dps-ybr1vulgy87grbt6****

部署集ID。

您可以调用DescribeDeploymentSets查询部署集ID。

参数 - N：表示部署集的序号，取值范围：1～100。

多个 DeploymentSetId之间用&分隔。

DeploymentSetName string 可选示例值：testDeploymentSet

部署集名称。

不能以数字、中划线、下划线开头。

只能包含中文、字母、数字、下划线和中划线。

长度限制在1～128之间。

Granularity string 可选示例值：host

部署粒度，取值：

host：物理机

rack：机架

switch：交换机

MaxResults integer 可选示例值：10

分页查询时设置的每页行数。

最大值：100

默认值：10

NextToken string 可选示例值：--

分页查询凭证，用于标记分页的位置，初次调用该接口时无需设置。下次查询时，取值为上一次API调用返回的NextToken参数值。

Strategy string 可选示例值：Availability

部署策略，取值：

Availability：高可用策略。

AvailabilityGroup：部署集组高可用策略。

返回参数

下方仅列出本接口特有的返回参数。更多信息请参见返回结构。

DeploymentSets object[] 示例值：--

部署集详情。

Capacities object[] 示例值：--

部署集可用区维度的容量信息，仅当部署集内有存量ECS实例时返回该参数。

AvailableCount integer 示例值：3

该可用区内，还可以加入当前部署集的ECS实例数量。

UsedCount integer 示例值：2

部署集内属于该可用区的ECS实例数量。

ZoneId string 示例值：cn-beijing-a

可用区ID。只返回部署集内存量ECS实例所属的可用区ID。

CreatedAt string 示例值：2021-06-28T18:29:38+08:00

部署集的创建时间。

DeploymentSetDescription string 示例值：容灾部署集

部署集的描述信息。

DeploymentSetId string 示例值：dps-yc34mry3yifvojpmz3s3

部署集ID。

DeploymentSetName string 示例值：testDeploymentSetName

部署集名称。

Granularity string 示例值：host

部署粒度。

GroupCount integer 示例值：3

部署集组数量。

仅Strategy取值为AvailabilityGroup时，返回该参数。

InstanceAmount integer 示例值：1

部署集内的ECS实例数量。

InstanceIds string[] 示例值：["i-3tigy72q3u3vj0x2****","i-3tigy72q3u3vj0x2****"]

部署集内的ECS实例ID列表。

Strategy string 示例值：Availability

部署策略。

NextToken string 示例值：bHpwdXJja2RxemU1eG5sb3NzdGcW1-RCEq******

本次调用返回的查询凭证值，返回为空表示该页为末页。

请求示例

GET /?Action=DescribeDeploymentSets&Version=2020-04-01&DeploymentSetIds.1=dps-yc1o9aahks5m57nk**** HTTP/1.1​
Host: ecs.cn-beijing.volcengineapi.com​
Region: cn-beijing​
ServiceName: ecs​

返回示例

{​
    "ResponseMetadata": {​
        "RequestId": "2021110417394001022514606307*****",​
        "Action": "DescribeDeploymentSets",​
        "Version": "2020-04-01",​
        "Service": "ecs",​
        "Region": "cn-beijing"​
    },​
    "Result": {​
        "DeploymentSets": [​
            {​
                "CreatedAt": "2021-11-25T15:12:58+08:00",​
                "DeploymentSetDescription": "",​
                "DeploymentSetId": "dps-yc1o9aahks5m57nk****",​
                "DeploymentSetName": "testDeploymentSet",​
                "Strategy": "Availability",​
                "Granularity": "host",​
                "InstanceAmount": 1,​
                "InstanceIds": [​
                i-3tigy72q3u3vj0x2****​
                ],​
                "Capacities": [​
                    {​
                        "ZoneId": "cn-beijing-a",​
                        "UsedCount": 1,​
                        "AvailableCount": 4​
                    }​
                ]​
            }​
        ],​
        "NextToken":"bHpwdXJja2RxemU1eG5sb3NzdGcW1-RCEq******"​
    }​
}​

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码	错误码	错误信息	说明
400	InvalidArgument	The specified argument is invalid.	指定的参数不合法。
400	LimitExceeded.MaximumDeploymentSetIds	You've reached the limit on the number of DeploymentSetIds that you can set.	指定的DeploymentSets数量超过最大限制。
500	InternalError	An internal error has occurred.	内部错误，请重试。如果多次尝试失败，请提交工单。

最近更新时间：2026.09.10 11:18:09

这个页面对您有帮助吗？

有用

无用