DescribeDeploymentSets - 查询一个或多个部署集的属性列表 - 云服务器 ECS

调用DescribeDeploymentSets接口，并可以指定DeploymentSetIds、Strategy、DeploymentSetName等参数，查询一个或多个部署集的详细信息。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
ecs:DescribeDeploymentSets	get	DeploymentSet `acs:ecs:{#regionId}:{#accountId}:deploymentset/`	无	无

请求参数

名称	类型	必填	描述	示例值
RegionId	string	是	部署集所属地域 ID。您可以调用 DescribeRegions 查看最新的阿里云地域列表。	cn-hangzhou
PageNumber	integer	否	部署集列表的页码。起始值为 1。默认值为 1。	1
PageSize	integer	否	分页查询时设置的每页行数。最大值为 50。默认值为 10。	10
DeploymentSetIds	string	否	部署集 ID 列表。取值可以由多个部署集 ID 组成一个 JSON 数组，格式为`["ds-xxxxxxxxx", "ds-yyyyyyyyy", … "ds-zzzzzzzzz"]`。最多支持 100 个 ID，ID 之间用半角逗号（,）隔开。	["ds-bp67acfmxazb4ph**", "ds-bp67acfmxazb4pi", … "ds-bp67acfmxazb4pj**"]
NetworkType	string	否	说明该参数已废弃。	null
Strategy	string	否	部署策略。取值范围： Availability：高可用策略。 AvailabilityGroup：部署集组高可用策略。	Availability
DeploymentSetName	string	否	部署集名称。长度为 2~128 个英文或中文字符。必须以大小字母或中文开头，不能`以 http://`或`https://`开头。可以包含数字、半角冒号（:）、下划线（_）或者短划线（-）。	testDeploymentSetName
Granularity	string	否	说明该参数已废弃。	null
Domain	string	否	说明该参数已废弃。	null

返回参数

名称	类型	描述	示例值
	object
PageSize	integer	设置的每页行数。	1
PageNumber	integer	部署集列表的页数。	1
RequestId	string	请求 ID。	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
TotalCount	integer	查询到的部署集总数。	1
RegionId	string	部署集所处的地域 ID。	cn-hangzhou
DeploymentSets	array<object>	由 DeploymentSet 组成的数组格式，返回部署集详细信息。
DeploymentSet	object
CreationTime	string	部署集的创建时间。	2021-12-07T06:01:46Z
Strategy	string	部署策略。	LooseDispersion
DeploymentSetId	string	部署集 ID。	ds-bp67acfmxazb4ph****
DeploymentStrategy	string	部署策略。该返回值对应请求参数`Strategy`的值。	Availability
DeploymentSetDescription	string	部署集的描述信息。	testDeploymentSetDescription
Domain	string	部署域。	default
GroupCount	integer	部署集中的分组数量。说明当部署集策略为部署集组高可用策略（AvailabilityGroup）时，该返回值生效。	3
Granularity	string	部署粒度。	host
DeploymentSetName	string	部署集名称。	testDeploymentSetName
InstanceAmount	integer	部署集内的实例数量。	3
InstanceIds	array	部署集内的实例 ID 列表。
InstanceId	string	实例 ID。	i-bp67acfmxazb4ph****
Capacities	array<object>	由 Capacity 组成的数组格式。仅当部署集内有存量 ECS 实例时提供返回结果，返回结果包含部署集可用区维度的容量信息。
Capacity	object
ZoneId	string	可用区 ID。只返回部署集内存量 ECS 实例所属的可用区 ID。	cn-hangzhou-i
UsedAmount	integer	部署集内属于该可用区的 ECS 实例数量。	2
AvailableAmount	integer	该可用区内，还可以加入当前部署集的 ECS 实例数量。	18

示例

正常返回示例

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 返回结构发生变更	查看变更详情