全部产品
Search
文档中心

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

更新时间:Dec 06, 2024

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

调试

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

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
ecs:DescribeDeploymentSetsget
*DeploymentSet
acs:ecs:{#regionId}:{#accountId}:deploymentset/*

请求参数

名称类型必填描述示例值
RegionIdstring

部署集所属地域 ID。您可以调用 DescribeRegions 查看最新的阿里云地域列表。

cn-hangzhou
PageNumberinteger

部署集列表的页码。

起始值为 1。

默认值为 1。

1
PageSizeinteger

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

最大值为 50。

默认值为 10。

10
DeploymentSetIdsstring

部署集 ID 列表。取值可以由多个部署集 ID 组成一个 JSON 数组,格式为["ds-xxxxxxxxx", "ds-yyyyyyyyy", … "ds-zzzzzzzzz"]。最多支持 100 个 ID,ID 之间用半角逗号(,)隔开。

["ds-bp67acfmxazb4ph****", "ds-bp67acfmxazb4pi****", … "ds-bp67acfmxazb4pj****"]
NetworkTypestring
说明 该参数已废弃。
null
Strategystring

部署策略。取值范围:

  • Availability:高可用策略。
  • AvailabilityGroup:部署集组高可用策略。
Availability
DeploymentSetNamestring

部署集名称。长度为 2~128 个英文或中文字符。必须以大小字母或中文开头,不能以 http://https://开头。可以包含数字、半角冒号(:)、下划线(_)或者短划线(-)。

testDeploymentSetName
Granularitystring
说明 该参数已废弃。
null
Domainstring
说明 该参数已废弃。
null

返回参数

名称类型描述示例值
object
PageSizeinteger

设置的每页行数。

1
PageNumberinteger

部署集列表的页数。

1
RequestIdstring

请求 ID。

473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
TotalCountinteger

查询到的部署集总数。

1
RegionIdstring

部署集所处的地域 ID。

cn-hangzhou
DeploymentSetsarray<object>

由 DeploymentSet 组成的数组格式,返回部署集详细信息。

DeploymentSetobject
CreationTimestring

部署集的创建时间。

2021-12-07T06:01:46Z
Strategystring

部署策略。

LooseDispersion
DeploymentSetIdstring

部署集 ID。

ds-bp67acfmxazb4ph****
DeploymentStrategystring

部署策略。该返回值对应请求参数Strategy的值。

Availability
DeploymentSetDescriptionstring

部署集的描述信息。

testDeploymentSetDescription
Domainstring

部署域。

default
GroupCountinteger

部署集中的分组数量。

说明 当部署集策略为部署集组高可用策略(AvailabilityGroup)时,该返回值生效。
3
Granularitystring

部署粒度。

host
DeploymentSetNamestring

部署集名称。

testDeploymentSetName
InstanceAmountinteger

部署集内的实例数量。

3
InstanceIdsarray

部署集内的实例 ID 列表。

InstanceIdstring

实例 ID。

i-bp67acfmxazb4ph****
Capacitiesarray<object>

由 Capacity 组成的数组格式。仅当部署集内有存量 ECS 实例时提供返回结果,返回结果包含部署集可用区维度的容量信息。

Capacityobject
ZoneIdstring

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

cn-hangzhou-i
UsedAmountinteger

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

2
AvailableAmountinteger

该可用区内,还可以加入当前部署集的 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错误码错误信息描述
403InvalidDeploymentSetIds.TooManyInputThe parameter DeploymentSets size should less than 100.指定的 DeploymentSets 数量大于 100。

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

变更历史

变更时间变更内容概要操作
2022-01-17OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更查看变更详情