文档首页/ 文档数据库服务 DDS/ API参考/ 快速入门
更新时间：2022-08-30 GMT+08:00
查看PDF
分享

快速入门

本节通过调用API创建DDS集群实例。

通过IAM服务获取到的Token有效期为24小时，需要使用同一个Token鉴权时，可以先将Token缓存，避免频繁调用。

涉及API

当您使用Token认证方式完成认证鉴权时，需要获取用户Token并在调用接口时增加“X-Auth-Token”到业务接口请求消息头中。

  • IAM获取Token的API
  • 创建DDS实例的API

具体步骤

  1. Token认证，具体操作请参考认证鉴权。
  2. 发送“POST https://DDS的Endpoint/v3/{project_id}/instances”。
  3. 在Request Header中增加“X-Auth-Token”。
  4. 在Request Body中传入参数如下：

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

    关于创建实例接口的详细说明，请参见创建实例。

    {
  "name": "test-cluster", //实例名称
  "datastore": {
    "type": "DDS-Community", //数据库版本类型
    "version": "3.4", //数据库版本号
    "storage_engine": "wiredTiger" //存储引擎
  },
  "region": "aaa", //区域名称
  "availability_zone": "bbb", //可用区名称
  "vpc_id": "674e9b42-cd8d-4d25-a2e6-5abcc565b961", //虚拟私有云ID
  "subnet_id": "f1df08c5-71d1-406a-aff0-de435a51007b", //子网ID
  "security_group_id": "7aa51dbf-5b63-40db-9724-dad3c4828b58", //安全组ID
  "password": "******", //管理员密码
  "disk_encryption_id": "d4825f1b-5e47-4ff7-8ca9-0960da1770b1", //磁盘加密时的密钥ID
  "mode": "Sharding", //分片集群实例类型
  "flavor": [
    {
      "type": "mongos", //mongos节点类型
      "num": 2, //节点数量
      "spec_code": "dds.mongodb.c6.medium.4.mongos" //节点资源编码
    },
    {
      "type": "shard", //shard节点类型
      "num": 2, //节点数量
      "storage": "ULTRAHIGH", //磁盘类型
      "size": 20, //磁盘大小
      "spec_code": "dds.mongodb.c6.medium.4.shard" //节点资源编码
    },
    {
      "type": "config", //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"
}

    请求成功后，返回如下信息：

    {
  "id": "46125c43ca4d424a9f5c97354223c4e0in02",
  "name": "test-cluster",
  "datastore": {
    "type": "DDS-Community",
    "version": "3.4",
    "storage_engine": "wiredTiger"
  },
  "created": "2019-01-14 08:50:27",
  "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",
  "disk_encryption_id": "d4825f1b-5e47-4ff7-8ca9-0960da1770b1",
  "mode": "Sharding",
  "flavor": [
    {
      "type": "mongos",
      "num": 2,
      "spec_code": "dds.mongodb.c6.medium.4.mongos"
    },
    {
      "type": "shard",
      "num": 2,
      "size": 20,
      "spec_code": "dds.mongodb.c6.medium.4.shard"
    },
    {
      "type": "config",
      "num": 1,
      "size": 20,
      "spec_code": "dds.mongodb.c6.large.2.config"
    }
  ],
  "backup_strategy": {
    "start_time": "23:00-00:00",
    "keep_days": "8"
  },
  "enterprise_project_id": "",
  "ssl_option":"1",
  "job_id": "c0c606b6-470a-48c7-97a2-6c7f146014d4"
}

    若请求失败，会返回错误码及对应的错误信息说明，详细错误码信息请参见错误码。

相关文档