Create a deployment set by calling the CreateDeploymentSet API - Elastic Compute Service - Alibaba Cloud - Elastic Compute Service

Creates a deployment set in a specified region.

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:CreateDeploymentSet

create

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The ID of the region for the deployment set. You can call the DescribeRegions operation to view the latest list of Alibaba Cloud regions.	cn-hangzhou
OnUnableToRedeployFailedInstance	string	No	The policy for an instance that fails to be redeployed after a failover due to insufficient resources. Valid values: CancelMembershipAndStart: Removes the instance from the deployment set and starts the instance immediately after failover. KeepStopped: Keeps the instance in the deployment set and in the Stopped state. Default value: CancelMembershipAndStart.	CancelMembershipAndStart
Description	string	No	The description of the deployment set. The description must be 2 to 256 characters long and cannot start with `http://` or `https://`.	testDescription
ClientToken	string	No	A client-generated token that you can use to ensure request idempotence. The token must be unique across requests. The ClientToken value must be an ASCII string of up to 64 characters. For more information, see How to ensure idempotence.	123e4567-e89b-12d3-a456-426655440000
DeploymentSetName	string	No	The name of the deployment set. The name must be 2 to 128 characters long and start with a letter. It can contain digits, colons (:), underscores (_), and hyphens (-). The name cannot start with `http://` or `https://`.	testDeploymentSetName
Domain	string	No	Note This parameter is deprecated.	null
Granularity	string	No	Note This parameter is deprecated.	null
Strategy	string	No	The deployment strategy. Valid values: Availability: High availability strategy. AvailabilityGroup: High availability strategy for deployment set groups. LowLatency: Low-latency strategy. Default value: Availability.	Availability
GroupCount	integer	No	The number of partitions in the deployment set group. Valid values: 1 to 7. Default value: 3. Note This parameter is valid only when `Strategy` is set to `AvailabilityGroup`.	1
Type	string	No	The deployment granularity. Valid values: host: Spreads instances across different hosts. sw: Spreads instances across different switches. rack: Spreads instances across different racks. Default value: host.	host
Affinity	integer	No	The affinity level of the deployment set. This level determines how instances are distributed within the set. The value must be an integer from 1 to 10. Default value: 1.	3

Response elements

Element	Type	Description	Example
	object
DeploymentSetId	string	The ID of the deployment set.	ds-bp1frxuzdg87zh4pzq****
RequestId	string	The ID of the request.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3****

Examples

Success response

JSON format

{
  "DeploymentSetId": "ds-bp1frxuzdg87zh4pzq****",
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****"
}

Error codes

HTTP status code	Error code	Error message	Description
400	MissingParameter	The input parameter RegionId that is mandatory for processing this request is not supplied.
400	InvalidDeploymentSetName.Malformed	Specified deployment set name is not valid.	The specified DeploymentSetName parameter is invalid.
400	InvalidDescription.Malformed	The specified parameter Description is not valid.	The resource description is invalid. The description must be 2 to 256 characters in length and cannot start with http:// or https://.
400	InvalidParameter.Domain	The specified parameter Domain is not valid.	The specified Domain parameter is invalid.
400	InvalidParameter.Strategy	The specified parameter Strategy is not valid.
400	InvalidParameter.granularity	The specified parameter Granularity is not valid.	The specified Granularity parameter is invalid.
400	DependencyViolation.domain.granularity	The DeploymentSet domain and granularity is violation.	The specified Domain and Granularity parameters do not correspond to each other.
400	DependencyViolation.strategy.granularity	The DeploymentSet strategy and granularity is violation.	The DeploymentSet strategy conflicts with granularity.
400	DeploymentSet.GroupQuotaFull	The deploymentSet group quota is full.	The maximum number of deployment set groups that can be created is exceeded. Reduce the number of deployment set groups to be created.
400	InvalidParameter.GroupCount	The specified parameter "GroupCount" is not valid.
400	InvalidZoneId.NotFound	The zoneId provided does not exist in our records.	The specified zone ID does not exist.
400	QuotaExceed.DeploymentSet	The deploymentSet quota is full.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.