DescribeDeploymentSets - Elastic Compute Service - Alibaba Cloud Documentation Center

Queries the attributes of one or more deployment sets.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the deployment set. You can call the DescribeRegions operation to query the most recent region list.	cn-hangzhou
PageNumber	integer	No	The number of the page to return. Pages start from page 1. Default value: 1.	1
PageSize	integer	No	The number of entries to return on each page. Maximum value: 50. Default value: 10.	10
DeploymentSetIds	string	No	The IDs of deployment sets. The value can be a JSON array that consists of up to 100 deployment set IDs in the format of `["ds-xxxxxxxxx", "ds-yyyyyyyyy", … "ds-zzzzzzzzz"]`. Separate multiple deployment set IDs with commas (,).	["ds-bp67acfmxazb4ph**", "ds-bp67acfmxazb4pi", … "ds-bp67acfmxazb4pj**"]
NetworkType	string	No	Note The parameter is deprecated.	null
Strategy	string	No	The deployment strategy. Valid values: Availability: high availability strategy. AvailabilityGroup: high availability group strategy.	Availability
DeploymentSetName	string	No	The name of the deployment set. The name must be 2 to 128 characters in length. It must start with a letter and cannot start with `http://` or `https://`. It can contain letters, digits, colons (:), underscores (_), and hyphens (-).	testDeploymentSetName
Granularity	string	No	Note The parameter is deprecated.	null
Domain	string	No	Note The parameter is deprecated.	null

Response parameters

Parameter	Type	Description	Example
	object
PageSize	integer	The number of entries returned per page.	1
PageNumber	integer	The page number of the returned page.	1
RequestId	string	The ID of the request.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
TotalCount	integer	The total number of deployment sets returned.	1
RegionId	string	The region ID of the deployment set.	cn-hangzhou
DeploymentSets	object []	Details about the deployment sets.
CreationTime	string	The time when the deployment set was created.	2021-12-07T06:01:46Z
Strategy	string	The deployment strategy.	LooseDispersion
DeploymentSetId	string	The ID of the deployment set.	ds-bp67acfmxazb4ph****
DeploymentStrategy	string	The deployment strategy. The value of this response parameter is that of the `Strategy` request parameter.	Availability
DeploymentSetDescription	string	The description of the deployment set.	testDeploymentSetDescription
Domain	string	The deployment domain.	default
GroupCount	integer	The number of deployment set groups in the deployment set. Note This parameter is valid only when the Strategy request parameter is set to AvailabilityGroup.	3
Granularity	string	The deployment granularity.	host
DeploymentSetName	string	The name of the deployment set.	testDeploymentSetName
InstanceAmount	integer	The number of instances in the deployment set.	3
InstanceIds	array	The IDs of the instances in the deployment set.
	string	The ID of the instance in the deployment set.	i-bp67acfmxazb4ph****
Capacities	object []	Details of the capacities of the deployment set. This parameter is valid only when the deployment set contains Elastic Compute Service (ECS) instances. The value contains the capacities of the deployment set in different zones.
ZoneId	string	The ID of the zone. Only the zone IDs of existing ECS instances in the deployment set are returned.	cn-hangzhou-i
UsedAmount	integer	The number of ECS instances that belong to the zone in the deployment set.	2
AvailableAmount	integer	The number of ECS instances that can be added to the deployment set within the zone.	18

Examples

Sample success responses

JSONformat

{
  "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
            }
          ]
        }
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
403	InvalidDeploymentSetIds.TooManyInput	The parameter DeploymentSets size should less than 100.	The number of specified deployment sets exceeds 100.

For a list of error codes, visit the Service error codes.

Change history

Change time

Summary of changes

Operation

2022-01-17

The Error code has changed. The response structure of the API has changed

see changesets

Change item	Change content
Error Codes	The Error code has changed.
	delete Error Codes: 403
Output Parameters	The response structure of the API has changed.