QuickDeployCluster - Key Management Service - Alibaba Cloud Documentation Center

Deploys a cluster quickly.

Operation description

You must select HSM instances from at least two zones.
You must select at least two vSwitches from different zones.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

yundun-hsm:QuickDeployCluster

create

*All Resource

*

None

Request syntax

POST  HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
VSwitchIdList	array	Yes	The list of vSwitches for the cluster.
	string	No	The vSwitch ID.	vsw-2zeqkh8ar8yey5ejv****
VpcId	string	Yes	The ID of the VPC to which the HSM instance belongs.	vpc-7xvkh90cw39p0****
WhiteList	array	No	The access whitelist for the cluster.
	string	No	The cluster access whitelist.	18.68.XX.XX
InstanceList	array	Yes	The list of HSM instances.
	string	No	The ID of the HSM instance.	hsm-cn-vj30bil8****
ClusterName	string	Yes	The cluster name.	cluster_on****
RegionId	string	Yes	The region ID.	cn-hangzhou
CertManaged	boolean	No	Specifies whether to automatically generate a certificate. true: Yes false: No	true

Response elements

Element	Type	Description	Example
	object	The return value.
RequestId	string	The request ID.	4C467B38-3910-447D-87BC-AC049166F216
Job	object	The details of the task.
JobId	string	The task ID.	job-202401250936hze747fd7e0007005
Type	string	The operation type. create: Creates a task. cancel: Cancels a task.	create
Completed	boolean	Indicates whether the task is complete. true: Yes false: No	true
CreateTime	string	The time when the task was created. This is a UNIX timestamp in milliseconds.	1653274407000
Status	string	The status of the task. success: The task is successful. running: The task is in progress. cancel: The task is canceled. fail: The task failed.	success
Response	string	The response that is returned if the task is successful.	success
Error	string	The error message that is returned if the task fails.	OperationTimeout
Progress	integer	The progress of the task. Unit: percent.	86

Examples

Success response

JSON format

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

Error codes

HTTP status code	Error code	Error message	Description
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.	Unknown error caused request processing to fail.
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.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.