All Products
Search
Document Center

Elastic Compute Service:CreateDeploymentSet

Last Updated:Jul 09, 2024

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 (-).

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 name of the deployment set. The name must be 2 to 128 characters in length and can contain Unicode characters under the Decimal Number category and the categories whose names contain Letter. The name can also contain colons (:), underscores (_), periods (.), 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
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.-
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