更新时间:2022-04-12 GMT+08:00
分享

创建实例

功能介绍

创建文档数据库实例,包括集群实例、副本集实例、以及单节点实例。

接口约束

该接口暂不支持创建包周期实例。

调试

您可以在API Explorer中调试该接口。

URI

  • URI格式

    POST https://{Endpoint}/v3/{project_id}/instances

  • URI样例

    https://dds.cn-north-1.myhuaweicloud.com/v3/0549b4a43100d4f32f51c01c2fe4acdb/instances

  • 参数说明
    表1 参数说明

    名称

    是否必选

    描述

    project_id

    租户在某一region下的project ID。

请求消息

  • 参数说明
    表2 参数说明

    名称

    是否必选

    参数类型

    描述

    name

    String

    实例名称。用于表示实例的名称,允许和已有名称重复。

    • 实例名称长度在4个到64个字节之间,必须以字母或中文字开头,区分大小写,可以包含字母、数字、中划线、下划线或中文(一个中文字符占用3个字节),不能包含其他特殊字符。

    datastore

    Object

    数据库信息。详情请参见表3

    region

    String

    区域ID。

    取值:非空,请参见地区和终端节点

    availability_zone

    String

    可用区ID。参见 查询数据库规格接口中返回的az_status ,可以选择多个AZ,创建跨AZ的集群。

    取值:非空,请参见地区和终端节点

    vpc_id

    String

    虚拟私有云ID,获取方法如下:

    • 方法1:登录虚拟私有云服务的控制台界面,在虚拟私有云的详情页面查找VPC ID。
    • 方法2:通过虚拟私有云服务的API接口查询,具体操作可参考查询VPC列表

    subnet_id

    String

    子网的网络ID,获取方法如下:

    • 方法1:登录虚拟私有云服务的控制台界面,单击VPC下的子网,进入子网详情页面,查找网络ID。
    • 方法2:通过虚拟私有云服务的API接口查询,具体操作可参考查询子网列表

    security_group_id

    String

    安全组ID,获取方法如下:

    • 方法1:登录虚拟私有云服务的控制台界面,在安全组的详情页面查找安全组ID。
    • 方法2:通过虚拟私有云服务的API接口查询,具体操作可参考查询安全组列表

    port

    String

    数据库访问端口。

    取值范围:2100~9500,以及27017、27018、27019。

    不传该参数时,创建实例的访问端口默认为8635。

    password

    String

    数据库密码。

    取值范围:长度为8~32位,必须是大写字母(A~Z)、小写字母(a~z)、数字(0~9)、特殊字符~!@#%^*-_=+?的组合。

    建议您输入高强度密码,以提高安全性,防止出现密码被暴力破解等安全风险。

    不传该参数时,实例创建完成后,如需连接实例,请先为实例设置密码,具体请参见重置管理员密码

    disk_encryption_id

    String

    磁盘加密时的密钥ID,严格UUID正则校验。

    不传该参数时,表示不进行磁盘加密。

    mode

    String

    实例类型。支持集群、副本集、以及单节点。

    取值:

    • Sharding
    • ReplicaSet
    • Single

    flavor

    Array of objects

    实例规格详情。详情请参见表4

    获取方法请参见查询数据库规格中响应flavors字段下参数的值。

    backup_strategy

    Object

    高级备份策略。详情请参见表5

    enterprise_project_id

    String

    企业项目ID。

    • 对于未开通企业多项目服务的用户,不传该参数。
    • 对于已开通企业多项目服务的用户,不传该参数时,表示为default企业项目。

    获取方式请参见《企业管理API参考》的“查询企业项目列表”响应消息表“enterprise_project字段数据结构说明”的“id”。

    ssl_option

    String

    SSL开关选项。

    取值:

    • 取“0”,表示DDS实例默认不启用SSL连接。
    • 取“1”,表示DDS实例默认启用SSL连接。
    • 不传该参数时,默认不启用SSL连接。

    dss_pool_id

    String

    Dec用户专属存储ID,默认为空。仅Dec用户支持该参数。

    server_group_policies

    Array of strings

    Dec用户云服务器组关联的策略名称列表。仅Dec用户支持该参数。

    该参数取值包括:

    • 取“anti-affinity”,表示DDS实例开启反亲和部署,反亲和部署是出于高可用性考虑,将您的Primary、Secondary和Hidden节点分别创建在不同的物理机上。
    • Dec用户不传该参数时,默认不开启反亲和部署。

    tags

    Array of objects

    标签列表。

    单个实例总标签数上限20个。详情请参见表6

    表3 datastore字段数据结构说明

    名称

    是否必选

    参数类型

    描述

    type

    String

    数据库版本类型。取值为“DDS-Community”。

    version

    String

    数据库版本。支持4.2、4.0、3.4版本,取值为“4.2”、“4.0”、“3.4”。

    说明:
    • 4.2版本正在公测中,使用前请先了解DDS4.2版本公测试用服务协议
    • 为了保证您的文档数据库使用体验,建议创建4.0版本的数据库。

    storage_engine

    String

    存储引擎。支持WiredTiger/RocksDB存储引擎。

    • 数据库版本为4.2时,存储引擎为RocksDB,取值为“rocksDB”。
    • 数据库版本为4.0和3.4时,存储引擎为WiredTiger,取值为“wiredTiger”。
    表4 flavor字段数据结构说明

    名称

    是否必选

    参数类型

    描述

    type

    String

    节点类型。

    取值:

    • 集群实例包含mongos、shard和config节点,各节点下该参数取值分别为“mongos”、“shard”和“config”。
    • 副本集实例下该参数取值为“replica”。
    • 单节点实例下该参数取值为“single”。

    num

    String

    节点数量。

    取值:

    • 集群实例下“mongos”类型的节点数量可取2~32。
    • 集群实例下“shard”类型的组数量可取2~32。
    • “config”类型的组数量只能取1。
    • “replica”类型的节点数量可取3,5,7。
    • “single”类型的节点数量只能取1。

    storage

    String

    磁盘类型。

    取值:ULTRAHIGH,表示SSD。

    对于集群实例的shard和config节点、副本集、以及单节点实例,该参数有效。mongos节点不涉及选择磁盘,该参数无意义。

    size

    String

    磁盘大小。

    对于除mongos外的其他节点,该参数必选。mongos节点下,该参数无意义。

    取值:必须为10的整数倍。单位为GB。

    • 对于集群实例,shard组可取10GB~2000GB,config组仅可取20GB。mongos节点不涉及选择磁盘,该参数无意义。
    • 对于副本集实例,可取10GB~3000GB。
    • 对于单节点实例,可取10GB~1000GB。

    spec_code

    String

    资源规格编码。获取方法请参见查询数据库规格中响应参数“spec_code”的值。

    集群实例下,需要指定多个规格,要求所有规格的系列一致,均为通用型(s6)、增强型(c3)、或增强Ⅱ型(c6)。

    示例:
    • dds.mongodb.s6.large.4.mongos和dds.mongodb.s6.large.4.config是同一规格系列。
    • dds.mongodb.s6.large.4.mongos和dds.mongodb.c3.large.4.config不是同一规格系列。
    表5 backup_strategy字段数据结构说明

    名称

    是否必选

    参数类型

    描述

    start_time

    String

    备份时间段。自动备份将在该时间段内触发。

    取值范围:非空,格式必须为hh:mm-HH:MM,且有效,当前时间指UTC时间。

    • HH取值必须比hh大1。
    • mm和MM取值必须相同,且取值必须为00。
    • 不传该参数,默认的备份时间段不传该参数,默认的备份时间段为00:00-01:00。

    取值示例:

    23:00-00:00

    keep_days

    String

    指定已生成的备份文件可以保存的天数。

    取值范围:0~732。

    • 取0值,表示不设置自动备份策略。
    • 不传该参数,默认开启自动备份策略,备份文件默认保存7天。
    表6 tags字段数据结构说明

    名称

    是否必选

    参数类型

    描述

    key

    String

    标签键。最大长度36个unicode字符。

    key不能为空,不能为空字符串,不能重复。

    字符集:A-Z,a-z , 0-9,‘-’,‘_’,UNICODE字符(\u4E00-\u9FFF)。

    value

    String

    标签值。最大长度43个unicode字符。 可以为空字符串。

    字符集:A-Z,a-z , 0-9,‘.’,‘-’,‘_’,UNICODE字符(\u4E00-\u9FFF)。

请求体样例中参数“region”和“availability_zone”的值为示例值。

  • 请求体样例
    创建集群实例:
    {
      "name": "test-cluster-01",
      "datastore": {
        "type": "DDS-Community",
        "version": "3.4",
        "storage_engine": "wiredTiger"
      },
      "region": "aaa",
      "availability_zone": "bbb",
      "vpc_id": "674e9b42-cd8d-4d25-a2e6-5abcc565b961",
      "subnet_id": "f1df08c5-71d1-406a-aff0-de435a51007b",
      "security_group_id": "7aa51dbf-5b63-40db-9724-dad3c4828b58",
      "password": "******",
      "mode": "Sharding",
      "flavor": [
        {
          "type": "mongos",
          "num": 2,
          "spec_code": "dds.mongodb.c3.medium.4.mongos"
        },
        {
          "type": "shard",
          "num": 2,
          "storage": "ULTRAHIGH",
          "size": 20,
          "spec_code": "dds.mongodb.c3.medium.4.shard"
        },
        {
          "type": "config",
          "num": 1,
          "storage": "ULTRAHIGH",
          "size": 20,
          "spec_code": "dds.mongodb.c3.large.2.config"
        }
      ],
      "backup_strategy": {
        "start_time": "23:00-00:00",
        "keep_days": "8"
      },
      "ssl_option":"1",
      "tags" : [{ 
        "key" : "dds001", 
        "value" : "dds001" 
      }]
    }
    快捷创建集群实例:
    {
      "name": "test-cluster-01",
      "datastore": {
        "type": "DDS-Community",
        "version": "3.4",
        "storage_engine": "wiredTiger"
      },
      "region": "aaa",
      "availability_zone": "bbb",
      "vpc_id": "674e9b42-cd8d-4d25-a2e6-5abcc565b961",
      "subnet_id": "f1df08c5-71d1-406a-aff0-de435a51007b",
      "security_group_id": "7aa51dbf-5b63-40db-9724-dad3c4828b58",
      "mode": "Sharding",
      "flavor": [
        {
          "type": "mongos",
          "num": 2,
          "spec_code": "dds.mongodb.c3.medium.4.mongos"
        },
        {
          "type": "shard",
          "num": 2,
          "storage": "ULTRAHIGH",
          "size": 20,
          "spec_code": "dds.mongodb.c3.medium.4.shard"
        },
        {
          "type": "config",
          "num": 1,
          "storage": "ULTRAHIGH",
          "size": 20,
          "spec_code": "dds.mongodb.c3.large.2.config"
        }
      ]
          "tags" : [{ 
            "key" : "dds001", 
            "value" : "dds001" 
         }]
    }
    创建跨AZ集群实例:
    {
      "name": "test-cluster-01",
      "datastore": {
        "type": "DDS-Community",
        "version": "3.4",
        "storage_engine": "wiredTiger"
      },
      "region": "aaa",
      "availability_zone": "aaa,bbb,ccc",
      "vpc_id": "674e9b42-cd8d-4d25-a2e6-5abcc565b961",
      "subnet_id": "f1df08c5-71d1-406a-aff0-de435a51007b",
      "security_group_id": "7aa51dbf-5b63-40db-9724-dad3c4828b58",
      "password": "******",
      "mode": "Sharding",
      "flavor": [
        {
          "type": "mongos",
          "num": 2,
          "spec_code": "dds.mongodb.c3.medium.4.mongos"
        },
        {
          "type": "shard",
          "num": 2,
          "storage": "ULTRAHIGH",
          "size": 20,
          "spec_code": "dds.mongodb.c3.medium.4.shard"
        },
        {
          "type": "config",
          "num": 1,
          "storage": "ULTRAHIGH",
          "size": 20,
          "spec_code": "dds.mongodb.c3.large.2.config"
        }
      ],
      "backup_strategy": {
        "start_time": "23:00-00:00",
        "keep_days": "8"
      },
      "ssl_option":"1",
      "tags" : [{ 
        "key" : "dds001", 
        "value" : "dds001" 
      }]
    }
    创建副本集实例:
    {
      "name": "test-replicaset",
      "datastore": {
        "type": "DDS-Community",
        "version": "3.4",
        "storage_engine": "wiredTiger"
      },
      "region": "aaa",
      "availability_zone": "bbb",
      "vpc_id": "674e9b42-cd8d-4d25-a2e6-5abcc565b961",
      "subnet_id": "f1df08c5-71d1-406a-aff0-de435a51007b",
      "security_group_id": "7aa51dbf-5b63-40db-9724-dad3c4828b58",
      "password": "******",
      "mode": "ReplicaSet",
      "flavor": [
        {
          "type": "replica",
          "num": 1,
          "storage": "ULTRAHIGH",
          "size": 30,
          "spec_code": "dds.mongodb.c3.medium.4.repset"
        }
      ],
      "backup_strategy": {
        "start_time": "23:00-00:00",
        "keep_days": "8"
      },
      "ssl_option":"1",
      "tags" : [{ 
        "key" : "dds001", 
        "value" : "dds001" 
      }]
    }
    创建单节点实例:
    {
      "name": "test-singlenode",
      "datastore": {
        "type": "DDS-Community",
        "version": "3.4",
        "storage_engine": "wiredTiger"
      },
      "region": "aaa",
      "availability_zone": "bbb",
      "vpc_id": "674e9b42-cd8d-4d25-a2e6-5abcc565b961",
      "subnet_id": "f1df08c5-71d1-406a-aff0-de435a51007b",
      "security_group_id": "7aa51dbf-5b63-40db-9724-dad3c4828b58",
      "password": "******",
      "mode": "Single",
      "flavor": [
        {
          "type": "single",
          "num": 1,
          "storage": "ULTRAHIGH",
          "size": 30,
          "spec_code": "dds.mongodb.c3.medium.4.single"
        }
      ],
      "backup_strategy": {
        "start_time": "23:00-00:00",
        "keep_days": "8"
      },
      "ssl_option":"1",
      "tags" : [{ 
        "key" : "dds001", 
        "value" : "dds001" 
      }]
    }

响应消息

  • 要素说明
    表7 要素说明

    名称

    参数类型

    描述

    id

    String

    实例ID。

    name

    String

    实例名称,与请求参数相同。

    datastore

    Object

    数据库信息,与请求参数相同。详情请参见表3

    created

    String

    创建时间为本地时间,格式为“yyyy-mm-dd hh:mm:ss”。

    status

    String

    实例状态,取值为“creating”。

    region

    String

    区域ID,与请求参数相同。

    availability_zone

    String

    可用区ID,与请求参数相同。

    vpc_id

    String

    虚拟私有云ID,与请求参数相同。

    subnet_id

    String

    子网的网络ID,与请求参数相同。

    security_group_id

    String

    安全组ID,与请求参数相同。

    port

    Integer

    数据库访问端口。

    disk_encryption_id

    String

    磁盘加密的密钥ID,与请求参数相同。

    mode

    String

    实例类型,与请求参数相同。

    flavor

    Array of objects

    实例规格详情,与请求参数相同。详情请参见表4

    backup_strategy

    Object

    高级备份策略,与请求参数相同。详情请参见表5

    enterprise_project_id

    String

    企业项目ID。取值为“0”,表示为default企业项目。

    ssl_option

    String

    SSL开关选项,与请求参数相同。

    dss_pool_id

    String

    Dec用户专属存储ID,与请求参数相同。

    job_id

    String

    创建实例的工作流ID。

    tags

    Array of objects

    标签列表,与请求参数相同。

    详情请参见表6

响应样例中参数“region”和“availability_zone”的值为示例值。

  • 响应样例
    集群实例:
    { 
        "id": "39b6a1a278844ac48119d86512e0000bin02",
        "name": "test-cluster-01",
        "datastore": {
            "type": "DDS-Community",
            "version": "3.4",
            "storage_engine": "wiredTiger"
        },
        "created": "2019-01-16 09:34:36",
        "status": "creating",
        "region": "aaa",
        "availability_zone": "bbb",
        "vpc_id": "674e9b42-cd8d-4d25-a2e6-5abcc565b961",
        "subnet_id": "f1df08c5-71d1-406a-aff0-de435a51007b",
        "security_group_id": "7aa51dbf-5b63-40db-9724-dad3c4828b58",
        "port": 8365,
        "disk_encryption_id": "",
        "mode": "Sharding",
        "flavor": [
            {
                "type": "mongos",
                "num": 2,
                "spec_code": "dds.mongodb.c3.medium.4.mongos"
            },
            {
                "type": "shard",
                "num": 2,
                "spec_code": "dds.mongodb.c3.medium.4.shard",
                "size": 20
            },
            {
                "type": "config",
                "num": 1,
                "spec_code": "dds.mongodb.c3.large.2.config",
                "size": 20
            }
        ],
        "backup_strategy": {
            "start_time": "23:00-00:00",
            "keep_days": "8"
        },
        "enterprise_project_id": "",
        "ssl_option":"1",
        "job_id": "c010abd0-48cf-4fa8-8cbc-090f093eaa2f",
        "tags" : [{ 
          "key" : "dds001", 
          "value" : "dds001" 
        }]
    }
    副本集实例:
    {
        "id": "46dfadfd2b674585a430217f23606cd7in02",
        "name": "test-replicaset",
        "datastore": {
            "type": "DDS-Community",
            "version": "3.4",
            "storage_engine": "wiredTiger"
        },
        "created": "2019-01-16 09:33:08",
        "status": "creating",
        "region": "aaa",
        "availability_zone": "bbb",
        "vpc_id": "674e9b42-cd8d-4d25-a2e6-5abcc565b961",
        "subnet_id": "f1df08c5-71d1-406a-aff0-de435a51007b",
        "security_group_id": "7aa51dbf-5b63-40db-9724-dad3c4828b58",
        "port": 8365,
        "disk_encryption_id": "",
        "mode": "ReplicaSet",
        "flavor": [
            {
                "type": "replica",
                "num": 1,
                "spec_code": "dds.mongodb.s2.medium.4.shard",
                "size": 30
            }
        ],
        "backup_strategy": {
            "start_time": "23:00-00:00",
            "keep_days": "7"
        },
        "enterprise_project_id": "",
        "ssl_option":"1",
        "job_id": "2408417d-fd4b-40ae-bec6-e09ce594eb5f",
        "tags" : [{ 
          "key" : "dds001", 
          "value" : "dds001" 
        }]
    }
    单节点实例:
    { 
        "id": "520c58ba00a3497e97ce0b9604874dd6in02",
        "name": "test-singlenode",
        "datastore": {
            "type": "DDS-Community",
            "version": "3.4",
            "storage_engine": "wiredTiger"
        },
        "created": "2019-01-15 12:08:11",
        "status": "creating",
        "region": "aaa",
        "availability_zone": "bbb",
        "vpc_id": "674e9b42-cd8d-4d25-a2e6-5abcc565b961",
        "subnet_id": "f1df08c5-71d1-406a-aff0-de435a51007b",
        "security_group_id": "7aa51dbf-5b63-40db-9724-dad3c4828b58",
        "port": 8365,
        "disk_encryption_id": "",
        "mode": "Single",
        "flavor": [
            {
                "type": "single",
                "num": 1,
                "spec_code": "dds.mongodb.c3.medium.4.single",
                "size": 30
            }
        ],
        "backup_strategy": {
            "start_time": "23:00-00:00",
            "keep_days": "7"
        },
        "enterprise_project_id": "",
        "ssl_option":"1",
        "job_id": "46b65a13-3d52-4c58-a29b-4085d563dc9b",
        "tags" : [{ 
          "key" : "dds001", 
          "value" : "dds001" 
        }]
    }

状态码

详情请参见状态码

错误码

详情请参见错误码

分享:

    相关文档

    相关产品

关闭导读