DescribeDeploymentSets - 云服务器 ECS

调试

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

请求参数

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

返回数据

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

示例

请求示例

https://ecs.aliyuncs.com/?Action=DescribeDeploymentSets
&RegionId=cn-hangzhou
&PageSize=1
&<公共请求参数>

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeDeploymentSetsResponse>
    <DeploymentSets>
        <DeploymentSet>
            <CreationTime>2021-12-07T06:01:46Z</CreationTime>
            <Granularity>host</Granularity>
            <DeploymentSetDescription>testDeploymentSetDescription</DeploymentSetDescription>
            <Domain>default</Domain>
            <InstanceIds>
                <InstanceId>i-bp67acfmxazb4ph****</InstanceId>
                <InstanceId>i-bp67acfmxazb4pi****</InstanceId>
                <InstanceId>i-bp67acfmxazb4pj****</InstanceId>
            </InstanceIds>
            <InstanceAmount>3</InstanceAmount>
            <Strategy>LooseDispersion</Strategy>
            <DeploymentSetName>testDeploymentSetName</DeploymentSetName>
            <DeploymentStrategy>Availability</DeploymentStrategy>
            <DeploymentSetId>ds-bp67acfmxazb4ph****</DeploymentSetId>
            <capacities>
                <Capacity>
                    <UsedAmount>1</UsedAmount>
                    <ZoneId>cn-hangzhou-h</ZoneId>
                    <AvailableAmount>19</AvailableAmount>
                </Capacity>
                <Capacity>
                    <UsedAmount>2</UsedAmount>
                    <ZoneId>cn-hangzhou-i</ZoneId>
                    <AvailableAmount>18</AvailableAmount>
                </Capacity>
            </capacities>
        </DeploymentSet>
    </DeploymentSets>
    <PageNumber>1</PageNumber>
    <TotalCount>1</TotalCount>
    <PageSize>1</PageSize>
    <RegionId>cn-hangzhou</RegionId>
    <RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E</RequestId>
</DescribeDeploymentSetsResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "DeploymentSets" : {
    "DeploymentSet" : {
      "CreationTime" : "2021-12-07T06:01:46Z",
      "Granularity" : "host",
      "DeploymentSetDescription" : "testDeploymentSetDescription",
      "Domain" : "default",
      "InstanceIds" : {
        "InstanceId" : [ "i-bp67acfmxazb4ph****", "i-bp67acfmxazb4pi****", "i-bp67acfmxazb4pj****" ]
      },
      "InstanceAmount" : 3,
      "Strategy" : "LooseDispersion",
      "DeploymentSetName" : "testDeploymentSetName",
      "DeploymentStrategy" : "Availability",
      "DeploymentSetId" : "ds-bp67acfmxazb4ph****",
      "capacities" : {
        "Capacity" : [ {
          "UsedAmount" : 1,
          "ZoneId" : "cn-hangzhou-h",
          "AvailableAmount" : 19
        }, {
          "UsedAmount" : 2,
          "ZoneId" : "cn-hangzhou-i",
          "AvailableAmount" : 18
        } ]
      }
    }
  },
  "PageNumber" : 1,
  "TotalCount" : 1,
  "PageSize" : 1,
  "RegionId" : "cn-hangzhou",
  "RequestId" : "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E"
}

错误码

HttpCode	错误码	错误信息	描述
403	InvalidDeploymentSetIds.TooManyInput	The parameter DeploymentSets size should less than 100.	指定的 DeploymentSets 数量大于 100。

访问错误中心查看更多错误码。