CreateDeploymentSet - 创建部署集--云服务器-火山引擎

文档中心

立即注册

导航

云服务器

CreateDeploymentSet - 创建部署集

最近更新时间：2024.10.28 17:36:25首次发布时间：2023.01.06 07:41:48

调用 CreateDeploymentSet 接口创建一个部署集。

使用说明

部署集策略、注意事项和操作说明，请参见部署集概述。

请求说明

调用该接口时，如不传入可选参数，则保持原有配置。

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

参数	类型	是否必填	示例值	描述
Action	String	是	CreateDeploymentSet	要执行的操作，取值：CreateDeploymentSet。
Version	String	是	2020-04-01	API的版本，取值：2020-04-01。
ClientToken	String	否	333456899ff****	保证请求幂等性。由客户端自动生成一个参数值，确保不同请求间该参数值唯一，避免当调用API超时或服务器内部错误时，客户端多次重试导致重复性操作。取值：仅支持ASCII字符，且不能超过64个字符。
DeploymentSetName	String	是	testDeploymentSetName	部署集名称。不能以数字、中划线、下划线开头。只能包含中文、字母、数字、下划线和中划线。长度限制为1～128个字符。
Description	String	否	testDescription	部署集描述。必须以字母或中文开头。只能包含中文、字母、数字、点“.”、空格、下划线“_”、中划线“-”、等号“=”、英文逗号“,”、中文逗号“，”和中文句号“。” 长度限制在255个字符以内。说明传入空字符串时，将清空原有描述信息。
Granularity	String	否	host	部署粒度，取值： host：物理机 rack：机架 switch：交换机说明 `Strategy`取值为`Availability`时，需传入该参数。
GroupCount	Integer	否	3	为部署集组高可用策略设置分组数量。取值范围：1～3。默认值：3 说明 `Strategy`取值为`AvailabilityGroup`时，需传入该参数。
Strategy	String	否	Availability	部署策略，取值： Availability（默认）：高可用策略。 AvailabilityGroup：部署集组高可用策略。

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构。

参数	类型	示例值	描述
DeploymentSetId	String	dps-yc1o9aahks5m57nk****	部署集ID。

请求示例

GET /?Action=CreateDeploymentSet&Version=2020-04-01&DeploymentSetName=testDeploymentSetName&Strategy=Availability&Granularity=host HTTP/1.1
Host: open.volcengineapi.com
Region: cn-beijing
ServiceName: ecs

返回示例

{
    "ResponseMetadata": {
        "RequestId": "2021110417394001022514606307*****",
        "Action": "CreateDeploymentSet",
        "Version": "2020-04-01",
        "Service": "ecs",
        "Region": "cn-beijing"
    },
    "Result": {
        "DeploymentSetId": "dps-yc1o9aahks5m57nk****"
    }
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码	错误码	错误信息	说明
400	InvalidDeploymentSetGranularity.Malformed	The specified deployment set granularity is malformed.	指定的部署集粒度不合法。
400	InvalidDeploymentSetDescription.Malformed	The specified deployment set description is malformed.	指定的部署集描述不合法。
400	InvalidClientToken.Malformed	The specified ClientToken is malformed.	指定的ClientToken不合法。
400	IdempotentParameterMismatch	The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.	幂等参数不一致。
400	InvalidDeploymentSetName.Malformed	The specified DeploymentSetName is malformed.	指定的DeploymentSetName不合法。
400	InvalidDeploymentSetStrategy.Malformed	The specified deployment set strategy is malformed.	指定的部署集策略不合法。
412	IdempotentProcessing	The request uses the same client token as a previous one that is still in process.	先前的幂等请求仍在处理中，请稍后重试。
500	InternalError	An internal error has occurred.	内部错误，请重试。如果多次尝试失败，请提交工单。