文档首页/ 分布式数据库中间件 DDM/ API参考/ API（推荐）/ 实例管理/ 创建实例组
更新时间：2024-08-02 GMT+08:00
查看PDF
分享

创建实例组

功能介绍

创建DDM实例组。

接口约束

无

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

URI

  • URL格式

    POST /v3/{project_id}/instances/{instance_id}/groups

  • 参数说明
    表1 路径参数

    参数

    是否必选

    参数类型

    描述

    project_id

    是

    String

    租户在某一region下的project ID。

    获取方法请参见获取项目ID。

    instance_id

    是

    String

    DDM实例ID。

请求消息

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。

通过调用IAM服务的“获取用户Token”接口来获取。
表3 请求Body参数

参数

是否必选

参数类型

描述

name

是

String

DDM实例组名称，命名要求如下。

  • 长度为4-64个字符。
  • 必须以字母开头。
  • 可以包含字母、数字、中划线、下划线、不能包含其它特殊字符。

最小长度：4

最大长度：64

type

是

String

实例组的类型。

rw：读写组

r：只读组

flavor_id

是

String

规格ID。

nodes

是

Array of 表 NodeInfo objects

节点信息列表。

最小：1

最大：32
表4 NodeInfo

参数

是否必选

参数类型

描述

available_zone

是

String

节点可用区。取值非空，请参见地区和终端节点。

subnet_id

是

String

子网ID。

请求示例

创建DDM实例组，组类型：读写，节点数为1个。

POST https://{endpoint}/v3/{project_id}/instances/{instance_id}/groups
{
    "name": "group-1",
    "type": "rw",
    "flavor_id": "a615922f-0ed8-3691-aad4-a595185febba",
     "nodes": [
        {
            "available_zone": "az1", 
            "subnet_id": "ead1e945-ca89-45dd-bcce-4a30b2054c22"
        }
    ]
}

创建DDM实例组，组类型：读，节点数为1个。

POST https://{endpoint}/v3/{project_id}/instances/{instance_id}/groups
{
    "name": "group-2",
    "type": "r",
    "flavor_id": "a615922f-0ed8-3691-aad4-a595185febba",
     "nodes": [
        {
            "available_zone": "az1", 
            "subnet_id": "ead1e945-ca89-45dd-bcce-4a30b2054c22"
        }
    ]
}
创建DDM实例组，组类型：读写，节点数为2个。 
POST https://{endpoint}/v3/{project_id}/instances/{instance_id}/groups
{
    "name": "group-3",
    "type": "rw",
    "flavor_id": "a615922f-0ed8-3691-aad4-a595185febba",
     "nodes": [
        {
            "available_zone": "az1", 
            "subnet_id": "ead1e945-ca89-45dd-bcce-4a30b2054c22"
        }，
        {
            "available_zone": "az2", 
            "subnet_id": "ead1e945-ca89-45dd-bcce-4a30b2054c22"
        }
    ]
}

响应消息

  • 正常响应参数说明
    表5 响应Body参数

    参数

    参数类型

    描述

    instance_id

    String

    实例ID。

    job_id

    String

    创建组的任务ID。

    仅创建按需实例时会返回该参数。

    order_id

    String

    订单号，创建包年包月时返回该参数。
  • 正常响应示例
    { 
  "instance_id" : "28e8841d0b9c4f6a9a30742ee60e1055****", 
  "job_id" : "1eb697c0-1842-43a3-8671-f562d038****"
}
  • 异常响应

    请参见异常请求结果。

状态码

错误码

请参见错误码。

父主题： 实例管理

相关文档