更新时间:2023-11-21 GMT+08:00

快速入门

本节通过调用API创建GeminiDB Cassandra数据库实例。

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

涉及API

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

  • IAM获取Token的API
  • 创建GeminiDB Cassandra实例的API

具体步骤

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

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

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

    {
        "name": "test-cassandra-01",//实例名称
        "datastore": {
            "type": "cassandra",//数据库类型
            "version": "3.11", //数据库版本
            "storage_engine": "rocksDB"//存储引擎
        },
        "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": "xxxx",//管理员密码
        "mode": "Cluster", //实例类型
        "flavor": [
            {
                "num": 3,//节点数量
                "size": 500,//磁盘大小
                "storage": "ULTRAHIGH", //磁盘类型
                "spec_code": "geminidb.cassandra.4xlarge.4" //资源规格编码
            }
        ],
        "backup_strategy": {
            "start_time": "08:00-09:00",//备份时间段
            "keep_days": "8"//备份文件的保留天数
        },
        "enterprise_project_id": "0"//企业项目ID
    }

    请求成功后,返回如下信息:

    {
        "id": "39b6a1a278844ac48119d86512e0000bin06",
        "name": "test-cassandra-01",
        "datastore": {
            "type": "cassandra",
            "version": "3.11",
            "storage_engine": "rocksDB"
        },
        "created": "2019-10-28 14:10:54",
        "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",
        "mode": "Cluster",
        "flavor": [
            {
                "num": 3,
                "size": 500,
                "storage": "ULTRAHIGH",
                "spec_code": "geminidb.cassandra.4xlarge.4"
            }
        ],
        "backup_strategy": {
            "start_time": "08:00-09:00",
            "keep_days": "8"
        },
        "job_id": "c010abd0-48cf-4fa8-8cbc-090f093eaa2f",
        "enterprise_project_id": "0"
    }

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