文档首页> 数据治理中心 DataArts Studio> API参考（吉隆坡区域）> 数据集成API> 集群管理> 创建集群
更新时间：2023-06-15 GMT+08:00
查看PDF

创建集群

功能介绍

创建集群接口。

URI

POST /v1.1/{project_id}/clusters

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。

通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。

X-Language

是

String

请求语言。
表3 请求Body参数

参数

是否必选

参数类型

描述

cluster

是

cluster object

集群对象，请参见cluster参数说明

auto_remind

否

Boolean

选择是否开启消息通知。开启后，支持配置5个手机号码或邮箱，作业（目前仅支持表/文件迁移的作业）失败时、EIP异常时会发送短信或邮件通知用户

phone_num

否

String

接收消息通知的手机号码

email

否

String

接收消息通知的邮箱
表4 cluster

参数

是否必选

参数类型

描述

scheduleBootTime

否

String

定时开机的时间，CDM集群会在每天这个时间开机

isScheduleBootOff

否

Boolean

选择是否启用定时开关机功能。定时开关机功能和自动关机功能不可同时开启

instances

否

Array of instance objects

节点列表，请参见instances参数说明

datastore

否

Datastore object

集群信息，请参见 datastore参数说明

extended_properties

否

ExtendedProperties object

扩展属性，请参见 extended_properties参数说明

scheduleOffTime

否

String

定时关机的时间，定时关机时系统不会等待未完成的作业执行完成

vpcId

否

String

指定虚拟私有云ID，用于集群网络配置

name

否

String

集群名称

sys_tags

否

Array of sys_tags objects

企业项目信息，请参见 sys_tags参数说明

isAutoOff

否

Boolean

选择是否启用自动关机功能，自动关机功能和定时开关机功能不可同时开启。如果选择自动关机，则当集群中无作业运行且无定时作业时，等待15分钟后集群将自动关机来帮您节约成本
表5 instance

参数

是否必选

参数类型

描述

availability_zone

是

String

集群的可用分区

nics

是

Array of nics objects

网卡列表，最多两个网卡。请参见 nics参数说明

flavorRef

是

String

实例规格：

  • a79fd5ae-1833-448a-88e8-3ea2b913e1f6：表示cdm.small规格，2核CPU、4G内存的虚拟机。适合PoC验证和开发测试。
  • fb8fe666-6734-4b11-bc6c-43d11db3c745：表示cdm.medium规格，4核CPU、8G内存的虚拟机适合单张表规模<1000万条的场景。
  • 5ddb1071-c5d7-40e0-a874-8a032e81a697：表示cdm.large规格，8核CPU、16G内存的虚拟机。适合单张表规模≥1000万条的场景。
  • 6ddb1072-c5d7-40e0-a874-8a032e81a698：表示cdm.xlarge规格，16核CPU、32G内存的虚拟机。需要10GE高速带宽进行TB以上的数据量迁移时使用

type

是

String

节点类型，当前只有“cdm”一种类型
表6 nics

参数

是否必选

参数类型

描述

securityGroupId

是

String

安全组ID

net-id

是

String

子网ID
表7 Datastore

参数

是否必选

参数类型

描述

type

否

String

类型，一般为cdm。

version

否

String

集群版本。
表8 ExtendedProperties

参数

是否必选

参数类型

描述

workSpaceId

否

String

工作空间ID。

resourceId

否

String

资源ID。

trial

否

String

是否是试用集群。
表9 sys_tags

参数

是否必选

参数类型

描述

value

是

String

企业项目ID

key

是

String

该值目前固定为“_sys_enterprise_project_id”

响应参数

状态码： 202

表10 响应Body参数

参数

参数类型

描述

name

String

集群名称

id

String

集群ID

task

Task object

任务信息

datastore

Datastore object

集群信息

instances

Array of ClusterInstance objects

集群的节点信息
表11 Task

参数

参数类型

描述

id

String

任务id

name

String

任务名称
表12 Datastore

参数

参数类型

描述

type

String

类型，一般为cdm。

version

String

集群版本。
表13 ClusterInstance

参数

参数类型

描述

id

String

节点的虚拟机ID。

name

String

节点的虚拟机名称。

type

String

节点类型，只支持一种类型“cdm”。

shard_id

String

分片ID

请求示例

POST /v1.1/1551c7f6c808414d8e9f3c514a170f2e/clusters

{
  "cluster" : {
    "scheduleBootTime" : "",
    "isScheduleBootOff" : false,
    "instances" : [ {
      "availability_zone" : "**-*****-**",
      "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" : ""
}

响应示例

状态码： 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"
  } ]
}

状态码

状态码

描述

202

Accepted

400

请求错误

401

鉴权失败

403

没有操作权限

404

找不到资源

500

服务内部接口异常

503

服务不可用

错误码

请参见错误码。

父主题： 集群管理