华为云用户手册

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

请求参数 表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-4.myhuaweicloud.com/v3/375d8d8fad1f43039e23d3b6c0f60a19/instances/9136fd2a9fcd405ea4674276ce36dae8in02/backups/policy 请求体样例 开启或修改自动备份策略，备份周期为"1,2,3,4,5,6"，备份时间段为"01:00-02:00",备份保留天数为7天： { "backup_policy" : { "period" : "1,2,3,4,5,6", "start_time" : "01:00-02:00", "keep_days" : 7 } } 关闭自动备份策略： { "backup_policy" : { "keep_days" : 0 } }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 表3 请求Body参数 参数 是否必选 参数类型 描述 backup_policy 是 object 备份策略对象，包括备份保留的天数和备份开始时间。详情请参考表4。 表4 BackupPolicy 参数 是否必选 参数类型 描述 keep_days 是 Integer 指定已生成的备份文件可以保存的天数。 取值范围：0～35。取0值，表示关闭自动备份策略。 start_time 否 String 备份时间段。自动备份将在该时间段内触发。开启自动备份策略时，该参数必选；关闭自动备份策略时，不传该参数。 取值范围：格式必须为hh:mm-HH:MM，且有效，当前时间指UTC时间。 HH取值必须比hh大1。 mm和MM取值必须相同，且取值必须为00、15、30、45。 取值示例：23:00-00:00。 period 否 String 备份周期配置。自动备份将在每星期指定的天进行。启用自动备份策略时，此参数必选。如果自动备份策略关闭，则不需要传递该参数。 取值范围：格式为半角逗号隔开的数字，数字代表星期。保留天数取值不同，备份周期约束如下： 指定已生成的备份文件可以保存的天数为0天，不传该参数。 指定已生成的备份文件可以保存的天数为1～6天，备份周期全选，取值为：1,2,3,4,5,6,7。 指定已生成的备份文件可以保存的天数为7～35天，备份周期至少选择一周中的一天。示例：1,2,3,4。

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 backup_policy object 备份策略对象，包括备份保留的天数和备份开始时间。详情请参考表5。 表5 ShowBackupPolicyResult 参数 参数类型 描述 keep_days Integer 备份文件可以保存的天数。 start_time String 备份时间段。自动备份将在该时间段内触发。 period String 备份周期配置。自动备份将在每星期指定的天进行。

URI GET https://{Endpoint}/v3.1/{project_id}/instances/{instance_id}/backups/policy 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户在某一region下的project ID。获取方法请参见获取项目ID。 instance_id 是 String 实例ID。 表2 Query参数 参数 是否必选 参数类型 描述 type 否 String 备份策略类型。该参数仅针对GeminiDB Cassandra。可取值： Instance，表示查询实例级备份。 DatabaseTable，表示查询库表级备份。 默认取值“Instance”。

响应示例 状态码： 200 Success 自动备份策略开启： { "backup_policy" : { "keep_days" : 7, "start_time" : "19:00-20:00", "period" : "1,2,4,5,6" } } 自动备份策略关闭： { "backup_policy" : { "keep_days" : 0 } }

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 enabled Boolean true：开启，false：关闭。 type String 类型选项。 取值： whiteList：白名单，只允许指定ip或网段访问。 blackList：黑名单，不允许指定ip或网段访问。 ip_groups Array of objects IP地址组中包含的IP或网段列表。详情请参考表4。 表4 IpGroupItem 参数 参数类型 描述 ip String IP地址或网段。支持IPv4、IPv6。 description String 备注信息。长度：最小长度 0，最大长度 255。

请求示例 ip网段123.123.123.0/24被设置成黑名单 PUT https://{Endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/054e292c9880d4992f02c0196d3ein12/lb/access-control { "type" : "blackList", "enabled" : true, "ip_groups" : [ { "ip" : "123.123.123.0/24", "description" : "test" } ] } 关闭负载均衡黑白名单 PUT https://{Endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/054e292c9880d4992f02c0196d3ein12/lb/access-control { "type" : "blackList", "enabled" : false, "ip_groups" : [ { "ip" : "123.123.123.123", "description" : "test" } ] }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 表3 请求Body参数 参数 是否必选 参数类型 描述 enabled 是 Boolean true：开启，false：关闭。 type 是 String 类型选项。 取值： whiteList：白名单，只允许指定ip或网段访问。 blackList：黑名单，不允许指定ip或网段访问。 ip_groups 是 Array of objects IP地址组中包含的IP或网段列表。详情请参考表4。 表4 IpGroupItem 参数 是否必选 参数类型 描述 ip 是 String IP地址或网段。支持IPv4、IPv6。 description 否 String 备注信息。长度：最小长度 0，最大长度 255。

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 total_count Integer 记录总数。 schedules Array of objects 任务详情。详情请参考表5。 表5 ScheduleDetailInfo 参数 参数类型 描述 job_id String 任务ID。 job_name String 任务名称。对应取值如下： REBOOT：重启实例。 RESIZE_FLAVOR：变更实例的CPU和内存规格。 UPGRADE_DATABASE：补丁升级。 job_status String 任务执行状态。取值： Pending：表示任务未执行。 Running：表示任务正在执行。 Completed：表示任务执行成功。 Failed：表示任务执行失败。 Canceled：表示任务取消执行。 instance_id String 实例ID。 instance_name String 实例名称。 instance_status String 实例状态。取值： Createfail：表示实例创建失败。 Creating：表示实例创建中。 Normal：表示实例正常。 Abnormal：表示实例异常。 Deleted：表示实例已删除。 datastore_type String 数据库类型。 create_time String 任务创建时间，格式为"yyyy-mm-ddThh:mm:ssZ"。其中，T指某个时间的开始；Z指时区偏移量，例如偏移1个小时显示为+0100。 start_time String 任务开始时间，格式为"yyyy-mm-ddThh:mm:ssZ"。其中，T指某个时间的开始；Z指时区偏移量，例如偏移1个小时显示为+0100。 end_time String 任务结束时间，格式为"yyyy-mm-ddThh:mm:ssZ"。其中，T指某个时间的开始；Z指时区偏移量，例如偏移1个小时显示为+0100。

URI GET https://{Endpoint}/v3/{project_id}/scheduled-jobs 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 用户在某一region下的project Id。 表2 Query参数 参数 是否必选 参数类型 描述 job_name 否 String 任务名称，默认为空。对应取值如下： REBOOT：重启实例。 RESIZE_FLAVOR：变更实例的CPU和内存规格。 UPGRADE_DATABASE：补丁升级。 job_status 否 String 任务执行状态，默认为空。取值： Pending：表示任务未执行。 Running：表示任务正在执行。 Completed：表示任务执行成功。 Failed：表示任务执行失败。 Canceled：表示任务取消执行。 instance_id 否 String 实例ID，不传该值默认查询所有符合条件的实例。 start_time 否 String 任务创建起始时间，格式为"yyyy-mm-ddThh:mm:ssZ"。其中，T指某个时间的开始；Z指时区偏移量，例如偏移1个小时显示为+0100，不传该值默认为当前时间前七天。 end_time 否 String 任务创建结束时间，格式为"yyyy-mm-ddThh:mm:ssZ"。其中，T指某个时间的开始；Z指时区偏移量，例如偏移1个小时显示为+0100，不传该值默认为当前时间。 offset 否 Integer 索引位置，偏移量。从第一条数据偏移offset条数据后开始查询，默认为0。 limit 否 Integer 查询记录数。不传该参数时，默认为10，取值范围1-100。

响应示例 状态码： 200 Success { "schedules" : [ { "job_id" : "56d3c1138dcf4f1da73b0170700c78d0", "job_name" : "REBOOT", "job_status" : "Pending", "instance_id" : "8a6117ece8a0457a90060441fa372e8ein06", "instance_name" : "gauss-nosql", "instance_status" : "normal", "datastore_type" : "GeminiDB Cassandra", "create_time" : "2019-05-26T10:41:14+0000", "start_time" : "2019-05-26T12:41:14+0000", "end_time" : "2019-05-26T12:51:14+0000" } ], "total_count" : 1 }

响应示例 状态码： 200 Success { "total_count" : 1, "jobs" : [ { "id" : "6f85e061-04dd-42e7-86d6-d3b1e40aac2e", "name" : "CreateCassandra", "status" : "Running", "start_time" : "2023-09-12T06:44:01+0000", "end_time" : "2023-09-12T06:44:03+0000", "progress" : "14%", "instance" : { "id" : "27a045b6bf9e46f691f81366d398cb04in06", "name" : "nosql-12f5" }, "fail_reason" : "" } ] }

URI GET https://{Endpoint}/v3/{project_id}/jobs 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户在某一region下的project ID。获取方法请参见获取项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 id 否 String 任务ID。 start_time 否 String 查询开始时间，默认当前时间往前30天，格式为“yyyy-mm-ddThh:mm:ssZ”。 其中，T指某个时间的开始，Z指时区偏移量。 end_time 否 String 查询结束时间，默认当前时间，格式为“yyyy-mm-ddThh:mm:ssZ”，且大于查询开始时间，时间跨度不超过30天。 其中，T指某个时间的开始，Z指时区偏移量。 status 否 String 任务状态。取值为“Running”为执行中。取值为“Completed”为完成。取值为“Failed”为失败。 name 否 String 任务名称。对应取值如下： "CreateInstance"：创建实例。 "RestoreNewInstance"：恢复到新实例。 "EnlargeInstance"：扩容实例。 "ReduceInstance"：缩容实例。 "RestartInstance"：重启实例。 "RestartNode"：重启节点。 "EnlargeInstanceVolume"：扩容实例磁盘。 "ReduceInstanceVolume"：缩容实例磁盘。 "ResizeInstance"：规格变更实例。 "UpgradeDbVersion"：升级数据库版本。 "BindPublicIP"：绑定公网IP。 "UnbindPublicIP"：解绑公网IP。 "DeleteInstance"：删除实例。 "EnlargeInstanceColdVolume"：扩容实例冷存储。 "AddInstanceColdVolume"：增加实例冷存储。 "ModifySecurityGroup"：修改安全组。 "ModifyCcmCert"：修改CCM证书。 "ModifyPort"：修改端口。 "ConstructDisasterRecovery"：构造容灾关系。 "DeConstructDisasterRecovery"：解除容灾关系。 "SwitchOverDisasterRecovery"：切换容灾关系。 "BuildBiActiveInstance"：构建双活实例。 "ReleaseBiActiveInstance"：解除双活实例关系。 "BackupInstance"：备份实例。 offset 否 Integer 索引位置，偏移量。 从第一条数据偏移offset条数据后开始查询，默认为0（偏移0条数据，表示从第一条数据开始查询），必须为数字，不能为负数。 limit 否 Integer 查询记录数。取值10，20，50 ，默认为50。

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 jobs Array of 表5 objects 任务列表。 total_count Integer 任务列表总数。 表5 JobDetail 参数 参数类型 描述 id String 任务ID。 name String 任务名称。 status String 任务执行状态。取值： Running：表示任务正在执行。 Completed：表示任务执行成功。 Failed：表示任务执行失败。 start_time String 创建时间，格式为“yyyy-mm-ddThh:mm:ssZ”。 其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。 end_time String 结束时间，格式为“yyyy-mm-ddThh:mm:ssZ”。 其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。 progress String 任务执行进度。 说明： 执行中状态才返回执行进度，例如“60%”，表示任务执行进度为60%，否则返回“”。 instance 表6 object 任务关联的实例信息。 fail_reason String 任务执行失败时的错误信息。 表6 JobInstanceInfo 参数 参数类型 描述 id String 实例ID。 name String 实例名称。

响应示例 状态码： 200 Success. { "total_count" : 2, "disaster_recovery_settings" : [ { "instance_id" : "d74162b942604190b991d1c39772a66ain06", "switchover_ratio" : 50 }, { "instance_id" : "e74162b942604190b991d1c39772a66ain06", "switchover_ratio" : 100 } ] }

请求示例 默认查询50个实例容灾切换的故障节点比例。 GET https://{endpoint}/v3/0549b4a43100d4f32f51c01c2fe4acdb/instances/disaster-recovery/settings 查询实例容灾切换的故障节点比例。 GET https://{endpoint}/v3/0549b4a43100d4f32f51c01c2fe4acdb/instances/disaster-recovery/settings?offset=0&limit=50&instance_id=d74162b942604190b991d1c39772a66ain06&instance_id=e74162b942604190b991d1c39772a66ain06

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 disaster_recovery_settings Array of SwitchoverRatio objects 容灾切换的故障节点比例列表。 total_count Integer 总记录数。 表5 SwitchoverRatio 参数 参数类型 描述 instance_id String 实例ID。 switchover_ratio Integer 容灾切换的故障节点比例，下限是50，步长是10，最大是100，默认为100。 状态码： 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误消息。 状态码： 500 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。

URI GET https://{Endpoint}/v3/{project_id}/instances/disaster-recovery/settings 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户在某一region下的project ID。获取方法请参见获取项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 instance_id 否 String 实例ID。 offset 否 Integer 索引位置偏移量，表示从指定offset条数据后查询对应的实例信息。 取值大于或等于0。不传该参数时，查询偏移量默认为0。 limit 否 Integer 查询实例个数上限值。 取值范围：1~50。不传该参数时，默认查询50条实例信息。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 表3 请求Body参数 参数 是否必选 参数类型 描述 disaster_recovery_settings 否 Array of SwitchoverRatio objects 容灾切换的故障节点比例列表。 表4 SwitchoverRatio 参数 是否必选 参数类型 描述 instance_id 是 String 实例ID。 switchover_ratio 否 Integer 容灾切换的故障节点比例，下限是50，步长是10，最大是100，默认为100。

请求示例 设置实例容灾切换的故障节点比例。 PUT https://{endpoint}/v3/0549b4a43100d4f32f51c01c2fe4acdb/instances/disaster-recovery/settings { "disaster_recovery_settings" : [ { "instance_id" : "d74162b942604190b991d1c39772a66ain06", "switchover_ratio" : 50 }, { "instance_id" : "e74162b942604190b991d1c39772a66ain06", "switchover_ratio" : 100 } ] }

响应参数 状态码： 200 表5 响应Body参数 参数 参数类型 描述 successed_instance_ids Array of strings 设置容灾切换故障节点比例成功的实例列表。 状态码： 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。 状态码： 500 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。

URI GET 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" }

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 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参数 参数 是否必选 参数类型 描述 start_time 是 String 开始时间，格式为“yyyy-mm-ddThh:mm:ssZ”。 其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。 注：开始时间不得早于当前时间30天。 end_time 是 String 结束时间，格式为“yyyy-mm-ddThh:mm:ssZ”。 其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。 注：结束时间不能晚于当前时间。 limit 是 Integer 表示每次查询的日志条数，最大限制100条。 line_num 否 String 日志单行序列号，第一次查询时不需要此参数，下一次查询时需要使用，可从上一次查询的返回信息中获取。说明：当次查询从line_num的下一条日志开始查询，不包含当前line_num日志。 operate_type 否 String 语句类型，取空值，表示查询所有语句类型。 枚举值： SELECT DELETE SHOW DROP CREATE ALTER node_id 否 String 节点ID，取空值，表示查询实例下所有允许查询的节点。具体取值请参考表10中的“id”。 keywords 否 String 根据多个关键字搜索日志全文，表示同时匹配所有关键字。最多支持10个关键字，每个关键字最大长度不超过512个字符。 max_cost_time 否 Integer 支持根据最大执行时间范围查找日志。单位：ms。 min_cost_time 否 Integer 支持根据最小执行时间范围查找日志。单位：ms。 database 否 String 数据库名称。 retention_policy 否 String 保留策略。