华为云用户手册

请求示例 URI样例 查询所有实例列表和详情 GET https://gaussdb-nosql.cn-north-4.myhuaweicloud.com/v3/0483b6b16e954cb88930a360d2c4e663/instances URI样例 根据指定条件查询实例列表和详情 GET https://gaussdb-nosql.cn-north-4.myhuaweicloud.com/v3/0483b6b16e954cb88930a360d2c4e663/instances?offset=0&limit=10&id=ed7cc6166ec24360a5ed5c5c9c2ed726in06&name=hy&mode=Cluster&datastore_type=cassandra&vpc_id=19e5d45d-70fd-4a91-87e9-b27e71c9891f&subnet_id=bd51fb45-2dcb-4296-8783-8623bfe89bb7

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 instances Array of ListInstancesResult objects 参数解释： 实例信息。 total_count Integer 参数解释： 总记录数。 取值范围： 不涉及。 表5 ListInstancesResult 参数 参数类型 描述 id String 参数解释： 实例ID。 取值范围： 不涉及。 name String 参数解释： 实例名称。 取值范围： 不涉及。 status String 参数解释： 实例状态。 取值范围： normal，表示实例正常。 abnormal，表示实例异常。 creating，表示实例创建中。 frozen，表示实例被冻结。 data_disk_full，表示实例磁盘已满。 createfail，表示实例创建失败。 enlargefail，表示实例扩容节点个数失败。 port String 参数解释： 数据库端口。 取值范围： 不涉及。 mode String 参数解释： 实例类型。 取值范围： 与请求参数相同。 product_type String 参数解释： 产品类型。GeminiDB Redis云原生部署模式集群涉及此字段。 取值范围： Standard 标准型 Capacity 容量型 region String 参数解释： 实例所在区域。 取值范围： 不涉及。 datastore ListInstancesDatastoreResult object 参数解释： 数据库信息。 engine String 参数解释： 存储引擎。 取值范围： “rocksDB”。 created String 参数解释： 实例创建时间。 取值范围： 不涉及。 updated String 参数解释： 实例操作最新变更的时间。 取值范围： 不涉及。 db_user_name String 参数解释： 默认用户名。 取值范围： “rwuser”。 vpc_id String 参数解释： 虚拟私有云ID。 取值范围： 不涉及。 subnet_id String 参数解释： 子网ID。 取值范围： GeminiDB Cassandra 实例使用多个子网的场景，请参见表 ListInstancesNodeResult字段数据结构说明中的“subnet_id”。 security_group_id String 参数解释： 安全组ID。 取值范围： 不涉及。 backup_strategy ListInstancesBackupStrategyResult object 参数解释： 备份策略。 pay_mode String 参数解释： 计费方式。 取值范围： 取值为“0”，表示按需计费。 取值为“1”，表示包年/包月计费。 maintenance_window String 参数解释： 系统可维护时间窗。 取值范围： 不涉及。 groups Array of ListInstancesGroupResult objects 参数解释： 组信息。 enterprise_project_id String 参数解释： 企业项目ID。 取值范围： “0”，表示为default企业项目。 time_zone String 参数解释： 时区。 取值范围： 不涉及。 actions Array of strings 参数解释： 实例正在执行的动作。示例： CREATE REBOOT RESTORE dedicated_resource_id String 参数解释： 专属资源ID，只有数据库实例属于专属资源池才会返回该参数。 取值范围： 不涉及。 lb_ip_address String 参数解释： 负载均衡IP。 约束限制： 只有存在负载均衡IP，才会返回该参数。 取值范围： 不涉及。 lb_port String 参数解释： 负载均衡端口。 约束限制： 只有存在负载均衡ip，才会返回该参数。 取值范围： 不涉及。 availability_zone String 参数解释： 实例可用区。 取值范围： 不涉及。 表6 ListInstancesDatastoreResult 参数 参数类型 描述 type String 参数解释： 数据库接口。 取值范围： 不涉及。 version String 参数解释： 数据库版本号。 取值范围： 不涉及。 patch_available Boolean 参数解释： 当前实例是否有可升级的补丁。 取值范围： true，可以通过升级补丁接口进行数据库升级。 false，不可以通过升级补丁接口进行数据库升级。 whole_version String 参数解释： 数据库的完整版本号。 约束限制： 目前只有GeminiDB Cassandra支持 取值范围： 不涉及。 表7 ListInstancesBackupStrategyResult 参数 参数类型 描述 start_time String 参数解释： 备份时间段。自动备份将在该时间段内触发。当前时间指UTC时间。 取值范围： 不涉及。 keep_days Integer 参数解释： 已生成备份文件可以保存的天数。 取值范围： 0~35。 表8 ListInstancesGroupResult 参数 参数类型 描述 id String 参数解释： 组ID。 取值范围： 不涉及。 status String 参数解释： 组状态。 取值范围： normal，表示组正常。 abnormal，表示组异常。 creating，表示组创建中。 createfail，表示组创建失败。 deleted，表示组被删除。 resizefailed，表示组规格变更失败。 enlargefail，表示组扩容失败。 volume Volume object 参数解释： volume信息 nodes Array of ListInstancesNodeResult objects 参数解释： 节点信息。 表9 Volume 参数 参数类型 描述 size String 参数解释： 磁盘大小。单位：GB。 取值范围： 不涉及。 used String 参数解释： 磁盘使用量。单位：GB。 取值范围： 不涉及。 表10 ListInstancesNodeResult 参数 参数类型 描述 id String 参数解释： 节点ID。 取值范围： 不涉及。 name String 参数解释： 节点名称。 取值范围： 不涉及。 status String 参数解释： 节点状态。 取值范围： normal，表示节点正常。 abnormal，表示节点异常。 creating，表示节点创建中。 createfail，表示节点创建失败。 deleted，表示节点被删除。 resizefailed，表示节点规格变更失败。 enlargefail，表示节点扩容失败。 role String 参数解释： 节点角色。 约束限制： 该参数仅对GeminiDB Mongo接口的副本集实例有效。 取值范围： 不涉及。 subnet_id String 参数解释： 节点所在的子网的ID。 取值范围： 不涉及。 private_ip String 参数解释： 节点内网IP。 约束限制： 在弹性云服务器创建成功后参数值存在，否则，值为""。 取值范围： 不涉及。 public_ip String 参数解释： 绑定的公网IP。 约束限制： 该参数仅针对绑定了公网IP的节点有效。 取值范围： 不涉及。 spec_code String 参数解释： 资源规格编码。关于实例的规格信息，请参见查询数据库规格中响应参数“flavors.spec_code”的值。 取值范围： 不涉及。 availability_zone String 参数解释： 可用区。 取值范围： 不涉及。 support_reduce Boolean 参数解释： 是否支持节点缩容。 取值范围： true，表示该节点支持节点缩容。 false，表示该节点不支持节点缩容。 表11 DualActiveInfo 参数 参数类型 描述 role String 参数解释： 双活角色。 取值范围： 不涉及。 status String 参数解释： 双活状态。 取值范围： 不涉及。 destination_instance_id String 参数解释： 双活对端实例id。 取值范围： 不涉及。 destination_region String 参数解释： 双活对端region。 取值范围： 不涉及。

URI GET https://{Endpoint}/v3/{project_id}/instances 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 参数解释： 租户在某一region下的project ID。获取方法请参见获取项目ID。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 表2 Query参数 参数 是否必选 参数类型 描述 id 否 String 参数解释： 实例ID。 约束限制： 如果id以“*”起始，表示按照“*”后面的值模糊匹配，否则，按照实际填写的id精确匹配查询。 取值范围： 不涉及。 默认取值： 不涉及。 name 否 String 参数解释： 实例名称。 约束限制： 如果name以“*”起始，表示按照“*”后面的值模糊匹配，否则，按照实际填写的name精确匹配查询。 说明： 如果实例名称中包含中文，暂时不支持通过中文模糊搜索。 取值范围： 不涉及。 默认取值： 不涉及。 datastore_type 否 String 参数解释： 数据库类型。 约束限制： 不涉及。 取值范围： 取值为“cassandra”，表示查询GeminiDB Cassandra数据库实例。 取值为“mongodb”，表示GeminiDB Mongo查询数据库实例。 取值为“influxdb”，表示查询GeminiDB Influx数据库实例。 取值为“redis”，表示查询GeminiDB Redis数据库实例。 默认取值： 如果不传该参数，表示查询所有数据库实例。 mode 否 String 参数解释： 实例类型。 约束限制： 不涉及。 取值范围： 取值为“Cluster”，表示GeminiDB Cassandra、GeminiDB Influx、GeminiDB Redis 经典部署模式Proxy集群实例类型。 取值为“CloudNativeCluster”，表示GeminiDB Cassandra、GeminiDB Influx、GeminiDB Redis云原生部署模式集群实例类型。 取值为“RedisCluster”，表示GeminiDB Redis 经典部署模式Cluster集群实例类型。 取值为“Replication”，表示GeminiDB Redis经典部署模式主备实例类型。 取值为“InfluxdbSingle”，表示GeminiDB Influx经典部署模式单节点实例类型。 取值为“ReplicaSet”，表示GeminiDB Mongo副本集实例类型。 如果不传datastore_type参数，自动忽略该参数设置。 默认取值： 不涉及。 vpc_id 否 String 参数解释： 虚拟私有云ID，获取方法如下： 方法1：登录虚拟私有云服务的控制台界面，在虚拟私有云的详情页面查找VPC ID。 方法2：通过虚拟私有云服务的API接口查询，具体操作可参考查询VPC列表。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 subnet_id 否 String 参数解释： 子网的网络ID，获取方法如下： 方法1：登录虚拟私有云服务的控制台界面，单击VPC下的子网，进入子网详情页面，查找网络ID。 方法2：通过虚拟私有云服务的API接口查询，具体操作可参考查询子网列表。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 offset 否 Integer 参数解释： 索引位置偏移量，表示从指定project ID下最新的实例创建时间开始，按时间的先后顺序偏移offset条数据后查询对应的实例信息。 约束限制： 不涉及。 取值范围： 取值大于或等于0。 默认取值： 不传该参数时，查询偏移量默认为0，表示从最新的实例创建时间对应的实例开始查询。 limit 否 Integer 参数解释： 查询实例个数上限值。 约束限制： 不涉及。 取值范围： 1~100。 默认取值： 不传该参数时，默认查询前100条实例信息。

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 job_id String 任务ID。 状态码： 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。 状态码： 500 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。

请求示例 清除指定DB的数据 PUT https://{endpoint}/v3/0549b4a43100d4f32f51c01c2fe4acdb/instances/e73893ef73754465a8bd2e0857bbf13ein12/databases { "action" : "flush", "db_id" : 1 } 清除所有数据 PUT https://{endpoint}/v3/0549b4a43100d4f32f51c01c2fe4acdb/instances/e73893ef73754465a8bd2e0857bbf13ein12/databases { "action" : "flush" }

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。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。

响应参数 状态码： 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}/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的条件。

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

响应示例 状态码： 202 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 }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 参数解释： 用户Token。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 表3 请求Body参数 参数 是否必选 参数类型 描述 ssl_option 是 String 参数解释： ssl开关选项。 约束限制： 不涉及。 取值范围： on：表示实例默认开启SSL连接。 off：表示实例默认不启用SSL连接。 默认取值： 不涉及。

URI POST https://{Endpoint}/v3/{project_id}/instances/{instance_id}/ssl-option 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 参数解释： 用户在某一region下的project ID。获取方法请参见获取项目ID。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 instance_id 是 String 参数解释： 实例ID。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。

请求示例 开启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参数 参数 是否必选 参数类型 描述 client_network_ranges 是 Array of strings 参数解释： 客户端所在网段。 约束限制： 源端E CS 连接实例的前提是与实例节点网络通信正常，如果网络不通，可以参考对等连接进行相关配置。 取值范围： 跨网段访问配置只有在客户端与副本集实例部署在不同网段的情况下才需要配置，例如访问副本集的客户端所在网段为192.168.0.0/16，副本集所在的网段为172.16.0.0/24，则需要添加跨网段配置192.168.0.0/16才能正常访问。 例如配置的源端网段为192.168.0.0/xx，则xx的输入值必须在8到32之间。 默认取值： 不涉及。

请求示例 URI样例 POST https://gaussdb-nosql.cn-north-7.myhuaweicloud.com/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/9136fd2a9fcd405ea4674276ce36dae8in10/client-network 修改客户端所在网段为"192.168.0.0/16" { "client_network_ranges" : [ "192.168.0.0/16" ] }

URI POST https://{Endpoint}/v3/{project_id}/instances/{instance_id}/client-network 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 参数解释： 租户在某一Region下的project ID。获取方法请参见获取项目ID。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 instance_id 是 String 参数解释： 实例ID。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。

URI POST https://{Endpoint}/v3/{project_id}/instances/{instance_id}/cold-volume 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 参数解释： 租户在某一region下的project ID。获取方法请参见获取项目ID。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 instance_id 是 String 参数解释： 实例ID。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。

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

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

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

请求示例 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 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" } 创建包周期实例响应样例：

响应参数 状态码： 202 表12 响应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，只有创建在专属资源上的实例才会返回该字段。 表13 Datastore 参数 参数类型 描述 type String 数据库类型。 支持GeminiDB Cassandra、GeminiDB Mongo、GeminiDB Influx和GeminiDB Redis数据库实例。 取值为“cassandra”，表示创建GeminiDB Cassandra数据库实例。 取值为“mongodb”，表示创建GeminiDB Mongo数据库实例。 取值为“influxdb”，表示创建GeminiDB Influx数据库实例。 取值为“redis”，表示创建GeminiDB Redis数据库实例。 取值为“dynamodb”，表示创建GeminiDB DynamoDB数据库实例。 取值为“hbase”，表示创建GeminiDB Hbase数据库实例。 version String 数据库版本。 GeminiDB Cassandra实例支持3.11版本，取值为“3.11”。 GeminiDB Mongo实例支持4.0版本，取值为“4.0”。 GeminiDB Influx经典部署模式实例支持1.8版本，取值为“1.8”。 GeminiDB Influx云原生部署模式实例支持1.7版本，取值为“1.7”。 GeminiDB Redis实例支持5.0版本，取值为“5.0”。 GeminiDB DynamoDB取值为“”。 GeminiDB HBase取值为“”。 storage_engine String 存储引擎。 GeminiDB Cassandra实例支持RocksDB存储引擎，取值为“rocksDB”。 GeminiDB Mongo实例支持RocksDB存储引擎，取值为“rocksDB”。 GeminiDB Influx实例支持RocksDB存储引擎，取值为“rocksDB”。 GeminiDB Redis实例支持RocksDB存储引擎，取值为“rocksDB”。 表14 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”的值。 表15 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天。 表16 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 Cassandra支持云原生部署模式集群类型，取值“CloudNativeCluster”。 GeminiDB Mongo 4.0版本支持副本集类型，取值为“ReplicaSet”。 GeminiDB Influx支持经典部署模式集群类型，取值为“Cluster”。 GeminiDB Influx支持云原生部署模式集群类型，取值为“CloudNativeCluster”。 GeminiDB Influx支持单节点类型，取值为“InfluxdbSingle”。 GeminiDB Redis支持经典部署模式Proxy集群类型，取值为“Cluster”。 GeminiDB Redis支持云原生部署模式集群类型，取值为“CloudNativeCluster”。 GeminiDB Redis支持经典部署模式Cluster集群类型，取值为“RedisCluster”。Cluster集群实例类型介绍请参见创建实例。 GeminiDB Redis支持经典部署模式主备类型，取值为“Replication”。 product_type 否 String 产品类型。 Capacity 容量型 Standard 标准型 当创建GeminiDB Redis云原生部署模式集群类型必传此参数。 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、9864、9866、9867、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数据库实例。 取值为“dynamodb”，表示创建GeminiDB DynamoDB数据库实例。 取值为“hbase”，表示创建GeminiDB HBase数据库实例。 version 是 String 数据库版本。 GeminiDB Cassandra实例支持3.11版本，取值为“3.11”。 GeminiDB Mongo实例支持4.0版本，取值为“4.0”。 GeminiDB Influx经典部署模式集群实例支持1.8版本，取值为“1.8”。 GeminiDB Influx云原生部署模式实例支持1.7版本，取值为“1.7”。 GeminiDB Redis实例支持5.0版本，取值为“5.0”。 GeminiDB DynamoDB实例取值为“”。 GeminiDB HBase实例取值为“”。 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 备可用区，应为单可用区且和主可用区不同。 表10 LbAccessControlSettings 参数 是否必选 参数类型 描述 enabled 是 Boolean true 开启，false 关闭。 枚举值： true false type 是 String 黑白名单类型，blackList黑名单，whiteList白名单，仅支持设置黑名单或白名单中的一种。 枚举值： blackList whiteList ip_groups 是 Array of 表11 objects IP地址组中包含的IP或网段列表。 表11 IpGroupsDetail 参数 是否必选 参数类型 描述 ip 是 String IP地址或网段。支持IPv4。 description 是 String 备注信息，最大长度255个字符。

接口约束 该接口支持如下数据库实例： GeminiDB Cassandra GeminiDB Mongo GeminiDB Influx GeminiDB Redis GeminiDB HBase GeminiDB DynamoDB 该接口既支持包周期实例，也支持按需实例。 目前仅GeminiDB Cassandra和GeminiDB Influx集群支持恢复指定实例的指定时间点的数据到新建实例。

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 经典部署模式Proxy集群实例类型。 取值为“CloudNativeCluster”，表示GeminiDB Cassandra、GeminiDB Influx、GeminiDB Redis云原生部署模式集群实例类型。 取值为“RedisCluster”，表示GeminiDB Redis Cluster经典部署模式集群实例类型。 取值为“Replication”，表示GeminiDB Redis经典部署模式主备实例类型。 取值为“InfluxdbSingle”，表示GeminiDB Influx经典部署模式单节点实例类型。 取值为“ReplicaSet”，表示GeminiDB Mongo副本集实例类型。 默认取值： 不涉及。 instance_id 否 String 参数解释： 实例ID。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。

请求示例 URI样例 GET https://gaussdb-nosql.cn-north-7.myhuaweicloud.com/v3.1/ 054b61972980d4552f0bc00ac8d3f5cd/backups?instance_id=c0c9f155c7b7423a9d30f0175998b63bin01&offset=2&limit=2&begin_time=2019-05-27T03:38:51+0000&end_time=2019-05-28T03:38:51+0000&type=DatabaseTable 请求体样例 无。

响应示例 状态码： 202 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" : "2019-05-27T03:38:51+0000", "end_time" : "2019-05-27T03:39:51+0000", "status" : "COMPLETED", "size" : 2803, "description" : "backup description", "database_tables" : [ { "database_name" : "DATABASE_X", "table_names" : [ "TABLE_A", "TABLE_B", "TABLE_C" ] }, { "database_name" : "DATABASE_Y", "table_names" : null } ] }, { "id" : "43e4feaab48f11e89039fa163ebaa7e4br02", "name" : "backup-test-2", "instance_id" : "43e4feaab48f11e89039fa163ebaa7e4br02", "instance_name" : "cluster-test", "datastore" : { "type" : "cassandra", "version" : "3.4" }, "type" : "Manual", "begin_time" : "2019-05-27T03:38:51+0000", "end_time" : "2019-05-27T03:39:51+0000", "status" : "COMPLETED", "size" : 2803, "description" : "backup description", "database_tables" : [ { "database_name" : "DATABASE_X", "table_names" : [ "TABLE_A", "TABLE_B", "TABLE_C" ] }, { "database_name" : "DATABASE_Y", "table_names" : null } ] } ] }

URI GET https://{Endpoint}/v3.1/{project_id}/backups 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 参数解释： 租户在某一region下的project ID。获取方法请参见获取项目ID。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 表2 Query参数 参数 是否必选 参数类型 描述 instance_id 否 String 参数解释： 实例ID。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 datastore_type 否 String 参数解释： 数据库类型。 约束限制： 不涉及。 取值范围： cassandra redis mongodb influxdb 默认取值： 不涉及。 backup_id 否 String 参数解释： 备份ID。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 backup_type 否 String 参数解释： 备份类型。 约束限制： 大小写敏感。 取值范围： 取值为“Auto”，表示自动全量备份。 取值为“Manual”，表示手动全量备份。 默认取值： 当该字段未传入值时，默认只查询所有的全量备份(包含库表级)，包括自动全备备份和手动全量备份。 type 否 String 参数解释： 备份策略类型。 约束限制： 不涉及。 取值范围： Instance 表示查询实例级备份。 DatabaseTable 表示查询库表级备份。 默认取值： Instance。 limit 否 Integer 参数解释： 查询备份个数上限值。 约束限制： 不涉及。 取值范围： 1-100。 默认取值： 不传该参数时，默认查询前100条实例信息。 offset 否 Integer 参数解释： 索引位置偏移量，表示从指定project ID下最新的备份创建时间开始，按时间的先后顺序偏移offset条数据后查询对应的备份信息。 约束限制： 不涉及。 取值范围： 取值大于或等于0。 默认取值： 不传该参数时，查询偏移量默认为0，表示从最新的备份创建时间对应的备份开始查询。 begin_time 否 String 参数解释： 查询备份开始的时间。 约束限制： 当“end_time”有值时，“begin_time”必选。 取值范围： 为yyyy-mm-ddThh:mm:ssZ字符串格式，T指某个时间的开始，Z指时区偏移量，默认为空。 默认取值： 空值。 end_time 否 String 参数解释： 查询备份开始的结束时间。 约束限制： 当“begin_time”有值时，“end_time”必选。 取值范围： 为yyyy-mm-ddThh:mm:ssZ字符串格式，T指某个时间的开始，Z指时区偏移量，默认为空。 默认取值： 空值。

响应参数 状态码： 202 表4 响应Body参数 参数 参数类型 描述 total_count Integer 参数解释： 备份总数量。 取值范围： 不涉及。 backups Array of objects 参数解释： 备份详情列表。详情请参考表5。 表5 Backup 参数 参数类型 描述 id String 参数解释： 备份ID。 取值范围： 不涉及。 description String 参数解释： 备份描述信息。 取值范围： 不涉及。 instance_id String 参数解释： 备份所属的实例ID。 取值范围： 不涉及。 instance_name String 参数解释： 备份所属的实例名称。 取值范围： 不涉及。 datastore object 参数解释： 数据库版本信息。详情请参考表6。 name String 参数解释： 备份名称。 取值范围： 不涉及。 type String 参数解释： 备份类型。 取值范围： 取值为“Auto”，表示自动全量备份。 取值为“Manual”，表示手动全量备份。 size Double 参数解释： 备份大小，单位：KB。 取值范围： 不涉及。 status String 参数解释： 备份状态。 取值范围： BUILDING：备份中。 COMPLETED：备份完成。 FAILED：备份失败。 begin_time String 参数解释： 备份开始时间。 约束限制： 为yyyy-mm-ddThh:mm:ssZ字符串格式，T指某个时间的开始，Z指时区偏移量。 end_time String 参数解释： 备份结束时间。 约束限制： 为yyyy-mm-ddThh:mm:ssZ字符串格式，T指某个时间的开始，Z指时区偏移量。 database_tables Array of objects 参数解释： 备份里的库表信息。详情请参考表7。 约束限制： 实例级查询时该字段为空，可忽略。 库表级查询时该字段非空（存在库表级备份的话）。 表6 Datastore 参数 参数类型 描述 type String 参数解释： 数据库类型。 取值范围： 不涉及。 version String 参数解释： 数据库版本。 取值范围： 不涉及。 表7 QueryDatabaseTableInfo 参数 参数类型 描述 database_name String 参数解释： 数据库名称。 取值范围： 不涉及。 table_names Array of strings 参数解释： 表名称列表。 table_names为空的时候，表示库级别查询。 table_names非空的时候，表示表级别查询。