All Products
Search
Document Center

Elastic Compute Service:CreateDeploymentSet

Last Updated:Nov 14, 2024

Creates a deployment set in a region.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

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.
OperationAccess levelResource typeCondition keyAssociated operation
ecs:CreateDeploymentSetcreate
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

Creates a deployment set in a specific region.

cn-hangzhou
OnUnableToRedeployFailedInstancestringNo

The region ID of the deployment set. You can call the DescribeRegions operation to query the most recent list of regions.

CancelMembershipAndStart
DescriptionstringNo

The emergency solution to use in the situation where instances in the deployment set cannot be evenly distributed to different zones due to resource insufficiency after the instances failover. Valid values:

  • CancelMembershipAndStart: removes the instances from the deployment set and starts the instances immediately after they are failed over.
  • KeepStopped: leaves the instances in the Stopped state and starts them after resources are replenished.

Default value: CancelMembershipAndStart.

testDescription
ClientTokenstringNo

The description of the deployment set. The description must be 2 to 256 characters in length and cannot start with http:// or https://.

123e4567-e89b-12d3-a456-426655440000
DeploymentSetNamestringNo

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 http:// or https://. The name can contain digits, letters, colons (:), underscores (_), and hyphens (-).

testDeploymentSetName
DomainstringNo
Note This parameter is deprecated.
Default
GranularitystringNo
Note This parameter is deprecated.
host
StrategystringNo

The deployment strategy. Valid values:

  • Availability: high availability strategy
  • AvailabilityGroup: high availability group strategy
  • LowLatency: low latency strategy

Default value: Availability.

Availability
GroupCountlongNo

The deployment strategy. Valid values:

  • Availability: high availability strategy.
  • AvailabilityGroup: high availability group strategy.

Default value: Availability.

1

Response parameters

ParameterTypeDescriptionExample
object
DeploymentSetIdstring

The ID of the deployment set.

ds-bp1frxuzdg87zh4pzq****
RequestIdstring

The ID of the request.

473469C7-AA6F-4DC5-B3DB-A3DC0DE3****

Examples

Sample success responses

JSONformat

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

Error codes

HTTP status codeError codeError messageDescription
400MissingParameterThe input parameter RegionId that is mandatory for processing this request is not supplied.-
400InvalidDeploymentSetName.MalformedSpecified deployment set name is not valid.The specified DeploymentSetName parameter is invalid.
400InvalidDescription.MalformedThe 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://.
400InvalidParameter.DomainThe specified parameter Domain is not valid.The specified Domain parameter is invalid.
400InvalidParameter.StrategyThe specified parameter Strategy is not valid.-
400InvalidParameter.granularityThe specified parameter Granularity is not valid.The specified Granularity parameter is invalid.
400DependencyViolation.domain.granularityThe DeploymentSet domain and granularity is violation.The specified Domain and Granularity parameters do not correspond to each other.
400DependencyViolation.strategy.granularityThe DeploymentSet strategy and granularity is violation.The DeploymentSet strategy conflicts with granularity.
400DeploymentSet.GroupQuotaFullThe 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.
400InvalidParameter.GroupCountThe specified parameter "GroupCount" is not valid.-
400InvalidZoneId.NotFoundThe zoneId provided does not exist in our records.The specified zone ID does not exist.
400QuotaExceed.DeploymentSetThe deploymentSet quota is full.-

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

Change history

Change timeSummary of changesOperation
2023-08-21The Error code has changedView Change Details
2022-06-10The Error code has changedView Change Details