华为云用户手册

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 表3 请求Body参数 参数 是否必选 参数类型 描述 resize 是 ResizeInstanceOption object 目标规格信息。 is_auto_pay 否 String 创建包周期实例时可指定，表示是否自动从账户中支付，此字段不影响自动续订的支付方式。 对于降低规格场景，该字段无效。 对于扩大规格场景： true，表示自动从账户中支付。 false，表示手动从账户中支付，默认为该方式。 表4 ResizeInstanceOption 参数 是否必选 参数类型 描述 target_spec_code 是 String 变更至新规格的资源规格编码。 获取方法请参见查询数据库规格中响应参数“flavors.spec_code”的值。

接口约束 该接口支持如下数据库实例： GeminiDB Cassandra GeminiDB Redis 该接口既支持包周期实例，也支持按需实例。 该接口既支持扩大规格，也支持降低规格。 需要变更的规格不能与原规格一样。 实例状态仅为“normal”时，可以变更实例规格。 如果变更结果无法满足实例运行所需要的大小，将无法进行规格变更。 该接口支持GeminiDB Redis搭建双活关系的主实例和备实例。

请求示例 URI样例 PUT https://gaussdb-nosql.cn-north-4.myhuaweicloud.com/v3/375d8d8fad1f43039e23d3b6c0f60a19/instances/9136fd2a9fcd405ea4674276ce36dae8in06/resize 变更实例规格，实例目标规格为16U64G { "resize" : { "target_spec_code" : "geminidb.cassandra.4xlarge.4" } }

请求示例 URI样例 PUT https://gaussdb-nosql.cn-north-4.myhuaweicloud.com/v3/375d8d8fad1f43039e23d3b6c0f60a19/configurations/e02e76567ae04662a2753492b77f965bpr06/apply 应用参数模板 { "instance_ids" : [ "73ea2bf70c73497f89ee0ad4ee008aa2in06" ] }

请求示例 URI样例 POST https://gaussdb-nosql.cn-north-4.myhuaweicloud.com/v3/375d8d8fad1f43039e23d3b6c0f60a19/instances/9136fd2a9fcd405ea4674276ce36dae8in02/tags/action 添加2个标签 { "action" : "create", "tags" : [ { "key" : "key1", "value" : "value1" }, { "key" : "key2", "value" : "value2" } ] } 删除2个标签 { "action" : "delete", "tags" : [ { "key" : "key1" }, { "key" : "key2", "value" : "value3" } ] }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 表3 请求Body参数 参数 是否必选 参数类型 描述 action 是 String 操作标识。取值： create，表示添加标签。 delete，表示删除标签。 tags 是 Array of BatchTagActionTagOption objects 标签列表。 表4 BatchTagActionTagOption 参数 是否必选 参数类型 描述 key 是 String 标签键。最大长度36个unicode字符，不能为null或者空字符串，不能为空格，校验和使用之前会自动过滤掉前后空格。 字符集：0-9，A-Z，a-z，“_”，“-”，中文。 value 否 String 标签值。最大长度43个unicode字符，可以为空字符串。 字符集：0-9，A-Z，a-z，“_”，“.”，“-”，中文。 “action”值为“create”时，该参数必选。 “action”值为“delete”时，该参数可选。 说明： 删除标签时，如果value有值，则按照key/value匹配删除；如果value没有值，则按照key删除。

接口约束 该接口支持如下数据库实例： GeminiDB Cassandra GeminiDB Mongo GeminiDB Influx GeminiDB Redis 一个数据库实例具有20个标签配额，且标签key唯一。 添加标签时，如果请求体中存在重复key，调用该接口将会报错。 添加标签时，如果请求体中的key与指定实例已有的key重复，将会覆盖已有key对应的value的值。 如果待删除的标签不存在，调用该接口将默认处理成功，删除时，不对标签字符集范围做校验。

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 quotas ShowResourcesListResponseBody object 配额信息。 表4 ShowResourcesListResponseBody 参数 参数类型 描述 resources Array of ShowResourcesDetailResponseBody objects 资源列表对象。 表5 ShowResourcesDetailResponseBody 参数 参数类型 描述 type String 配额资源类型，当前配额类型仅支持实例类型（instance）。 quota Integer 当前配额值。 取值为0时，表示不限制当前配额值。 used Integer 已使用的资源数。

云数据库 GeminiDB授权项说明 表1 实例管理 权限 对应API接口 授权项(Action) IAM 项目(Project) 企业项目(Enterprise Project) 创建实例 POST /v3/{project_id}/instances nosql:instance:create √ √ 删除实例 DELETE /v3/{project_id}/instances/{instance_id} nosql:instance:delete √ √ 查询实例列表 GET /v3/{project_id}/instances?id={id}&name={name}&mode={mode}&datastore_type={datastore_type}&vpc_id={vpc_id}&subnet_id={subnet_id}&offset={offset}&limit={limit} nosql:instance:list √ √ 扩容实例存储容量 POST /v3/{project_id}/instances/{instance_id}/extend-volume nosql:instance:modifyStorageSize √ √ 扩容集群实例的节点数量 POST /v3/{project_id}/instances/{instance_id}/enlarge-node nosql:instance:extendNode √ √ 缩容集群实例的节点数量 POST /v3/{project_id}/instances/{instance_id}/reduce-node nosql:instance:reduceNode √ √ 变更实例规格 PUT /v3/{project_id}/instances/{instance_id}/resize nosql:instance:modifySpecification √ √ 修改实例管理员密码 PUT /v3/{project_id}/instances/{instance_id}/password nosql:instance:modifyPasswd √ √ 修改实例名称 PUT /v3/{project_id}/instances/{instance_id}/name nosql:instance:rename √ √ 变更实例安全组 PUT /v3/{project_id}/instances/{instance_id}/security-group nosql:instance:modifySecurityGroup √ √ 数据库补丁升级 POST /v3/{project_id}/instances/{instance_id}/db-upgrade nosql:instance:upgradeDatabaseVersion √ √ 创建冷数据存储 POST /v3/{project_id}/instances/{instance_id}/cold-volume nosql:instance:modifyStorageSize √ √ 扩容冷数据存储 PUT /v3/{project_id}/instances/{instance_id}/cold-volume nosql:instance:modifyStorageSize √ √ 绑定/解绑弹性公网IP POST /v3/{project_id}/instances/{instance_id}/nodes/{node_id}/public-ip nosql:instance:bindPublicIp √ √ 切换SSL开关 POST /v3/{project_id}/instances/{instance_id}/ssl-option nosql:instance:switchSSL √ √ 重启实例 POST /v3/{project_id}/instances/{instance_id}/restart nosql:instance:restart √ √ 设置磁盘自动扩容策略 PUT /v3/{project_id}/instances/disk-auto-expansion nosql:instance:modifyStorageSize √ √ 表2 备份与恢复 权限 对应API接口 授权项(Action) IAM项目(Project) 企业项目(Enterprise Project) 查询自动备份策略 GET /v3/{project_id}/instances/{instance_id}/backups/policy nosql:backup:list √ √ 设置自动备份策略 PUT /v3/{project_id}/instances/{instance_id}/backups/policy nosql:instance:modifyBackupPolicy √ √ 查询可恢复的实例列表 GET /v3/{project_id}/backups/{backup_id}/restorable-instances nosql:instance:list √ √ 查询实例可恢复的时间段 GET /v3/{project_id}/instances/{instance_id}/backups/restorable-time-periods nosql:backup:list √ √ 创建手动备份 POST /v3/{project_id}/instances/{instance_id}/backups nosql:backup:create √ √ 删除手动备份 DELETE /v3/{project_id}/backups/{backup_id} nosql:backup:delete √ √ 恢复到已有实例 POST /v3/{project_id}/instances/{instance_id}/recovery nosql:backup:refreshInstanceFromBacku √ √ 表3 参数模板管理 权限 对应API接口 授权项(Action) IAM项目(Project) 企业项目(Enterprise Project) 获取参数模板列表 GET /v3/{project_id}/configurations nosql:param:list √ √ 创建参数模板 POST /v3/{project_id}/configurations nosql:param:create √ √ 修改参数模板的参数 PUT /v3/{project_id}/configurations/{config_id} nosql:param:modify √ √ 应用参数模板 PUT /v3/{project_id}/configurations/{config_id}/apply nosql:instance:modifyParameter √ √ 修改指定实例的参数 PUT /v3/{project_id}/instances/{instance_id}/configurations nosql:instance:modifyParameter √ √ 获取指定实例的参数 GET /v3/{project_id}/instances/{instance_id}/configurations nosql:param:list √ √ 获取指定参数模板的参数 GET /v3/{project_id}/configurations/{config_id} nosql:param:list √ √ 删除参数模板 DELETE /v3/{project_id}/configurations/{config_id} nosql:param:delete √ √ 查询参数模板可应用的实例列表 GET /v3/{project_id}/configurations/{config_id}/applicable-instances nosql:instance:list √ √ 查询实例参数的修改历史 GET /v3/{project_id}/instances/{instance_id}/configuration-histories nosql:param:list √ √ 查询参数模板应用历史 GET /v3/{project_id}/configurations/{config_id}/applied-histories nosql:param:list √ √ 表4 标签管理 权限 对应API接口 授权项(Action) IAM项目(Project) 企业项目(Enterprise Project) 查询资源实例 POST /v3/{project_id}/instances/resource_instances/action nosql:instance:list nosql:tag:list √ √ 批量添加或删除资源标签 POST /v3/{project_id}/instances/{instance_id}/tags/action nosql:instance:tag √ √ 查询资源标签 GET /v3/{project_id}/instances/{instance_id}/tags nosql:instance:list nosql:tag:list √ √ 表5 日志管理 权限 对应API接口 授权项(Action) IAM项目(Project) 企业项目(Enterprise Project) 查询数据库慢日志 GET /v3/{project_id}/instances/{instance_id}/slowlog?start_date={start_date}&end_date={end_date} nosql:instance:list √ √ 表6 配额管理 权限 对应API接口 授权项(Action) IAM项目(Project) 企业项目(Enterprise Project) 查询配额 GET /v3/{project_id}/quotas nosql:instance:list √ √ 表7 容灾管理 权限 对应API接口 授权项(Action) IAM项目(Project) 企业项目(Enterprise Project) 预检查容灾操作 POST /v3/{projectId}/instance/{instanceId}/disaster-recovery/precheck nosql:dr:precheck √ √ 搭建容灾 POST /v3/{projectId}/instance/{instanceId}/disaster-recovery/construction nosql:dr:construct √ √ 解除容灾 POST /v3/{projectId}/instance/{instanceId}/disaster-recovery/deconstruction nosql:dr:deconstruct √ √ 获取容灾实例主/备角色信息 POST /v3/{project_id}/instances/{instance_id}/instance-role nosql:instance:switchoverDisaterRecovery √ √ 容灾实例备升主 POST /v3/{project_id}/instances/{instance_id}/switchover-master nosql:instance:switchoverFromDisaterToMaster √ √ 容灾实例主降备 POST /v3/{project_id}/instances/{instance_id}/switchover-slave nosql:instance:switchoverFromMasterToDisater √ √ 暂停/恢复容灾实例间数据同步 POST /v3/{project_id}/instances/{instance_id}/disaster-recovery/data-synchronization nosql:dr:operateDataSync √ √ “√”表示支持，“x”表示暂不支持。 父主题： 权限策略和授权项

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 表3 请求Body参数 参数 是否必选 参数类型 描述 force 否 Boolean 是否强制备实例升主。 若为true，则强制备实例升主，用于在主实例异常的状态下，快速恢复服务的场景：允许备实例强制升为特殊主实例，独立提供读写服务。 默认为false，用于正常状态下备实例平缓升主。

请求示例 URI样例 PUT https://gaussdb-nosql.cn-north-4.myhuaweicloud.com/v3/375d8d8fad1f43039e23d3b6c0f60a19/configurations/e02e76567ae04662a2753492b77f965bpr06 修改参数模板参数 请求体参数中，至少有一个非空，否则会下发失败。 { "name" : "configuration_test", "description" : "configuration_test", "values" : { "concurrent_reads" : "64" } }

响应示例 状态码： 202 Accepted 创建按需实例响应样例： { "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,ccc,ddd", "vpc_id" : "490a4a08-ef4b-44c5-94be-3051ef9e4fce", "subnet_id" : "0e2eda62-1d42-4d64-a9d1-4e9aa9cd994f", "security_group_id" : "2a1f7fc8-3307-42a7-aa6f-42c8b9b8f8c5", "mode" : "Cluster", "flavor" : [ { "num" : 3, "size" : 500, "storage" : "ULTRAHIGH", "spec_code" : "geminidb.cassandra.4xlarge.4" } ], "backup_strategy" : { "start_time" : "08:15-09:15", "keep_days" : "8" }, "enterprise_project_id" : "0", "ssl_option" : "1", "job_id" : "c010abd0-48cf-4fa8-8cbc-090f093eaa2f" } 创建包周期实例响应样例：

请求示例 URI样例 POST https://{Endpoint}/v3/375d8d8fad1f43039e23d3b6c0f60a19/instances 创建一个按需付费的3节点Cassandra实例，规格是16U64G 请求体样例中参数“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", "subnet_id" : "f1df08c5-71d1-406a-aff0-de435a51007", "security_group_id" : "7aa51dbf-5b63-40db-9724-dad3c4828b58", "password" : "******", "mode" : "Cluster", "flavor" : [ { "num" : 3, "storage" : "ULTRAHIGH", "size" : 500, "spec_code" : "geminidb.cassandra.4xlarge.4" } ], "backup_strategy" : { "start_time" : "08:15-09:15", "keep_days" : 8 }, "ssl_option" : 1 } 创建一个包周期付费的3节点Cassandra实例，规格是16U64G 请求体样例中参数“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", "subnet_id" : "f1df08c5-71d1-406a-aff0-de435a51007", "security_group_id" : "7aa51dbf-5b63-40db-9724-dad3c4828b58", "password" : "******", "mode" : "Cluster", "flavor" : [ { "num" : 3, "storage" : "ULTRAHIGH", "size" : 500, "spec_code" : "geminidb.cassandra.4xlarge.4" } ], "backup_strategy" : { "start_time" : "08:15-09:15", "keep_days" : 8 }, "ssl_option" : 1, "charge_info" : { "charge_mode" : "prePaid", "period_type" : "year", "period_num" : 3, "is_auto_renew" : true, "is_auto_pay" : true } } 根据指定备份恢复数据创建一个新的按需付费的3节点16U64G的Cassandra实例 请求体样例中参数“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", "subnet_id" : "f1df08c5-71d1-406a-aff0-de435a51007", "security_group_id" : "7aa51dbf-5b63-40db-9724-dad3c4828b58", "password" : "******", "mode" : "Cluster", "flavor" : [ { "num" : 3, "storage" : "ULTRAHIGH", "size" : 500, "spec_code" : "geminidb.cassandra.4xlarge.4" } ], "backup_strategy" : { "start_time" : "08:15-09:15", "keep_days" : 8 }, "ssl_option" : 1, "restore_info" : { "backup_id" : "2f4ddb93b9014b0893d81d2e472f30fe" } } 根据指定实例的指定时间点的数据创建一个新的包周期付费的3节点16U64G的Cassandra实例 请求体样例中参数“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", "subnet_id" : "f1df08c5-71d1-406a-aff0-de435a51007", "security_group_id" : "7aa51dbf-5b63-40db-9724-dad3c4828b58", "password" : "******", "mode" : "Cluster", "flavor" : [ { "num" : 3, "storage" : "ULTRAHIGH", "size" : 500, "spec_code" : "geminidb.cassandra.4xlarge.4" } ], "backup_strategy" : { "start_time" : "08:15-09:15", "keep_days" : 8 }, "ssl_option" : 1, "charge_info" : { "charge_mode" : "prePaid", "period_type" : "year", "period_num" : 3, "is_auto_renew" : true, "is_auto_pay" : true }, "restore_info" : { "restore_time" : 1607731200000, "source_instance_id" : "054e292c9880d4992f02c0196d3ein12" } }

响应参数 状态码： 202 表10 响应Body参数 参数 参数类型 描述 id String 实例ID。 name String 实例名称，与请求参数相同。 datastore Datastore object 数据库信息，与请求参数相同。 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，与请求参数相同。 mode String 实例类型，与请求参数相同。 flavor Array of Flavor objects 实例规格详情，与请求参数相同。 backup_strategy BackupStrategy object 高级备份策略，与请求参数相同。 enterprise_project_id String 企业项目ID。取值为“0”，表示为default企业项目。 ssl_option String SSL开关选项，与请求参数相同。 job_id String 创建实例的工作流ID, 仅创建按需实例时会返回该参数。 order_id String 创建实例的订单ID，仅创建包年包月时返回该参数。 charge_info ChargeInfo object 计费类型信息，支持包年包月和按需计费，默认为按需计费。 dedicated_resource_id String 专属资源ID，只有创建在专属资源上的实例才会返回该字段。 表11 Datastore 参数 参数类型 描述 type String 数据库类型。 支持GeminiDB Cassandra、GeminiDB Mongo、GeminiDB Influx和GeminiDB Redis数据库实例。 取值为“cassandra”，表示创建GeminiDB Cassandra数据库实例。 取值为“mongodb”，表示创建GeminiDB Mongo数据库实例。 取值为“influxdb”，表示创建GeminiDB Influx数据库实例。 取值为“redis”，表示创建GeminiDB Redis数据库实例。 version String 数据库版本。 GeminiDB Cassandra实例支持3.11版本，取值为“3.11”。 GeminiDB Mongo实例支持4.0版本，取值为“4.0”。 GeminiDB Influx实例支持1.7版本，取值为“1.7”。 GeminiDB Redis实例支持5.0版本，取值为“5.0”。 storage_engine String 存储引擎。 GeminiDB Cassandra实例支持RocksDB存储引擎，取值为“rocksDB”。 GeminiDB Mongo实例支持RocksDB存储引擎，取值为“rocksDB”。 GeminiDB Influx实例支持RocksDB存储引擎，取值为“rocksDB”。 GeminiDB Redis实例支持RocksDB存储引擎，取值为“rocksDB”。 表12 Flavor 参数 参数类型 描述 num String 节点数量。 GeminiDB Cassandra实例的节点数量可取3~60。 GeminiDB Mongo 4.0版本副本集实例的节点数量为3。 GeminiDB Influx实例的节点数量可取3~16。 GeminiDB Redis实例的节点数量可取3~12。 size String 磁盘大小。必须为整数，单位为GB。 GeminiDB Cassandra，GeminiDB Mongo，GeminiDB Influx的最小磁盘容量100GB，最大磁盘容量与实例的性能规格有关。GeminiDB Redis的最大和最小磁盘容量与节点数和实例的性能规格有关。 GeminiDB Cassandra请参见数据库实例规格。 GeminiDB Mongo请参见数据库实例规格。 GeminiDB Influx请参见数据库实例规格。 GeminiDB Redis请参见数据库实例规格。 storage String 磁盘类型。 取值为“ULTRAHIGH”，表示SSD盘。 spec_code String 资源规格编码。 获取方法请参见查询数据库规格中响应参数“spec_code”的值。 表13 BackupStrategy 参数 参数类型 描述 start_time String 备份时间段。自动备份将在该时间段内触发。 取值范围：非空，格式必须为hh:mm-HH:MM，且有效，当前时间指UTC时间。 HH取值必须比hh大1。 mm和MM取值必须相同，且取值必须为00、15、30或45。 不传该参数，默认的备份时间段为00:00-01:00。 取值示例：23:00-00:00 keep_days String 指定已生成的备份文件可以保存的天数。 取值范围：0~35。 取0值，表示不设置自动备份策略。 不传该参数，默认开启自动备份策略，备份文件默认保存7天。 表14 ChargeInfo 参数 参数类型 描述 charge_mode String 计费模式。 取值范围： prePaid：预付费，即包年/包月。 postPaid：后付费，即按需付费。 period_type String 订购周期类型。 取值范围： month：包月。 year：包年。 说明： “charge_mode”为“prePaid”时生效，且为必选值。 period_num String “charge_mode”为“prePaid”时生效，且为必选值，指定订购的时间。 取值范围： 当“period_type”为“month”时，取值为1~9。 当“period_type”为“year”时，取值为1~3 is_auto_renew String 创建包周期实例时可指定，表示是否自动续订，续订的周期和原周期相同，且续订时会自动支付。 true，表示自动续订。 false，表示不自动续订，默认为该方式。 is_auto_pay String 创建包周期实例时可指定，表示是否自动从账户中支付，该字段不影响自动续订的支付方式。 true，表示自动从账户中支付 false，表示手动从账户中支付，默认为该支付方式。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 表3 请求Body参数 参数 是否必选 参数类型 描述 name 是 String 实例名称，允许和已有名称重复。 实例名称长度在4个到64个字节之间，必须以字母或中文字开头，区分大小写，可以包含字母、数字、中划线、下划线或中文（一个中文字符占用3个字节），不能包含其他特殊字符。 datastore 是 Datastore object 数据库信息。 region 是 String 区域ID。 取值：非空，请参见地区和终端节点。 availability_zone 是 String 可用区ID。 取值：请参见5.2.2-查询数据库规格中返回的“az_status”，支持创建3可用区实例，中间以逗号隔开。 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接口查询，具体操作可参考查询安全组列表。 password 是 String 数据库密码。 取值范围：长度为8~32位。必须是大写字母（A~Z）、小写字母（a~z）、数字（0~9）、特殊字符~!@#%^*-_=+?的组合。仅GeminiDB Redis至少包含以下字符中的2种：大写字母、小写字母、数字和特殊字符~！@#$%^&*()-_=+？。 建议您输入高强度密码，以提高安全性，防止出现密码被暴力破解等安全风险。 mode 是 String 实例类型。 GeminiDB Cassandra支持集群类型，取值为“Cluster”。 GeminiDB Mongo 4.0版本支持副本集类型，取值为“ReplicaSet”。 GeminiDB Influx支持集群类型，取值为“Cluster”。 GeminiDB Influx支持单节点类型，取值为“InfluxdbSingle”。 GeminiDB Redis支持集群类型，取值为“Cluster”。 flavor 是 Array of Flavor objects 实例规格详情。 获取方法请参见查询数据库规格中响应“flavors”字段下参数的值。 configuration_id 否 String 参数模板ID。 backup_strategy 否 BackupStrategy object 高级备份策略。 enterprise_project_id 否 String 企业项目ID。 对于未开通企业多项目服务的用户，不传该参数。 对于已开通企业多项目服务的用户，不传该参数时，表示为default企业项目。获取方式请参见《企业管理API参考》的“查询企业项目列表”响应消息表“enterprise_project字段数据结构说明”的“id”。 ssl_option 否 String SSL开关选项。 取值： 取“0”，表示默认不启用SSL连接。 取“1”，表示默认启用SSL连接。 不传该参数时，默认不启用SSL连接。 charge_info 否 ChargeInfo object 计费类型信息，支持包年包月和按需计费，默认为按需计费。 dedicated_resource_id 否 String 专属资源ID，只有开通专属资源池后才可以下发此参数。 restore_info 否 RestoreInfo object 备份信息。支持按指定备份恢复和按指定实例的指定时间点恢复。 目前仅GeminiDB Cassandra和GeminiDB Influx集群支持按指定实例的指定时间点恢复。 port 否 String 数据库访问端口号。 目前仅支持GeminiDB Redis实例支持自定义端口，取值范围为：1024~65535，禁用端口号为：2180、2887、3887、6377、6378、6380、8018、8079、8091、8479、8484、8999、12017、12333、50069。 不指定端口时，创建GeminiDB Redis实例的访问端口默认为6379。 如果该实例计划用于搭建双活容灾场景，请配置为8635端口。 availability_zone_detail 否 object 主备类型实例的多AZ可用区详情。 目前仅支持GeminiDB Redis实例。 当选择单AZ部署时，自动忽略该参数设置。详情请参考表9。 表4 Datastore 参数 是否必选 参数类型 描述 type 是 String 数据库类型。 支持GeminiDB Cassandra、GeminiDB Mongo、GeminiDB Influx和GeminiDB Redis数据库实例。 取值为“cassandra”，表示创建GeminiDB Cassandra数据库实例。 取值为“mongodb”，表示创建GeminiDB Mongo数据库实例。 取值为“influxdb”，表示创建GeminiDB Influx数据库实例。 取值为“redis”，表示创建GeminiDB Redis数据库实例。 version 是 String 数据库版本。 GeminiDB Cassandra实例支持3.11版本，取值为“3.11”。 GeminiDB Mongo实例支持4.0版本，取值为“4.0”。 GeminiDB Influx实例支持1.7版本，取值为“1.7”。 GeminiDB Redis实例支持5.0版本，取值为“5.0”。 storage_engine 是 String 存储引擎。 GeminiDB Cassandra实例支持RocksDB存储引擎，取值为“rocksDB”。 GeminiDB Mongo实例支持RocksDB存储引擎，取值为“rocksDB”。 GeminiDB Influx实例支持RocksDB存储引擎，取值为“rocksDB”。 GeminiDB Redis实例支持RocksDB存储引擎，取值为“rocksDB”。 表5 Flavor 参数 是否必选 参数类型 描述 num 是 String 节点数量。 GeminiDB Cassandra实例的节点数量可取3~60。 GeminiDB Mongo 4.0版本副本集实例的节点数量为3。 GeminiDB Influx集群实例的节点数量可取3~16。 GeminiDB Influx单节点实例的节点数量可取1。 GeminiDB Redis实例的节点数量可取3~12。 size 是 String 磁盘大小。必须为整数，单位为GB。 GeminiDB Cassandra，GeminiDB Mongo，GeminiDB Influx的最小磁盘容量100GB，最大磁盘容量与实例的性能规格有关。GeminiDB Redis的最大和最小磁盘容量与节点数和实例的性能规格有关。 GeminiDB Cassandra请参见数据库实例规格。 GeminiDB Mongo请参见数据库实例规格。 GeminiDB Influx请参见数据库实例规格。 GeminiDB Redis请参见数据库实例规格。 storage 是 String 磁盘类型。 取值为“ULTRAHIGH”，表示SSD盘。 spec_code 是 String 资源规格编码。 获取方法请参见查询数据库规格中响应参数“spec_code”的值。 表6 BackupStrategy 参数 是否必选 参数类型 描述 start_time 是 String 备份时间段。自动备份将在该时间段内触发。 取值范围：非空，格式必须为hh:mm-HH:MM，且有效，当前时间指UTC时间。 HH取值必须比hh大1。 mm和MM取值必须相同，且取值必须为00、15、30或45。 不传该参数，默认的备份时间段为00:00-01:00。 取值示例：23:00-00:00 keep_days 否 String 指定已生成的备份文件可以保存的天数。 取值范围：0~35。 取0值，表示不设置自动备份策略。 不传该参数，默认开启自动备份策略，备份文件默认保存7天。 表7 ChargeInfo 参数 是否必选 参数类型 描述 charge_mode 是 String 计费模式。 取值范围： prePaid：预付费，即包年/包月。 postPaid：后付费，即按需付费。 period_type 否 String 订购周期类型。 取值范围： month：包月。 year：包年。 说明： “charge_mode”为“prePaid”时生效，且为必选值。 period_num 否 String “charge_mode”为“prePaid”时生效，且为必选值，指定订购的时间。 取值范围： 当“period_type”为“month”时，取值为1~9。 当“period_type”为“year”时，取值为1~3 is_auto_renew 否 String 创建包周期实例时可指定，表示是否自动续订，续订的周期和原周期相同，且续订时会自动支付。 true，表示自动续订。 false，表示不自动续订，默认为该方式。 is_auto_pay 否 String 创建包周期实例时可指定，表示是否自动从账户中支付，该字段不影响自动续订的支付方式。 true，表示自动从账户中支付 false，表示手动从账户中支付，默认为该支付方式。 表8 RestoreInfo 参数 是否必选 参数类型 描述 backup_id 否 String 全量备份文件ID。 用于根据指定备份恢复数据到一个新创建的实例的场景，此场景下该字段取值不能为空。 source_instance_id 否 String 数据恢复参考的指定实例的ID。 用于恢复指定实例的指定时间点的数据到一个新创建的实例的场景，此场景下该字段取值不能为空。 restore_time 否 Long 数据恢复的指定的时间点。 用于恢复指定实例的指定时间点的数据到一个新创建的实例的场景，此场景下该字段取值不能为空。取值为UTC 13位毫秒数，可通过查询实例可恢复的时间段接口进行查询。 表9 AvailabilityZoneDetail 参数 是否必选 参数类型 描述 primary_availability_zone 是 String 主可用区，应为单可用区且和备可用区不同。 secondary_availability_zone 是 String 备可用区，应为单可用区且和主可用区不同。

响应示例 状态码： 200 Success { "total_count" : 2, "resources" : [ { "id" : "300acc71-eca9-4c6b-9a4e-0d25e20fe54c", "resource_name" : "nosql-dedicated-resource-1", "engine_name" : "cassandra", "availability_zone" : "az1,az2,az3", "architecture" : "X86", "capacity" : { "vcpus" : 192, "ram" : 1536, "volume" : 300000 }, "status" : "NORMAL" }, { "id" : "4c423cd8-551f-4b74-934f-8534e4a9bf2b", "resource_name" : "nosql-dedicated-resource-2", "engine_name" : "cassandra", "availability_zone" : "az1,az2,az3", "architecture" : "X86", "capacity" : { "vcpus" : 192, "ram" : 1536, "volume" : 300000 }, "status" : "BUILDING" } ] }

URI GET https://{Endpoint}/v3/{project_id}/dedicated-resources 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户在某一region下的project ID。获取方法请参见获取项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 offset 否 Integer 索引位置偏移量，表示从指定project ID下最新的专属资源创建时间开始，按时间的先后顺序偏移offset条数据后查询对应的专属资源信息。 取值大于或等于0。 不传该参数时，查询偏移量默认为0，表示从最新的创建时间对应的专属资源开始查询。 limit 否 Integer 查询专属资源个数上限值。 取值范围：1~100。 不传该参数时，默认查询前100条实例信息。

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 total_count Integer 总记录数。 resources Array of DedicatedResource objects 专属资源信息列表。 表4 DedicatedResource 参数 参数类型 描述 id String 专属资源ID。 resource_name String 专属资源的名称。 engine_name String 接口名称。 availability_zone String 可用区信息。 architecture String 专属资源中计算主机的类型，目前类型取值有"X86"和"ARM"。 capacity DedicatedResourceCapacity object 专属资源的容量信息。 status String 专属资源的状态信息，包含以下状态。 NORMAL，可用。 BUILDING，建设中。 表5 DedicatedResourceCapacity 参数 参数类型 描述 vcpus Integer CPU核数。 ram Integer 内存大小，单位GB。 volume Integer 存储大小，单位GB

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户token。 表3 请求Body参数 参数 是否必选 参数类型 描述 backup_id 是 String 备份文件名称。根据备份文件恢复到已有的实例。 password 否 String 实例密码。 取值范围：长度为8~32位。必须是大写字母（A~Z）、小写字母（a~z）、数字（0~9）、特殊字符~!@#%^*-_=+?的组合。仅GeminiDB Redis至少包含以下字符中的2种：大写字母、小写字母、数字和特殊字符~！@#$%^&*()-_=+？。 不传入密码时，恢复后，备份文件中保留的密码将覆盖原有实例的密码。 传入密码时，恢复后，将使用该密码覆盖原有实例的密码。

URI POST https://{Endpoint}/v3/{project_id}/instances/{instance_id}/recovery 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 用户在某一region下的project ID。获取方法请参见获取项目ID。 instance_id 是 String 实例Id，可以调用5.3.3 查询实例列表和详情接口获取。如果未申请实例，可以调用5.3.1 创建实例接口创建。

请求示例 URI样例 POST https://gaussdb-nosql.cn-north-4.myhuaweicloud.com/v3/054e292c9880d4992f02c0196d3ea468/instances/61f554065802400c9c33f87e8114f081in10/recovery 恢复到已有实例 { "backup_id" : "a8114c9b30cf42b6ba7752bfa62dee0bbr10", "password" : "******" }

请求示例 绑定弹性公网IP URI样例 POST https://gaussdb-nosql.cn-north-7.myhuaweicloud.com/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/61f554065802400c9c33f87e8114f081in10/nodes/1345bb07d1834f8fb0b4acbc26e989aano10/public-ip 请求体样例 { "action" : "BIND", "public_ip" : "10.154.218.161", "public_ip_id" : "45da4782-e0c8-4aa4-a290-b8740014f710" } 解绑弹性公网IP URI样例 POST https://gaussdb-nosql.cn-north-7.myhuaweicloud.com/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/61f554065802400c9c33f87e8114f081in10/nodes/1345bb07d1834f8fb0b4acbc26e989aano10/public-ip 请求体样例 { "action" : "UNBIND", "public_ip" : "10.154.218.161" }

URI POST https://{Endpoint}/v3/{project_id}/instances/{instance_id}/nodes/{node_id}/public-ip 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户在某一region下的project ID。获取方法请参见获取项目ID。 instance_id 是 String 实例ID。 node_id 是 String 实例节点ID。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户token。 表3 请求Body参数 参数 是否必选 参数类型 描述 action 是 String 操作标识。 取值： BIND，表示绑定弹性公网IP。 UNBIND，表示解绑弹性公网IP。 public_ip 否 String 弹性公网IP。绑定弹性公网IP时必须传入。 public_ip_id 否 String 弹性公网IP的ID。绑定弹性公网IP时必须传入。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 表3 请求Body参数 参数 是否必选 参数类型 描述 size 是 Integer 待变更到的磁盘容量。单位GB，取值为整数。 扩容场景下，必须大于当前磁盘容量。 缩容场景下，必须大于已用量的125%，向上取整。 磁盘容量的上下限与所选接口类型以及规格相关。 GeminiDB Cassandra请参见数据库实例规格。 GeminiDB Redis请参见数据库实例规格。 is_auto_pay 否 Boolean 扩容包年包月实例存储容量时可指定，表示是否自动从账户中支付，此字段不影响自动续订的支付方式。 true，表示自动从账户中支付。 false，表示手动从账户中支付，默认为该方式。

请求示例 开启SSL开关 URI样例 POST https://gaussdb-nosql.cn-north-7.myhuaweicloud.com/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/944bdc55da6c4b33b260b34185ac86bein13/ssl-option 开启SSL开关 { "ssl_option" : "on" } 关闭SSL开关 URI样例 POST https://gaussdb-nosql.cn-north-7.myhuaweicloud.com/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/944bdc55da6c4b33b260b34185ac86bein13/ssl-option 关闭SSL开关 { "ssl_option" : "off" }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 表3 请求Body参数 参数 是否必选 参数类型 描述 recycle_policy 是 object 回收策略。详情强参考表4。 表4 RecyclePolicy 参数 是否必选 参数类型 描述 retention_period_in_days 否 Integer 策略保持时长（1-7天），天数为正整数，默认7天。

请求示例 URI样例 PUT https://gaussdb-nosql.cn-north-7.myhuaweicloud.com/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/recycle-policy 设置回收站实例保留天数为3天 { "recycle_policy": { "retention_period_in_days": 3 } }

响应示例 状态码： 200 Success. { "total_count" : 1, "instances" : [ { "id" : "07fc12a8e0e94df7a3fcf53d0b5e1605in06", "name" : "test", "mode" : "Cluster", "datastore" : { "type" : "cassandra", "version" : "3.11" }, "charge_mode" : "postPaid", "enterprise_project_id" : "0", "backup_id" : "bf9ee62a7f7044c583c6765c916c36edbr02", "created_at" : "2022-01-01T10:00:00", "deleted_at" : "2022-02-01T11:00:00", "retained_until" : "2022-02-02T11:00:00" } ] }

URI GET https://{Endpoint}/v3/{project_id}/recycle-instances 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户在某一region下的project ID。获取方法请参见获取项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 offset 否 Integer 索引位置，偏移量。 从第一条数据偏移offset条数据后开始查询，默认为0（偏移0条数据，表示从第一条数据开始查询） 取值必须为数字，且不能为负数。 limit 否 Integer 查询个数上限值。 取值范围：1~100。 不传该参数时，默认查询前100条信息。