Queries the details of one or more deployment sets. When you call this operation, you can specify parameters, such as DeploymentSetIds, Strategy, and DeploymentSetName, in the request.
Debugging
Authorization information
The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action
policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:
- Operation: the value that you can use in the Action element to specify the operation on a resource.
- Access level: the access level of each operation. The levels are read, write, and list.
- Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level,
All Resources
is used in the Resource type column of the operation.
- Condition Key: the condition key that is defined by the cloud service.
- Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
Operation | Access level | Resource type | Condition key | Associated operation |
---|---|---|---|---|
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 the DescribeRegions operation to query the most recent region list. | cn-hangzhou |
PageNumber | integer | No | The page number. Pages start from page 1. Default value: 1. | 1 |
PageSize | integer | No | The number of entries per page. Valid values: 1 to 50. Default value: 10. | 10 |
DeploymentSetIds | string | No | The IDs of deployment sets. The value can be a JSON array that consists of deployment set IDs in the format of | ["ds-bp67acfmxazb4ph****", "ds-bp67acfmxazb4pi****", … "ds-bp67acfmxazb4pj****"] |
NetworkType | string | No | Note
This parameter is deprecated.
| null |
Strategy | string | No | The deployment strategy. Valid values:
| Availability |
DeploymentSetName | string | No | The name of the deployment set. The name must be 2 to 128 characters in length. The name must start with a letter and cannot start with | testDeploymentSetName |
Granularity | string | No | Note
This parameter is deprecated.
| null |
Domain | string | No | Note
This parameter is deprecated.
| null |
Response parameters
Examples
Sample success responses
JSON
format
{
"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 | View Change Details |