Call the DescribeDeploymentSets operation to query deployment set attributes.

Debugging

API Explorer

You can initiate calls online through API Explorer without paying attention to the signature generation process and quickly obtain the call results.

Go to debug

Request parameters

Only the request parameters specific to this operation and some common parameters are listed below. For more information, refer to Common parameters.

Action string required Sample value: DescribeDeploymentSets

The action that you want to perform. Value: DescribeDeploymentSets.

Version string required Sample value: 2020-04-01

The version of the API. Valid value: 2020-04-01.

DeploymentSetIds.N string[] Optional Sample value: DeploymentSetIds.1=dps-yc1o9aahks5m57nk****&DeploymentSetIds.2=dps-ybr1vulgy87grbt6****

The ID of the deployment set.

You can call DescribeDeploymentSets to query deployment set IDs.

Argument - N: specifies the serial number of the deployment set. Valid range: 1-100.

Separate multiple deployment set IDs with &.

DeploymentSetName string Optional Sample value: testDeploymentSet

The name of the deployment set.

Cannot start with a number, a hyphen (-), or an underscore (_).

Only Chinese, letters, numbers, underscores and hyphens are allowed.

The length limit is 1 to 128 characters.

Granularity string Optional Sample value: host

The deployment granularity. Valid values:

host: physical machine

rack: rack

switch: switch

MaxResults integer Optional Sample value: 10

The number of entries returned on each page in a pagination query.

Maximum value: 100

Default value: 10

NextToken string Optional Sample value: --

Pagination token marking the query position. Omit this parameter for initial API requests. In the next query, set the NextToken parameter to the value returned by the previous API call.

Strategy string Optional Sample value: Availability

The deployment policy. Valid values:

Availability: Availability policy.

AvailabilityGroup: Availability Group policy.

Response parameters

Only the response parameters specific to this operation are listed below. For more information, refer to the response structure.

DeploymentSets object[] Sample value: --

The details of the deployment set.

Capacities object[] Sample value: --

The capacity information of the deployment set at the availability zone dimension. This parameter is returned only when one or more ECS instances are deployed within the deployment set.

AvailableCount integer Sample value: 3

The number of ECS instances in the availability zone that can be deployed within the deployment set.

UsedCount integer Sample value: 2

The number of ECS instances in the deployment set that belong to the availability zone.

ZoneId string Sample value: cn-beijing-a

Availability zone ID. Only the ID of the availability zone of an ECS instance deployed within the deployment set is returned.

CreatedAt string Sample value: 2021-06-28T18:29:38+08:00

The creation time of the deployment set.

DeploymentSetDescription string Sample value: Deployment set for disaster recovery

The description of the deployment set.

DeploymentSetId string Sample value: dps-yc34mry3yifvojpmz3s3

The ID of the deployment set.

DeploymentSetName string Sample value: testDeploymentSetName

The name of the deployment set.

Granularity string Sample value: host

The deployment granularity.

GroupCount integer Sample value: 3

The number of deployment set groups.

This parameter is returned only when the value of Strategy is AvailabilityGroup.

InstanceAmount integer Sample value: 1

The number of ECS instances in the deployment set.

InstanceIds string[] Sample value: ["i-3tigy72q3u3vj0x2****","i-3tigy72q3u3vj0x2****"]

The ID list of ECS instances in the deployment set.

Strategy string Sample value: Availability

The deployment policy.

NextToken string Sample value: bHpwdXJja2RxemU1eG5sb3NzdGcW1-RCEq******

The pagination token returned by this call. If this value is empty, the current page is the last page.

Sample request

Sample response

Error codes

The table below lists the business-related error codes of the operation. For more information, refer to Common error codes.

Status code	Error code	Error message	Description
400	InvalidArgument	The specified argument is invalid.	The specified parameter is invalid.
400	LimitExceeded.MaximumDeploymentSetIds	You've reached the limit on the number of DeploymentSetIds that you can set.	The number of specified deployment sets exceeds the upper limit.
500	InternalError	An internal error has occurred.	An internal error occurred. Try again. If multiple attempts fail, submit a ticket.

Elastic Compute Service