Creating a Cluster¶
Function¶
This API is used to create a cluster.
URI¶
POST /v1.1/{project_id}/clusters
Parameter | Mandatory | Type | Description |
|---|---|---|---|
project_id | Yes | String | Project ID |
Request Parameters¶
Parameter | Mandatory | Type | Description |
|---|---|---|---|
X-Auth-Token | Yes | String | User token. It can be obtained by calling the IAM API (value of X-Subject-Token in the response header). |
X-Language | Yes | String | Request language |
Parameter | Mandatory | Type | Description |
|---|---|---|---|
cluster | Yes | cluster object | Cluster object. For details, see the descriptions of cluster parameters. |
auto_remind | No | Boolean | Whether to enable message notification. If you enable this function, you can configure a maximum of five mobile numbers or email addresses. You will be notified of table/file migration job failures and EIP exceptions by SMS message or email. |
phone_num | No | String | Mobile number for receiving notifications |
No | String | Email address for receiving notifications |
Parameter | Mandatory | Type | Description |
|---|---|---|---|
scheduleBootTime | No | String | Time for scheduled startup of a CDM cluster. The CDM cluster starts at this time every day. |
isScheduleBootOff | No | Boolean | Whether to enable scheduled startup/shutdown. The scheduled startup/shutdown and auto shutdown functions cannot be enabled at the same time. |
instances | No | Array of instance objects | Node list. For details, see the descriptions of instances parameters. |
datastore | No | Datastore object | Cluster information. For details, see the descriptions of datastore parameters. |
extended_properties | No | ExtendedProperties object | Extended attribute. For details, see parameters in the extended_properties field. |
scheduleOffTime | No | String | Time for scheduled shutdown of a CDM cluster. The CDM cluster shuts down directly at this time every day without waiting for unfinished jobs to complete. |
vpcId | No | String | VPC ID, which is used for configuring a network for the cluster. |
name | No | String | Cluster name |
sys_tags | No | Array of sys_tags objects | Enterprise project information. For details, see the descriptions of sys_tags parameters. |
isAutoOff | No | Boolean | Whether to enable auto shutdown. The auto shutdown and scheduled startup/shutdown functions cannot be enabled at the same time. When auto shutdown is enabled, if no job is running in the cluster and no scheduled job is available, a cluster will be automatically shut down 15 minutes after it starts running, which reduces costs for you. |
Parameter | Mandatory | Type | Description |
|---|---|---|---|
availability_zone | Yes | String | AZ where a cluster is located. |
nics | Yes | Array of nics objects | NIC list. A maximum of two NICs are supported. For details, see the descriptions of nics parameters. |
flavorRef | Yes | String | Instance flavor
|
type | Yes | String | Node type. Currently, only cdm is available. |
Parameter | Mandatory | Type | Description |
|---|---|---|---|
securityGroupId | Yes | String | Security group ID |
net-id | Yes | String | Subnet ID |
Parameter | Mandatory | Type | Description |
|---|---|---|---|
type | No | String | Type. Generally, the value is cdm. |
version | No | String | Cluster version |
Parameter | Mandatory | Type | Description |
|---|---|---|---|
workSpaceId | No | String | Workspace ID |
resourceId | No | String | Resource ID |
trial | No | String | Whether the cluster is a trial cluster |
Parameter | Mandatory | Type | Description |
|---|---|---|---|
value | Yes | String | Enterprise project ID |
key | Yes | String | The value is fixed at _sys_enterprise_project_id. |
Response Parameters¶
Status code: 202
Parameter | Type | Description |
|---|---|---|
name | String | Cluster name |
id | String | Cluster ID |
task | Task object | Task information |
datastore | Datastore object | Cluster information |
instances | Array of ClusterInstance objects | Cluster node information |
Parameter | Type | Description |
|---|---|---|
id | String | Task ID |
name | String | Task name |
Parameter | Type | Description |
|---|---|---|
type | String | Type. Generally, the value is cdm. |
version | String | Cluster version |
Parameter | Type | Description |
|---|---|---|
id | String | Node VM ID |
name | String | Name of the VM on the node |
type | String | Node type. Currently, only cdm is available. |
shard_id | String | Shard ID |
Example Requests¶
POST /v1.1/1551c7f6c808414d8e9f3c514a170f2e/clusters
{
"cluster" : {
"scheduleBootTime" : "",
"isScheduleBootOff" : false,
"instances" : [ {
"availability_zone" : "xx-xxxxx-xx",
"nics" : [ {
"securityGroupId" : "c37852d2-2d12-41cb-af47-65c80e995c80",
"net-id" : "2d120298-6130-44d4-a438-454912fff901"
} ],
"flavorRef" : "5ddb1071-c5d7-40e0-a874-8a032e81a697",
"type" : "cdm"
} ],
"datastore" : {
"type" : "cdm",
"version" : "1.8.10"
},
"scheduleOffTime" : "",
"vpcId" : "67c06084-2212-4242-bcd4-d2144c2385a9",
"name" : "cdm-ab82",
"sys_tags" : [ {
"value" : "1ce45885-4033-40d2-bdde-d4dbaceb387d",
"key" : "_sys_enterprise_project_id"
} ],
"isAutoOff" : false
},
"auto_remind" : false,
"phone_num" : "",
"email" : ""
}
Example Responses¶
Status code: 202
Accepted
{
"id" : "befc862c-9286-46a0-a1d6-300d98b63aad",
"name" : "cdm-4ef213",
"task" : {
"id" : "2c9080047f1b1185017f1ef6ad0500ac",
"name" : "rdsCreateBackupJob"
},
"datastore" : {
"type" : "cdm",
"version" : "2.9.1.100"
},
"instances" : [ {
"id" : "b2672e7d-2faf-423f-96bb-0664cd743cfd",
"name" : "cdm-4ef213-cdm-dn-1-1",
"type" : "cdm",
"shard_id" : "dn-1"
} ]
}
Status Codes¶
Status Code | Description |
|---|---|
202 | Accepted |
400 | Request error. |
401 | Authentication failed. |
403 | You do not have required permissions to perform this operation. |
404 | The requested resource was not found. |
500 | Internal service error. |
503 | Service unavailable. |
Error Codes¶
See Error Codes.