华为云用户手册

URI GET https://{Endpoint}/v3/{project_id}/backups?instance_id={instance_id}&backup_id={backup_id}&backup_type={backup_type}&offset={offset}&limit={limit}&begin_time={begin_time}&end_time={end_time} 表1 参数说明 参数 是否必选 参数类型 描述 project_id 是 String 参数解释： 租户在某一Region下的项目ID。 获取方法请参见获取项目ID。 约束限制： 不涉及。 取值范围： 只能由英文字母、数字组成，且长度为32个字符。 默认取值： 不涉及。 instance_id 否 String 参数解释： 实例ID，此参数是用户创建实例的唯一标识，用于查询某一实例的备份。 约束限制： 不涉及。 取值范围： 只能由英文字母、数字组成，且长度为32个字符。 默认取值： 不涉及。 backup_id 否 String 参数解释： 备份ID，此参数是实例备份的唯一标识，用于查询某一备份的信息。 约束限制： 不涉及。 取值范围： 只能由英文字母、数字组成，长度为36个字符，且符合UUID规则。 默认取值： 不涉及。 backup_type 否 String 参数解释： 备份类型，此参数用于查询某种类型的备份。 约束限制： 不涉及。 取值范围： auto 自动全量备份。 manual 手动全量备份。 默认取值： 不涉及。 offset 否 Integer 参数解释： 索引位置，偏移量。从第一条数据偏移offset条数据后开始查询。 约束限制： 不涉及。 取值范围： [0, 10^10-1] 默认取值： 默认为0（偏移0条数据，表示从第一条数据开始查询）。 limit 否 Integer 参数解释： 查询记录数。 约束限制： 不涉及。 取值范围： [0, 100] 默认取值： 默认为100。 begin_time 否 String 参数解释： 查询开始时间，格式为“yyyy-mm-ddThh:mm:ssZ”。其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。示例：2022-05-09T16:01:10+0800。 约束限制： 可与end_time配合使用，end_time不使用时，查询结果为begin_time之后创建的备份列表，使用end_time时，查询结果为begin_time和end_time之间创建的备份列表。 取值范围： 不涉及。 默认取值： 不涉及。 end_time 否 String 参数解释： 查询结束时间，格式为“yyyy-mm-ddThh:mm:ssZ”，且大于查询开始时间。其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。 示例：2022-05-09T16:01:10+0800。 约束限制： 可与begin_time配合使用，begin_time不使用时，查询结果为end_time之前创建的备份列表，使用begin_time时，查询结果为begin_time和end_time之间创建的备份列表。 取值范围： 不涉及。 默认取值： 不涉及。

GaussDB 授权分类 表1 实例管理 API功能 授权项 授权范围 对应API接口 创建数据库实例 gaussdb:instance:create gaussdb:param:list 支持： IAM 项目(Project) 支持： 企业项目(Enterprise Project) POST /v3/{project_id}/instances 扩容数据库实例的磁盘空间 gaussdb:instance:modifySpec 支持： IAM项目(Project) 支持： 企业项目(Enterprise Project) POST /v3/{project_id}/instances/{instance_id}/action 删除数据库实例 gaussdb:instance:delete 支持： IAM项目(Project) 支持： 企业项目(Enterprise Project) DELETE /v3/{project_id}/instances/{instance_id} 查询数据库实例列表 gaussdb:instance:list 支持： IAM项目(Project) 支持： 企业项目(Enterprise Project) GET /v3/{project_id}/instances 重置数据库密码 gaussdb:instance:modifyPasswd 支持： IAM项目(Project) 支持： 企业项目(Enterprise Project) POST /v3/{project_id}/instances/{instance_id}/password 修改实例名称 gaussdb:instance:rename 支持： IAM项目(Project) 支持： 企业项目(Enterprise Project) PUT /v3/{project_id}/instances/{instance_id}/name 重启数据库实例 gaussdb:instance:restart 支持： IAM项目(Project) 支持： 企业项目(Enterprise Project) POST /v3/{project_id}/instances/{instance_id}/restart 分片节点主备切换 gaussdb:instance:switchShard 支持： IAM项目(Project) 支持： 企业项目(Enterprise Project) POST /v3/{project_id}/instances/{instance_id}/switch-shard 查询实例的组件列表 gaussdb:instance:list 支持： IAM项目(Project) 支持： 企业项目(Enterprise Project) GET /v3/{project_id}/instances/{instance_id}/components 规格变更 gaussdb:instance:modifySpec 支持： IAM项目(Project) 支持： 企业项目(Enterprise Project) PUT /v3/{project_id}/instance/{instance_id}/flavor 查询实例主备平衡状态 gaussdb:instance:list 支持： IAM项目(Project) 支持： 企业项目(Enterprise Project) GET /v3/{project_id}/instances/{instance_id}/balance 查询解决方案模板配置 gaussdb:instance:list 支持： IAM项目(Project) 支持： 企业项目(Enterprise Project) GET /v3/{project_id}/deployment-form 查询已绑定的EIP列表 gaussdb:instance:list 支持： IAM项目(Project) 支持： 企业项目(Enterprise Project) GET /v3/{project_id}/instances/{instance_id}/public-ips?offset={offset}&limit={limit} 弱密码校验 gaussdb:instance:list 支持： IAM项目(Project) 支持： 企业项目(Enterprise Project) POST /v3/{project_id}/weak-password-verification 绑定/解绑弹性公网IP gaussdb:instance:bindPublicIp 支持： IAM项目(Project) 支持： 企业项目(Enterprise Project) POST /v3/{project_id}/instances/{instance_id}/nodes/{node_id}/public-ip 查询实例SSL证书下载地址 gaussdb:instance:list 支持： IAM项目(Project) 支持： 企业项目(Enterprise Project) GET /v3/{project_id}/instances/{instance_id}/ssl-cert/download-link 查询租户的实例配额 gaussdb:instance:list 支持： IAM项目(Project) 支持： 企业项目(Enterprise Project) GET /v3/{project_id}/project-quotas?type={type} 表2 参数配置 API功能 授权项 授权范围 对应API接口 获取参数模板列表 gaussdb:param:list 支持： IAM项目(Project) 支持： 企业项目(Enterprise Project) GET /v3/{project_id}/configurations?offset={offset}&limit={limit} 获取指定实例的参数 gaussdb:param:list 支持： IAM项目(Project) 支持： 企业项目(Enterprise Project) GET /v3/{project_id}/instances/{instance_id}/configurations 修改指定实例的参数 gaussdb:param:modify 支持： IAM项目(Project) 支持： 企业项目(Enterprise Project) PUT /v3/{project_id}/instances/{instance_id}/configurations 创建参数模板 gaussdb:param:create 支持： IAM项目(Project) 支持： 企业项目(Enterprise Project) POST /v3/{project_id}/configurations 删除参数模板 gaussdb:param:delete 支持： IAM项目(Project) 支持： 企业项目(Enterprise Project) DELETE /v3/{project_id}/configurations/{config_id} 查询参数模板详情 gaussdb:instance:list 支持： IAM项目(Project) 支持： 企业项目(Enterprise Project) GET /v3/{project_id}/configurations/{config_id} 复制参数模板 gaussdb:param:create 支持： IAM项目(Project) 支持： 企业项目(Enterprise Project) POST /v3/{project_id}/configurations/{config_id}/copy 重置参数组 gaussdb:param:modify 支持： IAM项目(Project) 支持： 企业项目(Enterprise Project) POST /v3/{project_id}/configurations/{config_id}/reset 比较两个参数组模板之间的差异 gaussdb:param:list 支持： IAM项目(Project) 支持： 企业项目(Enterprise Project) POST /v3/{project_id}/configurations/comparison 查询可应用实例列表 gaussdb:instance:list 支持： IAM项目(Project) 支持： 企业项目(Enterprise Project) GET /v3/{project_id}/configurations/{config_id}/applicable-instances 校验参数组名称是否存在 gaussdb:instance:list 支持： IAM项目(Project) 支持： 企业项目(Enterprise Project) GET /v3/{project_id}/configurations/name-validation?name={name} 应用参数模板 gaussdb:param:apply 支持： IAM项目(Project) 支持： 企业项目(Enterprise Project) PUT /v3/{project_id}/configurations/{config_id}/apply 查询参数模板的应用记录 gaussdb:instance:list 支持： IAM项目(Project) 支持： 企业项目(Enterprise Project) GET /v3/{project_id}/configurations/{config_id}/applied-histories 查询参数模板的修改历史 gaussdb:param:list 支持： IAM项目(Project) 支持： 企业项目(Enterprise Project) GET /v3/{project_id}/configurations/{config_id}/histories 表3 备份管理 API功能 授权项 授权范围 对应API接口 设置自动备份策略 gaussdb:instance:modifyBackupPolicy 支持： IAM项目(Project) 支持： 企业项目(Enterprise Project) PUT /v3/{project_id}/instances/{instance_id}/backups/policy 查询自动备份策略 gaussdb:backup:list 支持： IAM项目(Project) 支持： 企业项目(Enterprise Project) GET /v3/{project_id}/instances/{instance_id}/backups/policy 查询备份列表 gaussdb:backup:list 支持： IAM项目(Project) 支持： 企业项目(Enterprise Project) GET /v3/{project_id}/backups?instance_id={instance_id}&backup_id={backup_id}&backup_type={backup_type}&offset={offset}&limit={limit}&begin_time={begin_time}&end_time={end_time} 创建手动备份 gaussdb:backup:create 支持： IAM项目(Project) 支持： 企业项目(Enterprise Project) POST /v3/{project_id}/backups 删除手动备份 gaussdb:backup:delete 支持： IAM项目(Project) 支持： 企业项目(Enterprise Project) DELETE /v3/{project_id}/backups/{backup_id} 查询可恢复时间段 gaussdb:backup:list 支持： IAM项目(Project) 支持： 企业项目(Enterprise Project) GET /v3/{project_id}/instances/{instance_id}/restore-time?date={date} 恢复到新实例 gaussdb:instance:create 支持： IAM项目(Project) 支持： 企业项目(Enterprise Project) POST /v3/{project_id}/instances 查询可用于备份恢复的实例列表 gaussdb:instance:list 支持： IAM项目(Project) 支持： 企业项目(Enterprise Project) GET /v3/{project_id}/restorable-instances 根据时间点或者备份文件查询原实例信息 gaussdb:instance:list 支持： IAM项目(Project) 支持： 企业项目(Enterprise Project) GET /v3/{project_id}/instance-snapshot?instance_id={instance_id}&backup_id={backup_id}&restore_time={restore_time} 表4 引擎版本和规格 API功能 授权项 授权范围 对应API接口 查询数据库引擎的版本 gaussdb:instance:list 支持： IAM项目(Project) 支持： 企业项目(Enterprise Project) GET /v3/{project_id}/datastore/versions 查询数据库规格 gaussdb:instance:list 支持： IAM项目(Project) 支持： 企业项目(Enterprise Project) GET /v3/{project_id}/flavors?limit={limit}&offset={offset}&ha_mode={ha_mode}&version={version}&spec_code={spec_code} 查询引擎列表 gaussdb:instance:list 支持： IAM项目(Project) 支持： 企业项目(Enterprise Project) GET /v3/{project_id}/datastores 查询实例可变更规格 gaussdb:instance:list 支持： IAM项目(Project) 支持： 企业项目(Enterprise Project) GET /v3/{project_id}/instances/{instance_id}/available-flavors 表5 管理数据库和用户 API功能 授权项 授权范围 对应API接口 创建数据库 gaussdb:instance:createDatabase 支持： IAM项目(Project) 支持： 企业项目(Enterprise Project) POST /v3/{project_id}/instances/{instance_id}/database 创建数据库用户 gaussdb:instance:createDatabaseUser 支持： IAM项目(Project) 支持： 企业项目(Enterprise Project) POST /v3/{project_id}/instances/{instance_id}/db-user 创建数据库SCHEMA gaussdb:instance:createDatabaseSchema 支持： IAM项目(Project) 支持： 企业项目(Enterprise Project) POST /v3/{project_id}/instances/{instance_id}/schema 授权数据库账号 gaussdb:instance:grantDatabasePrivilege 支持： IAM项目(Project) 支持： 企业项目(Enterprise Project) POST /v3/{project_id}/instances/{instance_id}/db-privilege 重置数据库账号密码 gaussdb:instance:modifyDatabasePasswd 支持： IAM项目(Project) 支持： 企业项目(Enterprise Project) PUT /v3/{project_id}/instances/{instance_id}/db-user/password 查询数据库列表 gaussdb:instance:list 支持： IAM项目(Project) 支持： 企业项目(Enterprise Project) GET /v3/{project_id}/instances/{instance_id}/databases 查询数据库用户列表 gaussdb:instance:list 支持： IAM项目(Project) 支持： 企业项目(Enterprise Project) GET /v3/{project_id}/instances/{instance_id}/db-users 查询数据库SCHEMA列表 gaussdb:instance:list 支持： IAM项目(Project) 支持： 企业项目(Enterprise Project) GET /v3/{project_id}/instances/{instance_id}/schemas 表6 标签管理 API功能 授权项 授权范围 对应API接口 查询实例标签 gaussdb:instance:list 支持： IAM项目(Project) 支持： 企业项目(Enterprise Project) GET /v3/{project_id}/instances/{instance_id}/tags 查询项目标签 gaussdb:instance:list 支持： IAM项目(Project) 支持： 企业项目(Enterprise Project) GET /v3/{project_id}/tags 查询预定义标签 gaussdb:instance:list 支持： IAM项目(Project) 支持： 企业项目(Enterprise Project) GET /v3/{project_id}/predefined-tags 添加实例标签 gaussdb:instance:dealTag 支持： IAM项目(Project) 支持： 企业项目(Enterprise Project) POST /v3/{project_id}/instances/{instance_id}/tags 表7 磁盘管理 API功能 授权项 授权范围 对应API接口 查询实例存储空间使用信息 gaussdb:instance:list 支持： IAM项目(Project) 支持： 企业项目(Enterprise Project) GET /v3/{project_id}/instances/{instance_id}/volume-usage 查询数据库磁盘类型 gaussdb:instance:list 支持： IAM项目(Project) 支持： 企业项目(Enterprise Project) GET /v3/{project_id}/storage-type?version={version}&ha_mode={ha_mode} 表8 配额管理 API功能 授权项 授权范围 对应API接口 修改企业项目配额 gaussdb:quota:modify 支持： IAM项目(Project) 支持： 企业项目(Enterprise Project) PUT /v3/{project_id}/enterprise-projects/quotas 查询企业项目配额组 gaussdb:instance:list 支持： IAM项目(Project) 支持： 企业项目(Enterprise Project) GET /v3/{project_id}/enterprise-projects/quotas 表9 任务管理 API功能 授权项 授权范围 对应API接口 获取任务信息 gaussdb:instance:list 支持： IAM项目(Project) 支持： 企业项目(Enterprise Project) GET /v3/{project_id}/jobs?id={id} 查询任务列表 gaussdb:instance:list 支持： IAM项目(Project) 支持： 企业项目(Enterprise Project) GET /v3/{project_id}/tasks 删除任务记录 gaussdb:instance:deleteTaskRecord 支持： IAM项目(Project) 支持： 企业项目(Enterprise Project) DELETE /v3/{project_id}/jobs/{job_id} 表10 回收站 API功能 授权项 授权范围 对应API接口 设置回收站策略 gaussdb:instance:setRecyclePolicy 支持： IAM项目(Project) 支持： 企业项目(Enterprise Project) PUT /v3/{project_id}/recycle-policy 查看回收站策略 gaussdb:instance:list 支持： IAM项目(Project) 支持： 企业项目(Enterprise Project) GET /v3/{project_id}/recycle-policy 查询回收站所有引擎实例列表 gaussdb:instance:list 支持： IAM项目(Project) 支持： 企业项目(Enterprise Project) GET /v3/{project_id}/recycle-instances 父主题： 权限策略和授权项

请求示例 查询批量实例可升级的版本和升级类型。 POST https://gaussdb-opengauss.cn-north-4.myhuaweicloud.com/v3.1/0483b6b16e954cb88930a360d2c4e663/instances/db-upgrade/candidate-versions{ "instance_ids" : [ "cc0ae5c47bf94834bf9e44138f7f995ain14", "aa0ae5c47bf94834bf9e44138f7f995ain14" ] }

响应示例 查询批量实例可升级的版本和升级类型。 { "upgrade_type_list": [ { "upgrade_type": "grey", "upgrade_action_list": [ { "upgrade_action": "commit", "enable": false }, { "upgrade_action": "rollback", "enable": false }, { "upgrade_action": "upgrade", "enable": true }, { "upgrade_action": "upgradeAutoCommit", "enable": true } ], "enable": true, "is_parallel_upgrade": null }, { "upgrade_type": "inplace", "upgrade_action_list": [ { "upgrade_action": "upgradeAutoCommit", "enable": true } ], "enable": true, "is_parallel_upgrade": null }, { "upgrade_type": "hotfix", "upgrade_action_list": [ { "upgrade_action": "upgradeAutoCommit", "enable": false }, { "upgrade_action": "rollback", "enable": false } ], "enable": false, "is_parallel_upgrade": null } ], "upgrade_candidate_versions": [ "V2.0-8.100.0" ], "target_version": null, "hotfix_upgrade_infos": [], "hotfix_rollback_infos": []}

响应参数 表3 响应参数 参数 参数类型 描述 upgrade_type_list Array of 表4 objects 升级类型信息列表。 数组长度：0 - 1000 target_version String 若实例处于升级待观察中，返回升级的目标版本，否则返回为空。 最小长度：0 最大长度：1000 upgrade_candidate_versions Array of strings 可以升级的版本，包括大小版本。 最小长度：0 最大长度：1000 数组长度：0 - 1000 hotfix_upgrade_infos Array of 表6 objects 可以升级的热补丁信息。 数组长度：0 - 1000 hotfix_rollback_infos Array of 表6 objects 可以回滚的热补丁信息。 表4 upgrade_type_list 参数 参数类型 描述 upgrade_type String 升级类型。 取值范围： grey：灰度升级。 inplace：就地升级。 hotfix：热补丁升级。 enable Boolean 升级类型是否可用。 true：可用。 false：不可用。 upgrade_action_list Array of 表5 objects 升级操作列表。 数组长度：0 - 1000 is_parallel_upgrade Boolean 是否正在进行AZ内并行升级。 true：当前实例处于灰度升级的升级待观察升级方式中，已选择了AZ内并行升级方式，后续无法更改。 false：当前实例处于升级流程中，未选择AZ内并行升级的方式，后续无法更改。 null:当前实例尚未处于升级流程中。 表5 upgrade_action_list 参数 参数类型 描述 upgrade_action String 升级操作。 取值范围： upgrade：升级。 upgradeAutoCommit：升级自动提交。 commit：提交。 rollback：回滚。 enable Boolean 升级类型是否可用。 true：可用。 false：不可用。 表6 hotfix_upgrade_infos 参数 参数类型 描述 version String 热补丁版本。 common_patch String 补丁类型。 取值范围： common：通用补丁。 certain：定制补丁。 backup_sensitive Boolean 是否和备份相关。 取值范围： true：和备份相关。 false：和备份不相关。 descripition String 补丁的描述信息。

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

URI GET https://{Endpoint}/v3.1/{project_id}/instances/{instance_id}/db-upgrade/candidate-versions 表1 参数说明 参数 是否必选 参数类型 描述 project_id 是 String 参数解释： 租户在某一Region下的项目ID。 获取方法请参见获取项目ID。 约束限制： 不涉及。 取值范围： 只能由英文字母、数字组成，且长度为32个字符。 默认取值： 不涉及。 instance_id 是 String 实例ID，严格匹配UUID规则。

响应示例 实例在滚动升级中时，只返回滚动升级目标版本与滚动升级分片和AZ状态。 { "upgrade_type_list": [ { "upgrade_type": "grey", "upgrade_action_list": [ { "upgrade_action": "commit", "enable": false }, { "upgrade_action": "rollback", "enable": false }, { "upgrade_action": "upgrade", "enable": true }, { "upgrade_action": "upgradeAutoCommit", "enable": true } ], "enable": true, "is_parallel_upgrade": null }, { "upgrade_type": "hotfix", "upgrade_action_list": null, "enable": false, "is_parallel_upgrade": null }, { "upgrade_type": "inplace", "upgrade_action_list": [ { "upgrade_action": "upgradeAutoCommit", "enable": true } ], "enable": true, "is_parallel_upgrade": null } ], "rollback_enabled": false, "source_version": "V2.0-8.102.0", "target_version": null, "roll_upgrade_progress": { "not_fully_upgraded_az": "cn-southwest-244a,cn-southwest-244b,cn-southwest-244c", "already_upgraded_az": "", "az_description_map": { "cn-southwest-244c": "az3", "cn-southwest-244b": "az2", "cn-southwest-244a": "az1" } }, "upgrade_candidate_versions": [ "V2.0-8.300.0", "V2.0-8.103.0" ], "hotfix_upgrade_candidate_versions": [], "hotfix_rollback_candidate_versions": [], "hotfix_upgrade_infos": [], "hotfix_rollback_infos": []}

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

URI GET https://{Endpoint}/v3/{project_id}/instances/{instance_id}/auto-enlarge-policy 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 参数解释： 租户在某一Region下的项目ID。 获取方法请参见获取项目ID。 约束限制： 不涉及。 取值范围： 只能由英文字母、数字组成，且长度为32个字符。 默认取值： 不涉及。 instance_id 是 String 实例ID，严格匹配UUID规则。

URI DELETE https://{Endpoint}/v3/{project_id}/instances/{instance_id}/database?database_name={database_name} 表1 参数说明 名称 是否必选 说明 project_id 是 参数解释： 租户在某一Region下的项目ID。 获取方法请参见获取项目ID。 约束限制： 不涉及。 取值范围： 只能由英文字母、数字组成，且长度为32个字符。 默认取值： 不涉及。 instance_id 是 实例ID。 database_name 是 数据库名称。 不能使用模板库，且必须是已存在的数据库名称。 模板库包括postgres， template0，template1，templatem。

响应参数 表2 响应Body参数 参数 参数类型 描述 switch_option Boolean 磁盘自动扩容开关。 limit_volume_size Integer 存储自动扩容上限。 min_volume_size Integer 最小扩容磁盘容量。 max_volume_size Integer 最大扩容磁盘容量。 trigger_available_percent Integer 可用存储空间率。 percents Array of integers 空间率集合。 step_size Integer 扩容步长，固定大小扩容方式。 step_percent Integer 扩容步长，百分比扩容方式。

响应示例 查询磁盘自动扩容策略成功。 { "switch_option" : true, "limit_volume_size" : 200, "min_volume_size" : 160, "max_volume_size" : 240, "trigger_available_percent" : 20, "percents": [ 20, 25, 50 ], "step_size": 200, "step_percent": null}

请求示例 设置GaussDB实例备份策略，备份文件保存时长7天，备份时间段为19:00-20:00。 PUT https://gaussdb-opengauss.cn-north-1.myhuaweicloud.com/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in14/backups/policy{"backup_policy": {"keep_days": 7,"start_time": "19:00-20:00","period": "1,2,3,4,5","differential_period": "30","rate_limit": 75 , "prefetch_block": 64 , "file_split_size": 4 , "enable_standby_backup" : false }}

支持的授权项 策略包含系统策略和自定义策略，如果系统策略不满足授权要求，管理员可以创建自定义策略，并通过给用户组授予自定义策略来进行精细的访问控制。策略支持的操作与API相对应，授权项列表说明如下： 权限：允许或拒绝某项操作。 对应API接口：自定义策略实际调用的API接口。 授权项：自定义策略中支持的Action，在自定义策略中的Action中写入授权项，可以实现授权项对应的权限功能。 依赖的授权项：部分Action存在对其他Action的依赖，需要将依赖的Action同时写入授权项，才能实现对应的权限功能。 IAM项目(Project)/企业项目(Enterprise Project)：自定义策略的授权范围，包括IAM项目与企业项目。授权范围如果同时支持IAM项目和企业项目，表示此授权项对应的自定义策略，可以在IAM和企业管理两个服务中给用户组授权并生效。如果仅支持IAM项目，不支持企业项目，表示仅能在IAM中给用户组授权并生效，如果在企业管理中授权，则该自定义策略不生效。关于IAM项目与企业项目的区别，详情请参见：IAM与企业管理的区别。 “√”表示支持，“x”表示暂不支持。

请求参数 表2 参数说明 名称 是否必选 参数类型 说明 backup_policy 是 Object 备份策略信息。 详情参见表3。 表3 backup_policy字段数据结构说明 名称 是否必选 参数类型 说明 keep_days 是 Integer 备份文件可以保存的天数。 取值范围：1-36500天。 start_time 是 String 备份时间段。自动备份将在该时间段内触发。 取值范围：非空，格式必须为hh:mm-HH:MM且有效，当前时间指UTC时间。 HH取值必须比hh大1，mm和MM取值必须相同，且取值必须为00。 取值示例： 21:00-22:00 说明： 该时间段为执行备份的UTC时间段。比如备份时间是当地时间05:00-06:00，时区为UTC+08:00，则接口需要传入21:00-22:00；如果时区为UTC+04:00，接口传入01:00-02:00。 period 是 String 全量备份周期配置。自动全量备份将在每周对应的UTC日期进行。 取值范围：格式为逗号隔开的数字，数字代表星期，取1~7。 取值示例： 1,2,3,4 表示备份周期配置为星期一、星期二、星期三和星期四。 1,2,3,4,5,6,7 则表示星期一至星期日每天执行一次自动备份。 1,3,5表示周一、周三、周五执行一次自动备份。 说明： 该时间段为执行备份的UTC日期。比如备份时间为当地时间周一、周二05:00-06:00，时区为UTC+08:00，则period传入1,7；如果时区为UTC+04:00，period传入1,2。 differential_period 是 String 差异备份间隔时间配置。每次自动差异备份的间隔时间。 取值范围：15、30、60、180、360、720、1440。单位：分钟。 取值示例：30 rate_limit 否 Integer 备份限速,默认值为0MB/s，表示不限速。控制备份是备份数据上传OBS的速度，限速用于限制上传备份对上传带宽的影响 取值范围：0~ 1024 最小值：0 MB/s prefetch_block 否 Integer 控制差量备份时读取磁盘上表文件差量修改页面的预取页面个数。当差量修改页面非常集中时（如数据导入场景），可以适当调大该值；当差量修改页面非常分散时（如随机更新），可以适当调小该值。默认为64,单位个数 取值范围：1 ~ 8192 最小值：1 最大值：8192 file_split_size 否 Integer 全量、差量备份时产生的备份文件会根据该参数的值进行拆分，可设置范围为0~1024GB，设置需为4的倍数，默认4GB，0GB表示不限制大小。 取值范围：0 ~ 1024 最小值：0 最大值：1024 enable_standby_backup 否 Boolean 是否启用备机备份。(不支持单节点实例及3.100.0以下的实例)

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

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

URI GET https://{Endpoint}/v3/{project_id}/instances/kernel-plugins 表1 参数说明 参数 是否必选 参数类型 描述 project_id 是 String 参数解释： 租户在某一Region下的项目ID。 获取方法请参见获取项目ID。 约束限制： 不涉及。 取值范围： 只能由英文字母、数字组成，且长度为32个字符。 默认取值： 不涉及。

请求示例 查询所有备份列表 GET https://gaussdb-opengauss.cn-north-1.myhuaweicloud.com/v3.1/0483b6b16e954cb88930a360d2c4e663/backups 根据指定条件查询实例列表 GET https://gaussdb-opengauss.cn-north-1.myhuaweicloud.com/v3.1/0483b6b16e954cb88930a360d2c4e663/backups?instance_id=88be33e4c5a64ceba42b42da89310111in14&backup_id=88be1234c5a64ceba42b42da89310111br14&backup_type=auto&begin_time=2022-05-09T16:15:50+0800&end_time=2022-05-09T16:20:45+0800&limit=1&offset=1

响应示例 查询备份列表成功。 { "backups": [ { "id": "a696cd25e4fc453aa503650225cece8bbr14", "name": "GaussDB-hly-ha-20220509080110906", "status": "FAILED", "size": 0.0, "type": "auto", "datastore": { "type": "GaussDB", "version": "1.4" }, "begin_time": "2022-05-09T16:01:10+0800", "end_time": "2022-05-09T16:04:31+0800", "instance_id": "164abc6d35114095bb849d007b19db3bin14" }, { "id": "5651c62a7f12461c98020dd3abfe24ccbr14", "name": "GaussDB-hly-master-20220509022658257", "status": "FAILED", "size": 0.0, "type": "auto", "datastore": { "type": "GaussDB", "version": "1.4" }, "begin_time": "2022-05-09T10:26:58+0800", "end_time": "2022-05-09T10:30:17+0800", "instance_id": "fd26e3bf26e5467587eec857e4f66ef0in14" }], "total_count": 167}

URI GET https://{Endpoint}/v3.1/{project_id}/backups?instance_id={instance_id}&backup_id={backup_id}&backup_type={backup_type}&offset={offset}&limit={limit}&begin_time={begin_time}&end_time={end_time} 表1 参数说明 参数 是否必选 参数类型 描述 project_id 是 String 参数解释： 租户在某一Region下的项目ID。 获取方法请参见获取项目ID。 约束限制： 不涉及。 取值范围： 只能由英文字母、数字组成，且长度为32个字符。 默认取值： 不涉及。 instance_id 否 String 参数解释： 实例ID，此参数是用户创建实例的唯一标识，用于查询某一实例的备份。 约束限制： 日志备份列表查询时实例ID必选。 取值范围： 严格匹配UUID规则，只能由英文字母、数字组成，且长度为32个字符。 默认取值： 不涉及。 backup_id 否 String 参数解释： 备份ID，此参数是实例备份的唯一标识，用于查询某一备份的信息。 约束限制： 不涉及。 取值范围： 只能由英文字母、数字组成，且长度为36个字符且符合UUID规则。 默认取值： 不涉及。 backup_type 否 String 参数解释： 备份类型。 约束限制： 不涉及。 取值范围： auto：实例级自动全量备份。 manual：实例级手动全量备份。 默认取值： 不涉及。 offset 否 Integer 参数解释： 索引位置，偏移量。从第一条数据偏移offset条数据后开始查询。 约束限制： 不涉及。 取值范围： [0, 10^10-1] 默认取值： 默认为0（偏移0条数据，表示从第一条数据开始查询）。 limit 否 Integer 参数解释： 查询记录数。 约束限制： 不涉及。 取值范围： [0, 100] 默认取值： 默认为100。 begin_time 否 String 参数解释： 查询开始时间，格式为“yyyy-mm-ddThh:mm:ssZ”。其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。示例：2022-05-09T16:01:10+0800。 约束限制： 可与end_time配合使用，end_time不使用时，查询结果为begin_time之后创建的备份列表，使用end_time时，查询结果为begin_time和end_time之间创建的备份列表。 取值范围： 不涉及。 默认取值： 不涉及。 end_time 否 String 参数解释： 查询结束时间，格式为“yyyy-mm-ddThh:mm:ssZ”，且大于查询开始时间。其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。示例：2022-05-09T16:01:10+0800。 约束限制： 可与begin_time配合使用，begin_time不使用时，查询结果为end_time之前创建的备份列表，使用begin_time时，查询结果为begin_time和end_time之间创建的备份列表。 取值范围： 不涉及。 默认取值： 不涉及。

请求参数 表2 请求Body参数 参数 是否必选 参数类型 描述 port 是 string M兼容端口，可选范围为：1024-39989。 如下端口不可设置： 2378，2379，2380，2400，4999，5000，5001，5100，5500，5999，6000，6001，6009，6010，6500，8015，8097，8098，8181，9090，9100，9180，9187，9200，12016，12017，20049，20050，21731，21732，32122，32123，32124，32125，32126，39001，[数据库端口, 数据库端口+10]。

URI POST https://{Endpoint}/v3/{project_id}/instances/{instance_id}/mysql-compatibility 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 参数解释： 租户在某一Region下的项目ID。 获取方法请参见获取项目ID。 约束限制： 不涉及。 取值范围： 只能由英文字母、数字组成，且长度为32个字符。 默认取值： 不涉及。 instance_id 是 String 实例ID，严格匹配UUID规则。

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

请求参数 表2 参数说明 名称 是否必选 参数类型 说明 db_name 是 String 数据库名称。 使用已存在的数据库名称，且不能为模板库。 模板库包括postgres， template0 ，template1。 schema 是 String SCHEMA名称。 SCHEMA名称在1到63个字符之间，由字母、数字、或下划线组成，不能包含其他特殊字符，不能以“pg”和数字开头，且不能和模板库和已存在的SCHEMA重名。 模板库包括postgres， template0 ，template1。 已存在的SCHEMA包括public，information_schema。

请求示例 在gaussdb_test数据库中删除schema。 DELETE https://gaussdb-opengauss.cn-north-1.myhuaweicloud.com/v3/0483b6b16e954cb88930a360d2c4e663/instances/{instance_id}/schema{ "db_name" : "gaussdb_test", "schema" : "rds001" }

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

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 X-Language 否 String 语言。 缺省值：en-us 枚举值： zh-cn en-us 表3 请求Body参数 参数 是否必选 参数类型 描述 plugin_name 是 String 插件包名称。仅支持yukon的postgis插件。 db_list 是 Array of strings 数据库名称列表。 extension_name 是 String 拓展功能名称。 extension_action 是 String 拓展相关操作。on表示开启，off表示关闭。

请求示例 https://gaussdb-opengauss.cn-north-4.myhuaweicloud.com/v3/0c8243400d37468bb4aed3cc94c2911d/instances/f9b5f9b296ec6808e067in14/config-plugin-extensions{ "plugin_name" : "postgis", "db_list" : [ "test" ], "extension_name" : "postgis", "extension_action" : "on" }