全部产品
Search
文档中心

云服务器 ECS:CreateDeploymentSet - 在指定的地域内创建一个部署集

更新时间:Dec 03, 2024

调用CreateDeploymentSet接口,并可以指定OnUnableToRedeployFailedInstance、DeploymentSetName、Strategy等参数,在指定的地域内创建一个部署集。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
ecs:CreateDeploymentSetcreate
*全部资源
*

请求参数

名称类型必填描述示例值
RegionIdstring

部署集所属地域 ID。您可以调用 DescribeRegions 查看最新的阿里云地域列表。

cn-hangzhou
OnUnableToRedeployFailedInstancestring

部署集内实例宕机迁移后,缺乏可供打散的实例库存的紧急处理方案。取值范围:

  • CancelMembershipAndStart:将实例移出部署集,宕机迁移后即刻启动实例。
  • KeepStopped:维持实例的部署集属性,实例保持停止状态。

默认值:CancelMembershipAndStart。

CancelMembershipAndStart
Descriptionstring

部署集描述信息。长度为 2~256 个英文或中文字符,不能以http://https://开头。

testDescription
ClientTokenstring

保证请求幂等性。从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken 只支持 ASCII 字符,且不能超过 64 个字符。更多信息,请参见如何保证幂等性

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

部署集名称。长度为 2~128 个英文或中文字符。必须以大小写字母或中文开头,不能以http://https://开头。可以包含数字、半角冒号(:)、下划线(_)或者短划线(-)。

testDeploymentSetName
Domainstring
说明 该参数已废弃。
null
Granularitystring
说明 该参数已废弃。
null
Strategystring

部署策略。取值范围:

  • Availability:高可用策略。

  • AvailabilityGroup:部署集组高可用策略。

  • LowLatency:网络低时延策略。

默认值:Availability。

Availability
GroupCountlong

为部署集组高可用策略设置分组数量。取值范围:1~7。

默认值:3。

说明 该参数仅当Strategy=AvailabilityGroup时生效。
1

返回参数

名称类型描述示例值
object
DeploymentSetIdstring

部署集 ID。

ds-bp1frxuzdg87zh4pzq****
RequestIdstring

请求 ID。

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

示例

正常返回示例

JSON格式

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

错误码

HTTP status code错误码错误信息描述
400MissingParameterThe input parameter RegionId that is mandatory for processing this request is not supplied.-
400InvalidDeploymentSetName.MalformedSpecified deployment set name is not valid.指定的参数 DeploymentSetName 不合法。
400InvalidDescription.MalformedThe specified parameter Description is not valid.指定的资源描述格式不合法。长度为 2-256 个字符,不能以 http:// 和 https:// 开头。
400InvalidParameter.DomainThe specified parameter Domain is not valid.指定的Domain参数不合法。
400InvalidParameter.StrategyThe specified parameter Strategy is not valid.指定的 Strategy 不合法。
400InvalidParameter.granularityThe specified parameter Granularity is not valid.指定的 Granularity 参数不合法。
400DependencyViolation.domain.granularityThe DeploymentSet domain and granularity is violation.部署集域与数据粒度冲突。
400DependencyViolation.strategy.granularityThe DeploymentSet strategy and granularity is violation.部署集策略与数据粒度冲突。
400DeploymentSet.GroupQuotaFullThe deploymentSet group quota is full.创建的部署集组的组数量超过quota限制,请尝试更小的组数量
400InvalidParameter.GroupCountThe specified parameter "GroupCount" is not valid.指定的参数GroupCount不合法。
400InvalidZoneId.NotFoundThe zoneId provided does not exist in our records.指定的可用区 ID 不存在。
400QuotaExceed.DeploymentSetThe deploymentSet quota is full.部署集配额已满。

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2023-08-21OpenAPI 错误码发生变更查看变更详情
2022-06-10OpenAPI 错误码发生变更查看变更详情