华为云用户手册

请求示例 POST https://gaussdb-opengauss.cn-north-1.myhuaweicloud.com/v3.5/0483b6b16e954cb88930a360d2c4e663/instances/c04c789b6baa4b6dbcc139c5226f3a2cin14/disaster-recovery/simulation-stop { "disaster_type" : "stream" }

URI POST https://{Endpoint}/v3.5/{project_id}/instances/{instance_id}/disaster-recovery/simulation-start 表1 参数说明 名称 是否必选 说明 project_id 是 参数解释： 租户在某一Region下的项目ID。 获取方法请参见获取项目ID。 约束限制： 不涉及。 取值范围： 只能由英文字母、数字组成，且长度为32个字符。 默认取值： 不涉及。 instance_id 是 实例ID。

请求示例 POST https://gaussdb-opengauss.cn-north-1.myhuaweicloud.com/v3.5/0483b6b16e954cb88930a360d2c4e663/instances/c04c789b6baa4b6dbcc139c5226f3a2cin14/disaster-recovery/simulation-start { "xlog_keep_ratio":50, "disaster_type" : "stream" }

请求示例 POST https://gaussdb-opengauss.cn-north-1.myhuaweicloud.com/v3.5/0483b6b16e954cb88930a360d2c4e663/instances/c04c789b6baa4b6dbcc139c5226f3a2cin14/disaster-recovery/restore { "disaster_type" : "stream" }

URI POST https://{Endpoint}/v3.5/{project_id}/instances/{instance_id}/disaster-recovery/restore 表1 参数说明 名称 是否必选 说明 project_id 是 参数解释： 租户在某一Region下的项目ID。 获取方法请参见获取项目ID。 约束限制： 不涉及。 取值范围： 只能由英文字母、数字组成，且长度为32个字符。 默认取值： 不涉及。 instance_id 是 实例ID。

请求示例 POST https://gaussdb-opengauss.cn-north-1.myhuaweicloud.com/v3.5/0483b6b16e954cb88930a360d2c4e663/instances/c04c789b6baa4b6dbcc139c5226f3a2cin14/disaster-recovery/switchover { "disaster_type" : "stream" }

请求参数 表2 参数说明 名称 是否必选 参数类型 说明 disaster_type 是 String 容灾类型。 枚举值： stream：流式容灾。 post_process_config 否 String 是否支持倒换失败自愈，为空时默认不自愈。 枚举值： AUTO：容灾切换失败故障自愈。 MANUAL：容灾切换失败不自愈。 该字段仅支持数据库引擎版本大于等于V2.0-8.200的Quorum流式容灾，其他场景的容灾主备切换不提供自愈功能。

URI POST https://{Endpoint}/v3.5/{project_id}/instances/{instance_id}/disaster-recovery/switchover 表1 参数说明 名称 是否必选 说明 project_id 是 参数解释： 租户在某一Region下的项目ID。 获取方法请参见获取项目ID。 约束限制： 不涉及。 取值范围： 只能由英文字母、数字组成，且长度为32个字符。 默认取值： 不涉及。 instance_id 是 实例ID。

请求示例 POST https://gaussdb-opengauss.cn-north-1.myhuaweicloud.com/v3.5/0483b6b16e954cb88930a360d2c4e663/instances/c04c789b6baa4b6dbcc139c5226f3a2cin14/disaster-recovery/release { "disaster_type" : "stream" }

URI POST https://{Endpoint}/v3.5/{project_id}/instances/{instance_id}/disaster-recovery/release 表1 参数说明 名称 是否必选 说明 project_id 是 参数解释： 租户在某一Region下的项目ID。 获取方法请参见获取项目ID。 约束限制： 不涉及。 取值范围： 只能由英文字母、数字组成，且长度为32个字符。 默认取值： 不涉及。 instance_id 是 实例ID。

URI POST https://{Endpoint}/v3.5/{project_id}/instances/{instance_id}/disaster-recovery/failover 表1 参数说明 名称 是否必选 说明 project_id 是 参数解释： 租户在某一Region下的项目ID。 获取方法请参见获取项目ID。 约束限制： 不涉及。 取值范围： 只能由英文字母、数字组成，且长度为32个字符。 默认取值： 不涉及。 instance_id 是 实例ID。

请求示例 POST https://gaussdb-opengauss.cn-north-1.myhuaweicloud.com/v3.5/0483b6b16e954cb88930a360d2c4e663/instances/c04c789b6baa4b6dbcc139c5226f3a2cin14/disaster-recovery/failover { "is_support_restore": true, "disaster_type": "stream" }

URI POST https://{Endpoint}/v3.5/{project_id}/instances/{instance_id}/disaster-recovery/construct 表1 参数说明 名称 是否必选 说明 project_id 是 参数解释： 租户在某一Region下的项目ID。 获取方法请参见获取项目ID。 约束限制： 不涉及。 取值范围： 只能由英文字母、数字组成，且长度为32个字符。 默认取值： 不涉及。 instance_id 是 实例ID。

请求参数 表2 参数说明 名称 是否必选 参数类型 说明 disaster_type 是 String 容灾类型。 枚举值： stream：流式容灾。 dr_ip 是 String 对端实例数据IP。可通过查询查询数据库实例列表接口获取。 集中式版：对端实例任意节点数据IP（非仲裁节点、非日志节点）。 分布式版：对端实例CN节点的数据IP。 dr_user_name 是 String 对端实例账户名称。 dr_user_password 是 String 对端实例账户密码。 dr_task_name 否 String 容灾任务名称。

请求示例 POST https://gaussdb-opengauss.cn-north-1.myhuaweicloud.com/v3.5/0483b6b16e954cb88930a360d2c4e663/instances/9089bbf7377442daa55bc28d514c08bdin14/disaster-recovery/construct { "disaster_type" : "stream", "dr_ip" : "127.0.0.1", "dr_user_name" : "root", "dr_user_password" : "password", "dr_task_name": "dr-task-123" }

响应参数 表2 响应Body参数列表 名称 参数类型 说明 total Integer 总记录数。 relations Array of Objects 容灾关系详情。详情请参见表3。 表3 relations字段数据结构说明 名称 参数类型 说明 disaster_type String 容灾类型。 枚举值: stream：流式容灾。 name String 容灾任务名称。 disaster_role String 容灾角色。 枚举值: master：主实例。 disaster：灾备实例。 created String 创建时间，格式为“yyyy-mm-ddThh:mm:ssZ”。 其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。 updated String 更新时间，格式为“yyyy-mm-ddThh:mm:ssZ”。 其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。 slave_region_instance_info Object 备Region实例信息。详情请参见表4。 master_region_instance_info Object 主Region实例信息。详情请参见表5。 synchronization_id String 容灾关系唯一ID。 id String 容灾记录ID。 instance_id String 当前Region实例ID。 instance_name String 当前Region实例名称。 instance_status String 当前Region实例状态。 precheck_failed_reason String 预校验失败原因。 status String 容灾记录状态。 取值范围如下： pending：任务处理中。 normal：容灾关系正常。 failed：容灾搭建失败。 completed：容灾关系已解除。 failover：容灾已升主。 simulation：演练中。 dr_log_keep：日志保持中。 pre_checking：容灾预检查。 pre_check_failed：容灾预检查失败。 actions Array of Strings 实例当前正在执行的Action列表。 表4 slave_region_instance_info字段数据结构说明 名称 参数类型 说明 instance_id String 实例ID。 project_id String 实例项目ID。 project_name String 实例项目名称。 region_code String regionCode编码。 ip_address String 数据IP地址列表，使用英文逗号分割。 表5 master_region_instance_info字段数据结构说明 名称 参数类型 说明 instance_id String 实例ID。 project_id String 实例项目ID。 project_name String 实例项目名称。 region_code String regionCode编码。 ip_address String 数据IP地址列表，使用英文逗号分割。

响应示例 { "total" : 1, "relations" : [ { "name" : "DR-task-0962", "created" : "2022-06-16 09:39:51", "updated" : "2022-06-16 09:44:55", "id" : "30b74120-4b50-495d-8174-7eeddf7feac5", "synchronization_id" : "9446f822-ccd2-43dc-929c-0b78ba7fdf64", "status" : "normal", "precheck_failed_reason" : "", "disaster_type" : "stream", "disaster_role" : "disaster", "slave_region_instance_info" : { "region_code" : "sa-fb-1", "instance_id" : "d1060faf0d3743dd8830b39e7423bc9ain14", "project_id" : "4a52a8a8f63d4c6d966dff0e20b69738", "project_name" : "sa-fb-1_ GaussDB ", "ip_address" : "172.166.1.192,172.166.0.6,172.166.1.135" }, "master_region_instance_info" : { "region_code" : "sa-fb-1", "instance_id" : "54d4b9fb131745fcba32cb90a05cabb8in14", "project_id" : "4a52a8a8f63d4c6d966dff0e20b69738", "project_name" : "sa-fb-1_GaussDB", "ip_address" : "172.167.1.86,172.167.0.89,172.167.1.229" }, "instance_id" : "d1060faf0d3743dd8830b39e7423bc9ain14", "instance_name" : "hly-0609-02", "instance_status" : "normal", "actions" : [ "STREAM_DISASTER_RELATION_MASTER_TAG" ] } ] }

URI GET https://{Endpoint}/v3.5/{project_id}/disaster-recovery/relations 表1 参数说明 名称 参数类型 是否必选 说明 project_id String 是 参数解释： 租户在某一Region下的项目ID。 获取方法请参见获取项目ID。 约束限制： 不涉及。 取值范围： 只能由英文字母、数字组成，且长度为32个字符。 默认取值： 不涉及。 instance_name String 否 实例名称，可查询过滤本端实例。 instance_id String 否 实例ID，可查询过滤本端实例ID。 limit Integer 否 查询记录数。为空时，默认为100。最小值为1，最大值为100。 offset Integer 否 索引位置，偏移量。从第一条数据偏移offset条数据后开始查询，默认为0（偏移0条数据，表示从第一条数据开始查询），必须为数字，不能为负数。 dr_role String 否 容灾角色。 master：主实例。 disaster：灾备实例。 dr_type String 否 容灾类型。 stream：流式容灾。 dr_status String 否 容灾状态。 normal：容灾关系正常。 failover：容灾已升主。 pending：任务处理中。 pre_check_failed：容灾预检查失败。 pre_checking：容灾预检查。

响应示例 { "rpo":"0", "rto":"0", "status":"archive", "instance_id":"b3692282395340c5b5421ecf3d7bd6adin14", "rto_threshold":"900", "rpo_threshold":"10", "failover_progress":"", "switchover_progress":"" }

URI GET https://{Endpoint}/v3.5/{project_id}/instances/{instance_id}/disaster-recovery/monitor?disaster_type={disaster_type} 表1 参数说明 名称 是否必选 参数类型 说明 project_id 是 String 参数解释： 租户在某一Region下的项目ID。 获取方法请参见获取项目ID。 约束限制： 不涉及。 取值范围： 只能由英文字母、数字组成，且长度为32个字符。 默认取值： 不涉及。 instance_id 是 String 实例ID。 disaster_type 是 String 容灾类型： stream：流式容灾。

响应参数 表2 响应Body参数列表 名称 参数类型 说明 instance_id String 实例ID。 status String 流式容灾状态。 normal：该集群未参与容灾。 full_backup：主集群数据全量复制中。 archive：主集群日志流式复制中。 backup_fail：主集群数据全量复制失败。 archive_fail：主集群日志流式复制失败。 switchover：计划内主备倒换中。 restore：灾备集群数据全量恢复中。 restore_fail：灾备集群全备恢复失败。 recovery：灾备集群日志流式复制中。 recovery_fail：灾备集群日志流式复制失败。 promote：灾备集群升主中。 promote_fail：灾备集群升主失败。 rpo String 数据恢复点目标。 rto String 数据恢复时间目标。 rpo_threshold String RPO阈值。 rto_threshold String RTO阈值。 switchover_progress String 主备切换进度。该值为一个百分数。例如：40%。 failover_progress String 容灾升主进度。该值为一个百分数。例如：40%。

响应参数 表2 参数说明 参数 参数类型 描述 database_schemas Array of objects 参数解释： 列表中每个元素表示一个数据库SCHEMA，详情参见表3。 total_count Integer 参数解释： 数据库SCHEMA总数。 取值范围： [1, 2^31-1]，取决于实际个数。 表3 database_schemas字段数据结构说明 参数 参数类型 描述 schema_name String 参数解释： SCHEMA名称。 取值范围： 不涉及。 owner String 参数解释： SCHEMA所属用户。 取值范围： 不涉及。

URI GET https://{Endpoint}/v3/{project_id}/instances/{instance_id}/schemas?db_name={db_name} 表1 参数说明 参数 是否必选 参数类型 描述 project_id 是 String 参数解释： 租户在某一Region下的项目ID。 获取方法请参见获取项目ID。 约束限制： 不涉及。 取值范围： 只能由英文字母、数字组成，且长度为32个字符。 默认取值： 不涉及。 instance_id 是 String 参数解释： 实例ID。标识实例的唯一标识。 约束限制： 不涉及。 取值范围： 只能由英文字母、数字组成，且长度为32个字符。 默认取值： 不涉及。 db_name 是 String 参数解释： 数据库名称。 约束限制： 不能和模板库重名。模板库包括postgres， template0 ，template1。 取值范围： 不涉及。 默认取值： 不涉及。 offset 否 Integer 参数解释： 分页符。从第一条数据偏移offset页数据后开始查询。例如：该参数指定为1，limit指定为10，则只展示第11-20条数据。 约束限制： 不涉及。 取值范围： [0, 2^31-1] 默认取值： 默认为0（偏移0条数据，表示从第一条数据开始查询）。 limit 否 Integer 参数解释： 查询记录数。每页显示的条目数量。 约束限制： 不涉及。 取值范围： [1, 100] 默认取值： 默认为10。

响应示例 查询数据库用户列表成功。 { "users": [ { "name": "root", "attribute": { "rolsuper": false, "rolinherit": true, "rolcreaterole": true, "rolcreatedb": true, "rolcanlogin": true, "rolconnlimit": -1, "rolreplication": false, "rolbypassrls": false, "rolpassworddeadline": "" }, "memberof": "{gs_role_copy_files,gs_role_signal_backend,gs_role_tablespace,gs_role_replication,gs_role_account_lock}", "lock_status": false } ], "total_count": 1 }

URI GET https://{Endpoint}/v3/{project_id}/instances/{instance_id}/db-users 表1 参数说明 参数 是否必选 参数类型 描述 project_id 是 String 参数解释： 租户在某一Region下的项目ID。 获取方法请参见获取项目ID。 约束限制： 不涉及。 取值范围： 只能由英文字母、数字组成，且长度为32个字符。 默认取值： 不涉及。 instance_id 是 String 参数解释： 实例ID。标识实例的唯一标识。 约束限制： 不涉及。 取值范围： 只能由英文字母、数字组成，且长度为32个字符。 默认取值： 不涉及。 offset 否 Integer 参数解释： 分页符。从第一条数据偏移offset页数据后开始查询例如：该参数指定为1，limit指定为10，则只展示第11-20条数据。 约束限制： 不涉及。 取值范围： [0, 2^31-1] 默认取值： 默认为0（偏移0条数据，表示从第一条数据开始查询）。 limit 否 Integer 参数解释： 每页显示的条目数量。 约束限制： 不涉及。 取值范围： [1, 100] 默认取值： 默认为10。

响应参数 表2 参数说明 参数 参数类型 描述 users Array of objects 参数解释： 列表中每个元素表示一个数据库用户，详情参见表3。 total_count Integer 参数解释： 总记录数。 取值范围： [0, 2^31-1]，取决于实际查询大小。 表3 users字段数据结构说明 参数 参数类型 描述 name String 参数解释： 用户名称。 取值范围： 不涉及。 attribute Object 参数解释： 用户的权限属性，详情参见表 attribute字段数据结构说明。 memberof String 参数解释： 用户的默认权限。 取值范围： 不涉及。 lock_status Boolean 参数解释： 用户是否被锁。 取值范围： 取值为“true”或“false”。 表4 attribute字段数据结构说明 参数 参数类型 描述 rolsuper Boolean 参数解释： 用户是否具有管理员权限。 取值范围： 取值为“true”或“false”。 rolinherit Boolean 参数解释： 用户是否自动继承其所属角色的权限。 取值范围： 取值为“true”或“false”。 rolcreaterole Boolean 参数解释： 用户是否支持创建其他子用户。 取值范围： 取值为“true”或“false”。 rolcreatedb Boolean 参数解释： 用户是否可以创建数据库。 取值范围： 取值为“true”或“false”。 rolcanlogin Boolean 参数解释： 用户是否可以登录数据库。 取值范围： 取值为“true”或“false”。 rolconnlimit Integer 参数解释： 用户连接实例的最大并发连接数。-1表示没有限制。 取值范围： 不涉及。 rolreplication Boolean 参数解释： 用户是否属于复制角色。 取值范围： 取值为“true”或“false”。 rolbypassrls Boolean 参数解释： 用户是否绕过每个行级安全策略。 取值范围： 取值为“true”或“false”。 rolpassworddeadline String 参数解释： 用户密码过期时间。 取值范围： 不涉及。

响应示例 查询数据库列表成功。 { "databases": [ { "name": "gaussdb_test", "owner": "root", "size": "25 MB", "datctype": "en_US.UTF-8", "character_set": "UTF8", "collate_set": "en_US.UTF-8", "compatibility_type": "GaussDB" }, { "name": "gaussdb_test1", "owner": "root", "size": "25 MB", "datctype": "en_US.UTF-8", "character_set": "UTF8", "collate_set": "en_US.UTF-8", "compatibility_type": "GaussDB" }, { "name": "gaussdb_test2", "owner": "root", "size": "25 MB", "datctype": "en_US.UTF-8", "character_set": "UTF8", "collate_set": "en_US.UTF-8", "compatibility_type": "GaussDB" } ], "total_count": 3 }

响应参数 表2 参数说明 参数 参数类型 描述 databases Array of objects 参数解释： 列表中每个元素表示一个数据库。详情参见表3。 total_count Integer 参数解释： 总记录数。 取值范围： [0, 2^31 - 1]，实际总数取决于实例个数。 表3 databases字段数据结构说明 参数 参数类型 描述 name String 参数解释： 数据库名称。 取值范围： 不涉及。 owner String 参数解释： 数据库所属用户。 取值范围： 不涉及。 character_set String 参数解释： 数据库使用的字符集，例如UTF8。 取值范围： 不涉及。 collate_set String 参数解释： 数据库排序集，例如en_US.UTF-8等。 取值范围： 不涉及。 size String 参数解释： 数据库大小，单位MB。 取值范围： 不涉及。 datctype String 参数解释： 数据库使用的字符分类，例如en_US.UTF-8等。 取值范围： 不涉及。 compatibility_type String 参数解释： 数据库兼容的类型，如GaussDB，M。 取值范围： 不涉及。

URI GET https://{Endpoint}/v3/{project_id}/instances/{instance_id}/databases 表1 参数说明 参数 是否必选 参数类型 描述 project_id 是 String 参数解释： 租户在某一Region下的项目ID。 获取方法请参见获取项目ID。 约束限制： 不涉及。 取值范围： 只能由英文字母、数字组成，且长度为32个字符。 默认取值： 不涉及。 instance_id 是 String 参数解释： 实例ID。 约束限制： 不涉及。 取值范围： 只能由英文字母、数字组成，且长度为32个字符。 默认取值： 不涉及。 offset 否 Integer 参数解释： 分页符。从第一条数据偏移offset页数据后开始查询。例如：该参数指定为1，limit指定为10，则只展示第11-20条数据。 约束限制： 必须为数字，不能为负数。 取值范围： [0, 2^31-1] 默认取值： 默认为0（偏移0页数据，表示从第一条数据开始查询）。 limit 否 Integer 参数解释： 每页显示的条目数量。 约束限制： 不涉及。 取值范围： [1, 100] 默认取值： 默认为10。

请求示例 重置数据库root账号的密码。 PUT https://gaussdb-opengauss.cn-north-1.myhuaweicloud.com/v3/0483b6b16e954cb88930a360d2c4e663/instances/{instance_id}/db-user/password { "name" : "root", "password" : "*******" }