Query deployment set information with DescribeDeploymentSets - Elastic Compute Service - Alibaba Cloud - Elastic Compute Service

Queries the details of one or more deployment sets.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

ecs:DescribeDeploymentSets

get

*DeploymentSet

acs:ecs:{#regionId}:{#accountId}:deploymentset/*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the deployment set. You can call DescribeRegions to query the most recent region list.	cn-hangzhou
PageNumber	integer	No	The page number of the deployment set list. Minimum value: 1. Default value: 1.	1
PageSize	integer	No	The number of entries per page for the paged query. 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 multiple deployment set IDs in the format of `["ds-xxxxxxxxx", "ds-yyyyyyyyy", … "ds-zzzzzzzzz"]`. A maximum of 100 IDs are supported. Separate multiple IDs with commas (,).	["ds-bp67acfmxazb4ph**", "ds-bp67acfmxazb4pi", … "ds-bp67acfmxazb4pj**"]
NetworkType	string	No	Note This parameter is deprecated.	null
Strategy	string	No	The deployment strategy. Valid values: Availability: high availability strategy. AvailabilityGroup: high availability group strategy. LowLatency: low network latency strategy.	Availability
DeploymentSetName	string	No	The name of the deployment set. The name must be 2 to 128 characters in length and can contain characters that are categorized as letter in Unicode, including English letters, Chinese characters, and digits. The name can also contain colons (:), underscores (_), periods (.), or hyphens (-).	testDeploymentSetName
Granularity	string	No	Note This parameter is deprecated.	null
Domain	string	No	Note This parameter is deprecated.	null
Type	string	No	The deployment type. Valid values: host: physical machine sw: vSwitch rack: rack Default value: host.	host

Response elements

Element	Type	Description	Example
	object
PageSize	integer	The number of entries per page.	1
PageNumber	integer	The page number of the deployment set list.	1
RequestId	string	The request ID.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
TotalCount	integer	The total number of queried deployment sets.	5
RegionId	string	The region ID of the deployment set.	cn-hangzhou
DeploymentSets	object
DeploymentSet	array<object>	The details of the deployment sets. The value is an array that consists of DeploymentSet objects.
	array<object>
CreationTime	string	The time when the deployment set was created. The time is displayed in ISO 8601 format in UTC.	2021-12-07T06:01:46Z
Strategy	string	The deployment strategy.	Availability
DeploymentSetId	string	The ID of the deployment set.	ds-bp67acfmxazb4ph****
AccountId	integer	The Alibaba Cloud account ID.	1732*******734
DeploymentStrategy	string	The deployment strategy. This response parameter corresponds to the value 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 groups in the deployment set. Note This response parameter takes effect only when the deployment set strategy is the high availability group strategy (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	object
InstanceId	array	The instance IDs of instances in the deployment set.
	string	The instance ID.	i-bp67acfmxazb4ph****
Capacities	object
Capacity	array<object>	The capacity information of the deployment set at the zone level. The value is an array that consists of Capacity objects. This parameter is returned only when the deployment set contains existing ECS instances.
	object
ZoneId	string	The zone ID. Only the zone IDs of existing ECS instances in the deployment set are returned.	cn-hangzhou-i
UsedAmount	integer	The number of ECS instances in the deployment set that belong to the zone.	2
AvailableAmount	integer	The number of ECS instances that can be added to the deployment set in the zone.	18
Type	string	The deployment type.	host
Affinity	integer	The affinity level of the deployment set.	3

Examples

Success response

JSON format

{
  "PageSize": 1,
  "PageNumber": 1,
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "TotalCount": 5,
  "RegionId": "cn-hangzhou",
  "DeploymentSets": {
    "DeploymentSet": [
      {
        "CreationTime": "2021-12-07T06:01:46Z",
        "Strategy": "Availability",
        "DeploymentSetId": "ds-bp67acfmxazb4ph****",
        "AccountId": 0,
        "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
            }
          ]
        },
        "Type": "host",
        "Affinity": 3
      }
    ]
  }
}

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.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.