网络
虚拟私有云 VPC
弹性公网IP EIP
弹性负载均衡 ELB
NAT网关 NAT
云专线 DC
虚拟专用网络 VPN
云连接 CC
VPC终端节点 VPCEP
企业路由器 ER
企业交换机 ESW
全球加速 GA
企业连接 EC
云原生应用网络 ANC
安全与合规
安全技术与应用
Web应用防火墙 WAF
企业主机安全 HSS
云防火墙 CFW
安全云脑 SecMaster
DDoS防护 AAD
数据加密服务 DEW
数据库安全服务 DBSS
云堡垒机 CBH
数据安全中心 DSC
云证书管理服务 CCM
威胁检测服务 MTD
态势感知 SA
认证测试中心 CTC
边缘安全 EdgeSec
应用中间件
微服务引擎 CSE
分布式消息服务Kafka版
分布式消息服务RabbitMQ版
分布式消息服务RocketMQ版
API网关 APIG
分布式缓存服务 DCS
多活高可用服务 MAS
事件网格 EG
管理与监管
统一身份认证服务 IAM
消息通知服务 SMN
云监控服务 CES
应用运维管理 AOM
应用性能管理 APM
云日志服务 LTS
云审计服务 CTS
标签管理服务 TMS
配置审计 Config
应用身份管理服务 OneAccess
资源访问管理 RAM
组织 Organizations
资源编排服务 RFS
优化顾问 OA
IAM 身份中心
云运维中心 COC
资源治理中心 RGC
解决方案
高性能计算 HPC
SAP
混合云灾备
开天工业工作台 MIW
Haydn解决方案工厂
数字化诊断治理专家服务
云生态
云商店
合作伙伴中心
华为云开发者学堂
华为云慧通差旅
开发与运维
软件开发生产线 CodeArts
需求管理 CodeArts Req
流水线 CodeArts Pipeline
代码检查 CodeArts Check
编译构建 CodeArts Build
部署 CodeArts Deploy
测试计划 CodeArts TestPlan
制品仓库 CodeArts Artifact
移动应用测试 MobileAPPTest
CodeArts IDE Online
开源镜像站 Mirrors
性能测试 CodeArts PerfTest
应用管理与运维平台 ServiceStage
云应用引擎 CAE
开源治理服务 CodeArts Governance
华为云Astro轻应用
CodeArts IDE
Astro工作流 AstroFlow
代码托管 CodeArts Repo
漏洞管理服务 CodeArts Inspector
联接 CodeArtsLink
软件建模 CodeArts Modeling
Astro企业应用 AstroPro
CodeArts 盘古助手
华为云Astro大屏应用
计算
弹性云服务器 ECS
Flexus云服务
裸金属服务器 BMS
云手机服务器 CPH
专属主机 DeH
弹性伸缩 AS
镜像服务 IMS
函数工作流 FunctionGraph
云耀云服务器(旧版)
VR云渲游平台 CVR
Huawei Cloud EulerOS
云化数据中心 CloudDC
网络
虚拟私有云 VPC
弹性公网IP EIP
弹性负载均衡 ELB
NAT网关 NAT
云专线 DC
虚拟专用网络 VPN
云连接 CC
VPC终端节点 VPCEP
企业路由器 ER
企业交换机 ESW
全球加速 GA
企业连接 EC
云原生应用网络 ANC
CDN与智能边缘
内容分发网络 CDN
智能边缘云 IEC
智能边缘平台 IEF
CloudPond云服务
安全与合规
安全技术与应用
Web应用防火墙 WAF
企业主机安全 HSS
云防火墙 CFW
安全云脑 SecMaster
DDoS防护 AAD
数据加密服务 DEW
数据库安全服务 DBSS
云堡垒机 CBH
数据安全中心 DSC
云证书管理服务 CCM
威胁检测服务 MTD
态势感知 SA
认证测试中心 CTC
边缘安全 EdgeSec
大数据
MapReduce服务 MRS
数据湖探索 DLI
表格存储服务 CloudTable
可信智能计算服务 TICS
推荐系统 RES
云搜索服务 CSS
数据可视化 DLV
数据接入服务 DIS
数据仓库服务 GaussDB(DWS)
数据治理中心 DataArts Studio
湖仓构建 LakeFormation
智能数据洞察 DataArts Insight
应用中间件
微服务引擎 CSE
分布式消息服务Kafka版
分布式消息服务RabbitMQ版
分布式消息服务RocketMQ版
API网关 APIG
分布式缓存服务 DCS
多活高可用服务 MAS
事件网格 EG
开天aPaaS
应用平台 AppStage
开天企业工作台 MSSE
开天集成工作台 MSSI
API中心 API Hub
云消息服务 KooMessage
交换数据空间 EDS
云地图服务 KooMap
云手机服务 KooPhone
组织成员账号 OrgID
云空间服务 KooDrive
管理与监管
统一身份认证服务 IAM
消息通知服务 SMN
云监控服务 CES
应用运维管理 AOM
应用性能管理 APM
云日志服务 LTS
云审计服务 CTS
标签管理服务 TMS
配置审计 Config
应用身份管理服务 OneAccess
资源访问管理 RAM
组织 Organizations
资源编排服务 RFS
优化顾问 OA
IAM 身份中心
云运维中心 COC
资源治理中心 RGC
区块链
区块链服务 BCS
数字资产链 DAC
华为云区块链引擎服务 HBS
解决方案
高性能计算 HPC
SAP
混合云灾备
开天工业工作台 MIW
Haydn解决方案工厂
数字化诊断治理专家服务
价格
成本优化最佳实践
专属云商业逻辑
云生态
云商店
合作伙伴中心
华为云开发者学堂
华为云慧通差旅
其他
管理控制台
消息中心
产品价格详情
系统权限
客户关联华为云合作伙伴须知
公共问题
宽限期保留期
奖励推广计划
活动
云服务信任体系能力说明
开发与运维
软件开发生产线 CodeArts
需求管理 CodeArts Req
流水线 CodeArts Pipeline
代码检查 CodeArts Check
编译构建 CodeArts Build
部署 CodeArts Deploy
测试计划 CodeArts TestPlan
制品仓库 CodeArts Artifact
移动应用测试 MobileAPPTest
CodeArts IDE Online
开源镜像站 Mirrors
性能测试 CodeArts PerfTest
应用管理与运维平台 ServiceStage
云应用引擎 CAE
开源治理服务 CodeArts Governance
华为云Astro轻应用
CodeArts IDE
Astro工作流 AstroFlow
代码托管 CodeArts Repo
漏洞管理服务 CodeArts Inspector
联接 CodeArtsLink
软件建模 CodeArts Modeling
Astro企业应用 AstroPro
CodeArts 盘古助手
华为云Astro大屏应用
存储
对象存储服务 OBS
云硬盘 EVS
云备份 CBR
高性能弹性文件服务 SFS Turbo
弹性文件服务 SFS
存储容灾服务 SDRS
云硬盘备份 VBS
云服务器备份 CSBS
数据快递服务 DES
云存储网关 CSG
专属分布式存储服务 DSS
数据工坊 DWR
地图数据 MapDS
键值存储服务 KVS
容器
云容器引擎 CCE
云容器实例 CCI
容器镜像服务 SWR
云原生服务中心 OSC
应用服务网格 ASM
华为云UCS
数据库
云数据库 RDS
数据复制服务 DRS
文档数据库服务 DDS
分布式数据库中间件 DDM
云数据库 GaussDB
云数据库 GeminiDB
数据管理服务 DAS
数据库和应用迁移 UGO
云数据库 TaurusDB
人工智能
AI开发平台ModelArts
华为HiLens
图引擎服务 GES
图像识别 Image
文字识别 OCR
自然语言处理 NLP
内容审核 Moderation
图像搜索 ImageSearch
医疗智能体 EIHealth
企业级AI应用开发专业套件 ModelArts Pro
人脸识别服务 FRS
对话机器人服务 CBS
语音交互服务 SIS
人证核身服务 IVS
视频智能分析服务 VIAS
城市智能体
自动驾驶云服务 Octopus
盘古大模型 PanguLargeModels
IoT物联网
设备接入 IoTDA
全球SIM联接 GSL
IoT数据分析 IoTA
路网数字化服务 DRIS
IoT边缘 IoTEdge
设备发放 IoTDP
企业应用
域名注册服务 Domains
云解析服务 DNS
企业门户 EWP
ICP备案
商标注册
华为云WeLink
华为云会议 Meeting
隐私保护通话 PrivateNumber
语音通话 VoiceCall
消息&短信 MSGSMS
云管理网络
SD-WAN 云服务
边缘数据中心管理 EDCM
云桌面 Workspace
应用与数据集成平台 ROMA Connect
ROMA资产中心 ROMA Exchange
API全生命周期管理 ROMA API
政企自服务管理 ESM
视频
实时音视频 SparkRTC
视频直播 Live
视频点播 VOD
媒体处理 MPC
视频接入服务 VIS
数字内容生产线 MetaStudio
迁移
主机迁移服务 SMS
对象存储迁移服务 OMS
云数据迁移 CDM
迁移中心 MGC
专属云
专属计算集群 DCC
开发者工具
SDK开发指南
API签名指南
DevStar
华为云命令行工具服务 KooCLI
Huawei Cloud Toolkit
CodeArts API
云化转型
云架构中心
云采用框架
用户服务
账号中心
费用中心
成本中心
资源中心
企业管理
工单管理
客户运营能力
国际站常见问题
支持计划
专业服务
合作伙伴支持计划
我的凭证
华为云公共事业服务云平台
工业软件
工业数字模型驱动引擎
硬件开发工具链平台云服务
工业数据转换引擎云服务

创建实例

更新时间:2024-10-31 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 请求参数

名称

类型

IN

是否必选

描述

X-Auth-Token

string

header

从IAM服务获取的用户Token。请参考认证鉴权

project_id

string

path

租户在某一Region下的项目ID。请参考获取项目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列表。
    • 如需开通DDS多安全组权限,您可以在管理控制台右上角,选择“工单 > 新建工单”,提交权限申请。
    • 最多支持添加10个安全组ID,安全组ID之间用英文逗号隔开。
    • 获取方法如下:
      • 方法1:登录虚拟私有云服务的控制台界面,在安全组的详情页面查找安全组ID。
      • 方法2:通过虚拟私有云服务的API接口查询,具体操作可参考查询安全组列表

    port

    String

    数据库访问端口。

    端口有效范围:2100~65535(不包括12017和33071)。

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

    password

    String

    数据库密码。

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

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

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

    disk_encryption_id

    String

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

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

    mode

    String

    实例类型。支持集群和副本集。

    取值:

    • Sharding
    • ReplicaSet

    configurations

    Array of objects

    参数组配置信息。详情请参见表4

    不传该参数时,表示为系统默认参数组。

    flavor

    Array of objects

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

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

    backup_strategy

    Object

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

    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个。详情请参见表7

    charge_info

    Object

    计费类型信息,支持包年包月和按需计费,默认为按需计费。

    详情请参见表8

    表3 datastore字段数据结构说明

    名称

    参数类型

    是否必选

    描述

    type

    String

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

    version

    String

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

    storage_engine

    String

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

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

    参数

    参数类型

    是否必选

    描述

    type

    String

    节点类型。取值:

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

    枚举值:

    • mongos
    • shard
    • config
    • replica

    configuration_id

    String

    参数组id。获取参数值请参见表4

    表5 flavor字段数据结构说明

    名称

    参数类型

    是否必选

    描述

    type

    String

    节点类型。

    取值:

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

    num

    String

    节点数量或组数量。

    取值:

    • type取值“mongos”,num表示集群实例下mongos节点的数量,取值2~16。
    • type取值“shard”,num表示集群实例下shard组的数量,取值2~16。
    • type取值“config”,num表示集群实例下config组的数量,只能取值1。
    • type取值“replica”,num表示副本集实例下副本节点的数量,可取值3,5,7。

    storage

    String

    磁盘类型。

    取值:
    • ULTRAHIGH,表示SSD。
    • EXTREMEHIGH,表示极速型SSD。

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

    size

    String

    磁盘大小。

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

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

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

    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不是同一规格系列。
    表6 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天。
    表7 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)。

    表8 charge_info字段数据结构说明

    参数

    参数类型

    是否必选

    描述

    charge_mode

    String

    计费模式。 取值范围:

    • prePaid:预付费,即包年/包月。
    • postPaid:后付费,即按需付费。

    period_type

    String

    订购周期类型。 “charge_mode”为“prePaid”时生效,且为必选值。 取值范围:

    • month:包月。
    • year:包年。

    period_num

    Integer

    “charge_mode”为“prePaid”时生效,且为必选值,指定订购的时间。 取值范围:

    • 当“period_type”为“month”时,取值为1~9。
    • 当“period_type”为“year”时,取值为1~3

    is_auto_renew

    Boolean

    创建包周期实例时可指定,表示是否自动续订,续订的周期和原周期相同,且续订时会自动支付。 取值范围:

    • true,表示自动续订。
    • false,表示不自动续订,默认为该方式。

    is_auto_pay

    Boolean

    创建包周期实例时可指定,表示是否自动从账户中支付,该字段不影响自动续订的支付方式。 取值范围:

    • true,表示自动从账户中支付。
    • false,表示手动从账户中支付,默认为该支付方式。
说明:

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

请求示例

  • 创建版本为3.2,存储引擎为wiredTiger,带有虚拟私有云,子网,安全组,参数组配置,启用SSL连接,带有标签的集群实例
    {
      "name": "test-cluster-01",
      "datastore": {
        "type": "DDS-Community",
        "version": "3.2",
        "storage_engine": "wiredTiger"
      },
      "region": "aaa",
      "availability_zone": "az1xahz",
      "vpc_id": "674e9b42-cd8d-4d25-a2e6-5abcc565b961",
      "subnet_id": "f1df08c5-71d1-406a-aff0-de435a51007",
      "security_group_id": "7aa51dbf-5b63-40db-9724-dad3c4828b58",
      "password": "******",
      "mode": "Sharding",
      "configurations": [
        {
          "type": "mongos",
          "configuration_id": "acb288dbd1174f26a8960b45591bd98apr02"
        },
        {
          "type": "shard",
          "configuration_id": "5bca546f0be64b038124ef9cedd1bfa1pr02"
        },
        {
          "type": "config",
          "configuration_id": "4d123b3ba8294921802b11bf4d8c5735pr02"
        }
      ],
      "flavor": [
        {
          "type": "mongos",
          "num": 2,
          "spec_code": "dds.mongodb.c6.medium.4.mongos"
        },
        {
          "type": "shard",
          "num": 2,
          "storage": "ULTRAHIGH",
          "size": 20,
          "spec_code": "dds.mongodb.c6.medium.4.shard"
        },
        {
          "type": "config",
          "num": 1,
          "storage": "ULTRAHIGH",
          "size": 20,
          "spec_code": "dds.mongodb.c6.large.2.config"
        }
      ],
      "backup_strategy": {
        "start_time": "08:15-09:15",
        "keep_days": 8
      },
      "ssl_option": 1,
      "dss_pool_id": "f5f84ed7-6f19-4bd4-99d7-b450ad6cc4dd",
      "server_group_policies": [
        "anti-affinity"
      ],
      "tags": [
        {
          "key": "dds001",
          "value": "dds001"
        }
      ]
    }
  • 创建版本为3.4,存储引擎为wiredTiger,带有虚拟私有云,子网,安全组,参数组配置,启用SSL连接,带有标签的跨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.c6.medium.4.mongos"
        },
        {
          "type": "shard",
          "num": 2,
          "storage": "ULTRAHIGH",
          "size": 20,
          "spec_code": "dds.mongodb.c6.medium.4.shard"
        },
        {
          "type": "config",
          "num": 1,
          "storage": "ULTRAHIGH",
          "size": 20,
          "spec_code": "dds.mongodb.c6.large.2.config"
        }
      ],
      "backup_strategy": {
        "start_time": "23:00-00:00",
        "keep_days": "8"
      },
      "ssl_option":"1",
      "tags" : [{ 
        "key" : "dds001", 
        "value" : "dds001" 
      }]
    }
  • 创建版本为3.2,存储引擎为wiredTiger,带有虚拟私有云,子网,安全组,参数组配置,启用SSL连接,带有标签的副本集实例
    {
      "name": "test-replicaset",
      "datastore": {
        "type": "DDS-Community",
        "version": "3.2",
        "storage_engine": "wiredTiger"
      },
      "region": "aaa",
      "availability_zone": "az1xahz",
      "vpc_id": "674e9b42-cd8d-4d25-a2e6-5abcc565b961",
      "subnet_id": "f1df08c5-71d1-406a-aff0-de435a51007",
      "security_group_id": "7aa51dbf-5b63-40db-9724-dad3c4828b58",
      "password": "******",
      "mode": "ReplicaSet",
      "configurations": [
        {
          "type": "replica",
          "configuration_id": "f17e3aad778440fbb68603c8c9032003pr02"
        }
      ],
      "flavor": [
        {
          "type": "replica",
          "num": 1,
          "storage": "ULTRAHIGH",
          "size": 30,
          "spec_code": "dds.mongodb.c6.medium.4.repset"
        }
      ],
      "backup_strategy": {
        "start_time": "08:15-09:15",
        "keep_days": 8
      },
      "ssl_option": 1,
      "tags": [
        {
          "key": "dds001",
          "value": "dds001"
        }
      ]
    }

响应消息

  • 参数说明
    表9 参数说明

    名称

    参数类型

    是否必选

    描述

    id

    String

    实例ID。

    name

    String

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

    datastore

    Object

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

    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

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

    configurations

    Array of objects

    参数组配置信息。

    详情请参见表11

    flavor

    Array of objects

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

    backup_strategy

    Object

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

    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

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

    详情请参见表14

    order_id

    String

    创建实例的订单ID,仅创建包年包月实例时返回该参数。

    charge_info

    Object

    付费方式信息,与请求参数相同。

    详情请参见表15

    表10 datastore字段数据结构说明

    名称

    参数类型

    是否必选

    描述

    type

    String

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

    version

    String

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

    storage_engine

    String

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

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

    参数

    参数类型

    是否必选

    描述

    type

    String

    节点类型。取值:

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

    枚举值:

    • mongos
    • shard
    • config
    • replica

    configuration_id

    String

    参数组id。获取参数值请参见表4

    表12 flavor字段数据结构说明

    名称

    参数类型

    是否必选

    描述

    type

    String

    节点类型。

    num

    String

    节点数量或组数量。

    storage

    String

    磁盘类型。

    size

    String

    磁盘大小。

    spec_code

    String

    资源规格编码。

    表13 backup_strategy字段数据结构说明

    名称

    参数类型

    是否必选

    描述

    start_time

    String

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

    keep_days

    String

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

    表14 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)。

    表15 charge_info字段数据结构说明

    参数

    参数类型

    是否必选

    描述

    charge_mode

    String

    计费模式。 取值范围:

    • prePaid:预付费,即包年/包月。
    • postPaid:后付费,即按需付费。

    period_type

    String

    订购周期类型。 “charge_mode”为“prePaid”时生效,且为必选值。 取值范围:

    • month:包月。
    • year:包年。

    period_num

    Integer

    “charge_mode”为“prePaid”时生效,且为必选值,指定订购的时间。 取值范围:

    • 当“period_type”为“month”时,取值为1~9。
    • 当“period_type”为“year”时,取值为1~3

    is_auto_renew

    Boolean

    创建包周期实例时可指定,表示是否自动续订,续订的周期和原周期相同,且续订时会自动支付。 取值范围:

    • true,表示自动续订。
    • false,表示不自动续订,默认为该方式。

    is_auto_pay

    Boolean

    创建包周期实例时可指定,表示是否自动从账户中支付,该字段不影响自动续订的支付方式。 取值范围:

    • true,表示自动从账户中支付。
    • false,表示手动从账户中支付,默认为该支付方式。
说明:

响应示例中参数“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": "az1xahz",
      "vpc_id": "490a4a08-ef4b-44c5-94be-3051ef9e4fce",
      "subnet_id": "0e2eda62-1d42-4d64-a9d1-4e9aa9cd994f",
      "security_group_id": "2a1f7fc8-3307-42a7-aa6f-42c8b9b8f8c5",
      "disk_encryption_id": "2gfdsh-844a-4023-a776-fc5c5fb71fb4",
      "mode": "Sharding",
      "configurations": [
        {
          "type": "mongos",
          "configuration_id": "acb288dbd1174f26a8960b45591bd98apr02"
        },
        {
          "type": "shard",
          "configuration_id": "5bca546f0be64b038124ef9cedd1bfa1pr02"
        },
        {
          "type": "config",
          "configuration_id": "4d123b3ba8294921802b11bf4d8c5735pr02"
        }
      ],
      "flavor": [
        {
          "type": "mongos",
          "num": 2,
          "spec_code": "dds.mongodb.c6.medium.4.mongos"
        },
        {
          "type": "shard",
          "num": 2,
          "storage": "ULTRAHIGH",
          "spec_code": "dds.mongodb.c6.medium.4.shard",
          "size": 20
        },
        {
          "type": "config",
          "num": 1,
          "storage": "ULTRAHIGH",
          "spec_code": "dds.mongodb.c6.large.2.config",
          "size": 20
        }
      ],
      "backup_strategy": {
        "start_time": "08:15-09:15",
        "keep_days": "8"
      },
      "enterprise_project_id": "",
      "ssl_option": "1",
      "dss_pool_id": "f5f84ed7-6f19-4bd4-99d7-b450ad6cc4dd",
      "job_id": "c010abd0-48cf-4fa8-8cbc-090f093eaa2f",
      "tags": [
        {
          "key": "dds001",
          "value": "dds001"
        }
      ]
    }

SDK

单击文档数据库服务 DDS SDK,下载SDK或查看SDK文档。SDK的安装、认证方式等在SDK文档中对应语言类型的【使用】目录下。

状态码

详情请参见状态码

错误码

详情请参见错误码

提示

您即将访问非华为云网站,请注意账号财产安全

文档反馈

文档反馈

意见反馈

0/500

标记内容

同时提交标记内容