You need to enable JavaScript to run this app.
导航
云服务器
  • 文档首页
    • /
  • 云服务器

DescribeDeploymentSets

最近更新时间：2024.02.21 16:39:56

首次发布时间：2023.01.06 07:41:48

我的收藏

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

调试

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

请求参数

名称类型是否必填示例值描述
ActionString是DescribeDeploymentSets要执行的操作，取值：DescribeDeploymentSets。
VersionString是2020-04-01API的版本，取值：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之间。

Strategy

String

否

Availability

部署策略，取值：

  • Availability（默认）：高可用策略
  • AvailabilityGroup：部署集组高可用策略

Granularity

String

否

host

部署集粒度，取值：

  • host：物理机
  • rack：机架
  • switch：交换机

说明

当Strategy=Availability时需传入该参数。

MaxResults

Integer

否

10

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

  • 最大值：100

  • 默认值：10

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

返回数据

名称类型示例值描述
DeploymentSetsArray of Struct-部署集详情，具体请参见下表“ DeploymentSets 结构 ”。

NextToken

String

bHpwdXJja2RxemU1eG5sb3NzdGcW1-RCEq******

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

DeploymentSets 结构

名称类型示例值描述
CreatedAtString2021-07-26T21:55:12+08:00部署集的创建时间。
DeploymentSetDescriptionStringtesDeploymentDescription部署集描述。
DeploymentSetIdStringdps-yc1o9aahks5m57nk****部署集ID。
DeploymentSetNameStringtestDeploymentSet部署集名称。
StrategyStringAvailability部署策略。

Granularity

String

host

部署集粒度。
仅Strategy=AvailabilityGroup时，返回该参数。

GroupCount

Integer

3

部署集组数量。
仅Strategy=AvailabilityGroup时，返回该参数。

InstanceAmountInteger1部署集内的实例数量。
InstanceIdsList["i-3tigy72q3u3vj0x2****","i-3tigy72q3u3vj0x2****"]部署集内的实例ID列表。
CapacitiesArray of Struct-部署集所属可用区内的相关信息，仅当部署集内有存量实例时返回该参数，具体请参见下表“ Capacities 结构 ”。

Capacities 结构

名称类型示例值描述

ZoneId

String

cn-beijing-a

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

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

AvailableCount

Integer

4

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

请求示例

GET /?Action=DescribeDeploymentSets&Version=2020-04-01&DeploymentSetIds.1=dps-yc1o9aahks5m57nk**** HTTP/1.1
Host: open.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******"
    }
}

错误码

HttpCode错误码错误信息描述
400InvalidArgumentThe specified argument is invalid.指定的参数不合法。
400LimitExceeded.MaximumDeploymentSetIdsYou've reached the limit on the number of DeploymentSetIds that you can set.指定的部署集数量超过最大限制。
500InternalErrorAn internal error has occurred.内部错误，请重试。如果多次尝试失败，请提交工单。