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

Describes 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 ID of the region where the deployment set is located. You can call DescribeRegions to view the latest list of Alibaba Cloud regions.	cn-hangzhou
PageNumber	integer	No	The page number. Starts at 1. Default value: 1.	1
PageSize	integer	No	The number of entries per page. Maximum value: 50. Default value: 10.	10
DeploymentSetIds	string	No	The IDs of the deployment sets. The value can be a JSON array that consists of up to 100 deployment set IDs. Sample format: `["ds-xxxxxxxxx", "ds-yyyyyyyyy", … "ds-zzzzzzzzz"]`.	["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-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 letters, digits, colons (:), underscores (_), periods (.), and 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: Ensures that the instances in the deployment set are deployed on different hosts. sw: Ensures that the instances in the deployment set are deployed on different switches. rack: Ensures that the instances in the deployment set are deployed on different racks. Default value: host.	host

Response elements

Element	Type	Description	Example
	object
PageSize	integer	The number of entries returned 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 deployment sets.	5
RegionId	string	The ID of the region.	cn-hangzhou
DeploymentSets	object
DeploymentSet	array<object>	An array of deployment sets.
	array<object>
CreationTime	string	The creation time of the deployment set.	2021-12-07T06:01:46Z
Strategy	string	The deployment strategy.	Availability
DeploymentSetId	string	The ID of the deployment set.	ds-bp67acfmxazb4ph****
AccountId	integer	The ID of the Alibaba Cloud account.	1732*******734
DeploymentStrategy	string	The deployment strategy. This value matches the value of the request parameter `Strategy`.	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 parameter is returned only when the deployment strategy is the 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	A list of instance IDs in the deployment set.
	string	The instance ID.	i-bp67acfmxazb4ph****
Capacities	object
Capacity	array<object>	The capacity information for each zone that contains instances of the deployment set. This parameter is returned only when the deployment set contains instances.
	object
ZoneId	string	The ID of a zone that contains instances from the deployment set.	cn-hangzhou-i
UsedAmount	integer	The number of instances from the deployment set in this zone.	2
AvailableAmount	integer	The number of instances that can be added to the deployment set in the zone.	18
Type	string	The deployment granularity.	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.