QuickDeployCluster - 快速部署集群_密钥管理服务(KMS)-阿里云帮助中心

快速部署集群。

接口说明

所选密码机实例至少包含两个可用区。
虚拟交换机至少选择两个，且不包含重复可用区。

调试

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

调试

授权信息

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

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

yundun-hsm:QuickDeployCluster

create

*全部资源

*

无

请求语法

POST  HTTP/1.1

请求参数

名称	类型	必填	描述	示例值
VSwitchIdList	array	是	集群配置的交换机列表。
	string	否	交换机 ID。	vsw-2zeqkh8ar8yey5ejv****
VpcId	string	是	密码机实例所属 VPC ID。	vpc-7xvkh90cw39p0****
WhiteList	array	否	集群访问白名单列表。
	string	否	集群访问白名单。	18.68.XX.XX
InstanceList	array	是	密码机实例列表。
	string	否	密码机实例 ID。	hsm-cn-vj30bil8****
ClusterName	string	是	集群名称。	cluster_on****
RegionId	string	是	地域 ID。	cn-hangzhou
CertManaged	boolean	否	是否自动生成证书。 true：是 false：否	true

返回参数

名称	类型	描述	示例值
	object	返回值。
RequestId	string	请求 ID。	4C467B38-3910-447D-87BC-AC049166F216
Job	object	任务详情。
JobId	string	任务 ID。	job-202401250936hze747fd7e0007005
Type	string	操作类型。 create：创建任务 cancel：取消任务	create
Completed	boolean	任务是否完成。 true：是 false：否	true
CreateTime	string	任务创建时间，精确到毫秒。时间戳格式。	1653274407000
Status	string	任务状态。 success：任务成功 running：任务执行中 cancel：任务取消 fail：任务失败	success
Response	string	任务成功后返回的响应信息。	success
Error	string	任务失败时的错误信息。	OperationTimeout
Progress	integer	任务执行进度。单位为百分比。	86

示例

正常返回示例

JSON格式

{
  "RequestId": "4C467B38-3910-447D-87BC-AC049166F216",
  "Job": {
    "JobId": "job-202401250936hze747fd7e0007005",
    "Type": "create",
    "Completed": true,
    "CreateTime": "1653274407000",
    "Status": "success",
    "Response": "success",
    "Error": "OperationTimeout",
    "Progress": 86
  }
}

错误码

HTTP status code	错误码	错误信息	描述
400	InvalidApiParam.Error	api param is invalid
400	InvalidVSwitch	Invalid parameter vSwitch
400	Whitelist.TooLong	Whitelist too long, exceeds 10 CIDR blocks.
500	InternalError	The request processing has failed due to some unknown error.	未知错误导致请求处理失败。
403	NoPermission	caller has no permission
403	QuickDeployCluster.InstanceAlreadyInitialized	Instance already initialized.
403	QuickDeployCluster.InstanceIncorrectState	Instance not in Enable/Pending state.
403	QuickDeployCluster.InstanceInvalidRegion	Instance region invalid.
403	QuickDeployCluster.InstanceVersionInvalid	Instance device version is invalid
403	QuickDeployCluster.InstanceListInvalid	Cluster contains instances not in the instance list.
403	QuickDeployCluster.InstanceBelongsToOtherCluster	Instance has been in other cluster.
403	QuickDeployCluster.InvalidVpcId	The param vpcId is not the same as existed vpcId of cluster.
403	QuickDeployCluster.InvalidVSwitchIdCount	VSwitch count is less than 2.
403	QuickDeployCluster.DuplicateZone	VSwitches should not contain duplicate zones.
403	QuickDeployCluster.InstanceCountInvalid	Instance number less than 2.
403	QuickDeployCluster.InstanceTypeInvalid	Instance type invalid.
403	QuickDeployCluster.InstanceTypeNotSame	Instance type not same.

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

变更历史

更多信息，参考变更详情。