创建集群-CreateCluster
功能介绍
在系统中创建一个集群。适用于以下场景:当用户需要创建超节点时可以通过此接口创建集群。接口返回集群ID,可以作为创建超节点的参数之一。创建同名集群时接口将返回相应错误信息。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
授权信息
账号根用户具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备如下身份策略权限,更多的权限说明请参见权限和授权项。
| 授权项 | 访问级别 | 资源类型(*为必须) | 条件键 | 别名 | 依赖的授权项 |
|---|---|---|---|---|---|
| aics::createCluster | Write | - | - | - | ecs:cloudServers:listServersDetails |
URI
POST /v2/{project_id}/clusters
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 参数解释: 项目ID,获取方法请参见获取项目ID。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 否 | String | 参数解释: 用户Token,通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| name | 是 | String | 参数解释: 集群名称。 约束限制: 用户的集群名称不可重复。 取值范围: 长度1-64,只能由英文字母、数字及"_"、"-"、"."组成。 默认取值: 不涉及。 |
| availability_zone_id | 是 | String | 参数解释: 可用区标识。 约束限制: 当前用户项目下的可用区ID。 取值范围: 长度1-256,只能由英文字母、数字及"_"、"-"、"."组成。 默认取值: 不涉及。 |
响应参数
状态码:201
| 参数 | 参数类型 | 描述 |
|---|---|---|
| id | String | 参数解释: 集群唯一标识UUID。 取值范围: UUID格式,[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}。 |
请求示例
创建集群请求示例。使用场景:用户需要创建超节点前,先创建集群以提供超节点间参数面网络互联能力。
POST https://{endpoint}/v2/0605767a3300d5762fb7c0186d9e1779/clusters
{
"name" : "cluster_1",
"availability_zone_id" : "cn-north-4a"
} 响应示例
状态码:201
成功创建集群。
{
"id" : "550e8400-e29b-41d4-a716-446655440003"
} 状态码
| 状态码 | 描述 |
|---|---|
| 201 | 成功创建集群。 |
错误码
请参见错误码。