华为云用户手册

响应示例 状态码： 200 Success. { "quotas" : [ { "enterprise_project_id" : "c0348bb1-d09d-4ee2-8edd-53e496fe6b52", "enterprise_project_name" : "test1", "quota" : { "instance" : 500, "vcpus" : 1000, "ram" : 2000 }, "used" : { "instance" : 15, "vcpus" : 88, "ram" : 256 } }, { "enterprise_project_id" : "780a6b1f-58b8-4df6-a85e-326d052de704", "enterprise_project_name" : "test2", "quota" : { "instance" : 500, "vcpus" : 1000, "ram" : 2000 }, "used" : { "instance" : 36, "vcpus" : 64, "ram" : 192 } } ], "total_count" : 2 }

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 total_count Integer 总记录数。 error_log_list Array of 表5 objects 错误日志信息。 表5 ErrorLogList 参数 参数类型 描述 node_name String 节点名称。 level String 日志级别。 time String 发生时间，UTC时间。 content String 日志内容。

响应示例 状态码： 200 Success { "error_log_list" : [ { "node_name" : "Test_replica_node_2", "level" : "WARNING", "time" : "2020-12-15T08:53:01.868+0000", "content" : "W NETWORK [LogicalSessionCacheReap] Unable to reach primary for set replica" } ], "total_count" : 1 }

URI GET https://{Endpoint}/v3/{project_id}/instances/{instance_id}/error-log 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户在某一Region下的Project ID。获取方法请参见获取项目ID。 instance_id 是 String 实例ID，可以调用查询实例列表和详情接口获取。如果未申请实例，可以调用创建实例接口创建。 表2 Query参数 参数 是否必选 参数类型 描述 start_time 是 String 开始时间，格式为“yyyy-mm-ddThh:mm:ssZ”。 其中，T指某个时间的开始，Z指时区偏移量，例如北京时间偏移显示为+0800。 开始时间最多不能比当前时间早30天。 end_time 是 String 结束时间，格式为“yyyy-mm-ddThh:mm:ssZ”。 其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。 只能查询当前时间前一个月内的错误日志。 结束时间不能晚于当前时间。 node_id 否 String 节点ID，取空值，表示查询实例下所有允许查询的节点。 type 否 String 语句类型，取空值，表示查询所有语句类型。也可指定如下日志类型： Warning Error offset 否 Integer 索引位置，偏移量。 取值范围为 [0, 1999]。从第一条数据偏移offset条数据后开始查询，默认为0（偏移0条数据，表示从第一条数据开始查询）。 必须为数字，不能为负数。 limit 否 Integer 查询记录数。 取值范围[1, 100]，默认10 （表示默认返回10条数据）。 limit与offset的和需要满足小于等于2000的条件。

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 policy object 磁盘自动扩容策略。 自动扩容策略关闭时，接口无信息返回。 详情请参考表4。 表4 AutoEnlargePolicy 参数 参数类型 描述 threshold Integer 触发自动扩容阈值。 step Integer 扩容步长（step%），当触发自动扩容的时候，自动扩容当前存储空间的step%（若计算出的扩容大小非10的倍数，则向上取整至10的倍数。默认一次最小100GB）。 说明： 账户余额不足时，会导致包年包月实例扩容失败。 size Integer 实例通过自动扩容所能达到的存储空间上限，单位：GB。

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

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

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户token。 表3 请求Body参数 参数 是否必选 参数类型 描述 port 是 Integer 新端口号。 GeminiDB Mongo副本集4.0数据库实例端口有效范围为2100~9500，暂不支持8636、8637和8638。 GeminiDB Cassandra数据库实例端口有效范围为2100~9500，暂不支持7000，7001，7199，8636，8479，8484，8999，8018，2180，2887，3887，8079，8091，8092。 GeminiDB Redis数据库实例端口有效范围为1024~65535,暂不支持2180、2887、3887、6377、6378、6380、8018、8079、8091、8479、8484、8999、12017、12333、50069。

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

请求示例 URI样例 POST https://gaussdb-nosql.cn-north-7.myhuaweicloud.com/v3/0549b4a43100d4f32f51c01c2fe4acdb/instances/d58c24da5c2d445f87dc8d697ab3ccb7in12/disaster-recovery/data-synchronization 请求体样例 暂停容灾实例数据同步的请求体示例： {"action":"pause"} 恢复容灾实例数据同步的请求体示例： {"action":"resume"}

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

请求示例 URI样例 PUT https://gaussdb-nosql.cn-north-7.myhuaweicloud.com/v3/375d8d8fad1f43039e23d3b6c0f60a19/instances/9136fd2a9fcd405ea4674276ce36dae8in10/slowlog-desensitization 关闭脱敏状态 { "desensitization_status" : "off" }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户token。 表3 请求Body参数 参数 是否必选 参数类型 描述 size 是 Integer 待扩容后冷存储空间大小，单位：GB。 用户每次至少选择1GB扩容量，且必须为整数。 待扩容后的冷数据存储空间最大规格为100000GB。 is_auto_pay 否 String 扩容包年/包月实例的冷数据存储容量时可指定，表示是否自动从账户中支付，此字段不影响自动续订的支付方式。 true，表示自动从账户中支付。 false，表示手动从账户中支付，默认为该方式。

请求示例 URI样例 PUT https://gaussdb-nosql.cn-north-7.myhuaweicloud.com/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/944bdc55da6c4b33b260b34185ac86bein13/cold-volume 扩容实例的冷数据存储空间至1000GB { "size" : 1000 }

请求示例 URI样例 POST https://gaussdb-nosql.cn-north-7.myhuaweicloud.com/v3/375d8d8fad1f43039e23d3b6c0f60a19/configurations/e02e76567ae04662a2753492b77f965bpr06/copy 复制参数模板 { "name" : "paramsGroup-2434", "description" : "复制参数模板" }

响应示例 状态码： 200 Success. { "instance_id" : "094424666ef04f79a2dfbe9f5b8b31a5in06", "instance_name" : "geminidb_instance_noreuse_0_ZKv2FSkxgoc3F8bGzsaxNg", "current_flavor" : { "vcpus" : "4", "ram" : "16", "spec_code" : "geminidb.cassandra.xlarge.4", "az_status" : { "az2***" : "unknown", "az1***" : "normal", "az3***" : "unknown" }, "region_status" : null }, "optional_flavors" : { "list" : [ { "vcpus" : "2", "ram" : "8", "spec_code" : "geminidb.cassandra.large.4", "az_status" : { "az2***" : "unknown", "az1***" : "normal", "az4***" : "normal", "az3***" : "unknown" }, "region_status" : "normal" }, { "vcpus" : "8", "ram" : "32", "spec_code" : "geminidb.cassandra.2xlarge.4", "az_status" : { "az2***" : "unknown", "az1***" : "normal", "az3***" : "unknown" }, "region_status" : "normal" }, { "vcpus" : "16", "ram" : "64", "spec_code" : "geminidb.cassandra.4xlarge.4", "az_status" : { "az2***" : "unknown", "az1***" : "normal", "az3***" : "unknown" }, "region_status" : "normal" }, { "vcpus" : "32", "ram" : "128", "spec_code" : "geminidb.cassandra.8xlarge.4", "az_status" : { "az2***" : "unknown", "az1***" : "normal", "az3***" : "unknown" }, "region_status" : "normal" } ], "total_count": 4 } }

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

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户token。 表3 请求Body参数 参数 是否必选 参数类型 描述 size 是 Integer 创建的冷数据存储大小，单位：GB。 最小申请规格为500GB，最大申请规格为100000GB。 is_auto_pay 否 String 创建包年/包月实例的冷数据存储时可指定，表示是否自动从账户中支付，此字段不影响自动续订的支付方式。 true，表示自动从账户中支付。 false，表示手动从账户中支付，默认为该方式。

URI GET https://{Endpoint}/v3/{project_id}/backups 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 用户在某一region下的project ID。获取方法请参见获取项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 offset 是 Integer 分页页码。 最小值：1 limit 是 Integer 每页条数。 最小值：1 最大值：100 datastore_type 否 String 接口类型不传该参数时则查询所有的接口。 枚举值： cassandra mongodb redis influxdb type 否 String 备份策略类型。可取值： Instance，表示查询实例级备份。 DatabaseTable，表示查询库表级备份，仅GeminiDB Cassandra支持。 默认取值“Instance”。 instance_id 否 String 实例ID。不传该参数则查询所有备份列表。 backup_id 否 String 备份ID。 backup_type 否 String 备份类型。 枚举值： Auto：自动全量备份 Manual：手动全量备份。 Incremental：增量备份。 Differential：差异备份。 begin_time 否 String 查询备份开始的时间，格式为“yyyy-mm-dd hh:mm:ss”。该时间为UTC时间。 end_time 否 String 查询备份开始的结束时间，格式为“yyyy-mm-dd hh:mm:ss”。该时间为UTC时间。

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 total_count Long 总记录数。 backups Array of objects 备份信息列表。详情请参考表5。 表5 backups 参数 参数类型 描述 id String 备份ID。 name String 备份名称。 description String 备份描述信息。 begin_time String 备份开始时间，格式为“yyyy-mm-dd hh:mm:ss”。该时间为UTC时间。 end_time String 备份结束时间，格式为“yyyy-mm-dd hh:mm:ss”。该时间为UTC时间。 status String 备份状态。 枚举值： BUILDING：备份中。 COMPLETED：备份完成。 FAILED：备份失败。 size Double 备份大小，单位：KB。 type String 备份类型。 枚举值： Auto：自动全量备份。 Manual：手动全量备份。 instance_id String 实例ID。 instance_name String 实例名称。 datastore object 数据库信息。详情请参考表6。 表6 datastore 参数 参数类型 描述 type String 数据库类型。 version String 数据库版本。

请求示例 URI样例 GET https://gaussdb-nosql.cn-north-7.myhuaweicloud.com/v3/054b61972980d4552f0bc00ac8d3f5cd/backups?instance_id=c0c9f155c7b7423a9d30f0175998b63bin01&offset=2&limit=2&begin_time=2018-07-06 10:41:14&end_time=2018-08-16 10:41:14&type=DatabaseTable 数据备份的增量备份文件大小和记录 GET https://{Endpoint}/v3/2900b7b8d03e4619b8db8d43bc6234ee/backups?offset=1&limit=5&backup_type=Incremental&instance_id=3149aee486d748f68db1ee81e95b9f56in06 数据备份的差异备份文件大小和记录 GET https://{Endpoint}/v3/2900b7b8d03e4619b8db8d43bc6234ee/backups?offset=1&limit=5&backup_type=Differential&instance_id=3149aee486d748f68db1ee81e95b9f56in06 请求体样例 无。

响应示例 状态码： 200 Success { "total_count" : 4, "backups" : [ { "id" : "43e4feaab48f11e89039fa163ebaa7e4br01", "name" : "backup-test", "instance_id" : "43e4feaab48f11e89039fa163ebaa7e4br01", "instance_name" : "cluster-test", "datastore" : { "type" : "cassandra", "version" : "3.4" }, "type" : "Auto", "begin_time" : "2018-08-06 12:41:14", "end_time" : "2018-08-06 12:43:14", "status" : "COMPLETED", "size" : 2803, "description" : "backup description", }, { "id" : "43e4feaab48f11e89039fa163ebaa7e4br02", "name" : "backup-test-2", "instance_id" : "43e4feaab48f11e89039fa163ebaa7e4br02", "instance_name" : "cluster-test", "datastore" : { "type" : "cassandra", "version" : "3.4" }, "type" : "Manual", "begin_time" : "2018-08-06 12:41:14", "end_time" : "2018-08-06 12:43:14", "status" : "COMPLETED", "size" : 2803, "description" : "backup description", } ] }

URI GET https://{Endpoint}/v3/{project_id}/ip-num-requirement 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户在某一region下的project ID。获取方法请参见获取项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 node_num 是 Integer 创建实例或扩容节点的个数。最大支持输入200。 engine_name 否 String 数据库接口名称。没有传入实例ID的时候该字段为必传。 取值为“cassandra”，表示GeminiDB Cassandra数据库接口。 取值为“mongodb”，表示GeminiDB Mongo数据库接口。 取值为“influxdb”，表示GeminiDB Influx数据库接口。 取值为“redis”，表示GeminiDB Redis数据库接口。 instance_mode 否 String 实例类型。没有传入实例ID的时候该字段为必传。 取值为“Cluster”，表示GeminiDB Cassandra、GeminiDB Influx、GeminiDB Redis集群实例类型。 取值为“ReplicaSet”，表示GeminiDB Mongo副本集实例类型。 instance_id 否 String 实例ID，可以调用查询实例列表和详情接口获取。如果未申请实例，可以调用创建实例接口创建。

请求示例 URI样例 POST https://gaussdb-nosql.cn-north-7.myhuaweicloud.com/v3/375d8d8fad1f43039e23d3b6c0f60a19/configurations/comparison 比较源参数模板和目标参数模板 { "source_configuration_id" : "0764fdcd949b411ba76c2b762b80c212pr06", "target_configuration_id" : "fa42c57bb62844e490052f2ff9d5a264pr06" }

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

响应示例 状态码： 200 Success { "datastores" : [ { "datastore_name" : "mongodb", "mode": "ReplicaSet", "version" : "4.0" }, { "datastore_name" : "influxdb", "mode": "InfluxdbCluster", "version" : "1.7" }, { "datastore_name" : "cassandra", "mode": "ReplicaCircle", "version" : "3.11" } ] }

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 datastores Array of 表4 objects 数据库接口信息。 表4 DataStoreList 参数 参数类型 描述 datastore_name String 数据库接口。 version String 数据库接口版本。 mode String 实例类型。 取值为“Cluster”,表示GeminiDB Cassandra、GeminiDB Influx、GeminiDB Redis集群实例类型。 取值为“InfluxdbSingle”,表示GeminiDB Influx单节点实例类型。 取值为“ReplicaSet”,表示GeminiDB Mongo副本集实例类型。

请求示例 开启磁盘自动扩容策略 URI样例 POST https://gaussdb-nosql.cn-north-7.myhuaweicloud.com/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/disk-auto-expansion 开启磁盘自动扩容策略，设置自动扩容阈值为90，扩容步长为10%，通过自动扩容所能达到的存储空间上限为600GB { "instance_ids" : [ "93e4b3eda14349b1b870f72829bc3b9bin06" ], "policy" : { "threshold" : 90, "step" : 10, "size" : 600 } } 关闭磁盘自动扩容策略 URI样例 POST https://gaussdb-nosql.cn-north-7.myhuaweicloud.com/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/disk-auto-expansion 关闭磁盘自动扩容策略 { "instance_ids" : [ "93e4b3eda14349b1b870f72829bc3b9bin06" ], "switch_option":"off" }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户token。 表3 请求Body参数 参数 是否必选 参数类型 描述 client_network_ranges 是 Array of strings 客户端所在网段。 跨网段访问配置只有在客户端与副本集实例部署在不同网段的情况下才需要配置，例如访问副本集的客户端所在网段为192.168.0.0/16，副本集所在的网段为172.16.0.0/24，则需要添加跨网段配置192.168.0.0/16才能正常访问。 例如配置的源端网段为192.168.0.0/xx，则xx的输入值必须在8到32之间。 源端E CS 连接实例的前提是与实例节点网络通信正常，如果网络不通，可以参考对等连接进行相关配置。

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