All Products
Search
Document Center

Elastic Compute Service:CreateDeploymentSet

Last Updated:Feb 04, 2024

Creates a deployment set in a specific region.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

There is currently no authorization information disclosed in the API.

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 client token that is used to ensure the idempotence of the request. You can use the client to generate a client token. Make sure that a unique client token is used for each request. The ClientToken value can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see How to ensure idempotence.

testDeploymentSetName
DomainstringNo

The name of the deployment set. The name must be 2 to 128 characters in length, It must start with a letter and cannot start with http:// or https://. It can contain letters, digits, colons (:), underscores (_), and hyphens (-).

Default
GranularitystringNo

The deployment domain. Set the value to Default.

Default: Instances in the deployment set are distributed only within the current zone.

host
StrategystringNo

The deployment granularity. Set the value to host.

host: Instances in the deployment set are dispersed at the granularity of hosts.

Availability
GroupCountlongNo

The deployment strategy. Valid values:

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

Default value: Availability.

1

Response parameters

ParameterTypeDescriptionExample
The current API has no return parameters

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.The RegionId parameter is required.
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 validThe specified Strategy parameter is invalid.
400InvalidParameter.GroupCountThe specified parameter GroupCount 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.QUOTA_FULLThe deploymentSet quota is fullThe maximum number of deployment sets has been reached. Reduce the number of deployment sets.
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.
404InvalidZoneId.NotFoundThe ZoneId provided does not exist in our records.The specified zone ID does not exist.

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

Change history

Change timeSummary of changesOperation
2023-08-21The Error code has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    Error Codes 400 change
    delete Error Codes: 404
2022-06-10The Error code has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    Error Codes 400 change
    delete Error Codes: 404