华为云用户手册

响应参数 表2 响应Body参数 参数 参数类型 描述 list Array of SlowLogDownloadInfo objects 慢日志下载信息列表。详情请参见 表3 。 表3 SlowLogDownloadInfo字段数据结构说明 参数 参数类型 描述 id String 慢日志ID。 instance_id String 实例ID。 node_id String 节点ID。 workflow_id String 工作流ID。 file_name String 文件名。 file_size String 文件大小, 单位：Byte。 file_link String 文件下载链接。 bucket_name String 桶名称。 created_at Long 创建时间。 updated_at Long 更新时间。 version String 版本。 status String 状态。 message String 消息。

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

响应示例 { "created": "2022-04-11 10:46:59", "updated": "2022-04-11 10:46:59", "datastore_version": "2.0", "datastore_name": " GaussDB ", "configuration_parameters": [ { "name": "audit_system_object", "value": "12295", "type": "integer", "description": "该参数决定是否对数据库对象的CREATE、DROP、ALTER操作进行审计。", "restart_required": false, "value_range": "0-2097151" } ]}

响应参数 表2 响应参数 参数 参数类型 描述 datastore_version String 参数解释： 引擎版本。 取值范围： 不涉及。 datastore_name String 参数解释： 引擎名称。 取值范围： 不涉及。 created String 参数解释： 创建时间，格式为"yyyy-MM-dd HH:mm:ss"。例如：2024-05-14 07:31:11。 取值范围： 不涉及。 updated String 参数解释： 更新时间，格式为"yyyy-MM-ddHH:mm:ss"。例如：2024-05-14 07:31:11。 取值范围： 不涉及。 configuration_parameters Array of objects 参数解释： 参数对象，用户基于默认参数模板自定义的参数配置，具体请参考表3。 表3 configuration_parameters字段数据结构说明 参数 参数类型 描述 name String 参数解释： 参数名称。 取值范围： 不涉及。 value String 参数解释： 参数值。 取值范围： 不涉及。 restart_required Boolean 参数解释： 修改该参数是否需要重启实例。 取值范围： true，需要重启。 false，不需要重启。 value_range String 参数解释： 参数取值范围。 取值范围： 不涉及。 type String 参数解释： 参数类型。 取值范围： string integer boolean list float description String 参数解释： 参数描述。 取值范围： 不涉及。

响应示例 查询数据库角色列表成功。 { "roles": [ { "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}

响应参数 表2 参数说明 参数 参数类型 描述 roles Array of objects 参数解释： 列表中每个元素表示一个数据库用户/角色，详情参见表表3 roles字段数据结构说明。 total_count Integer 参数解释： 总记录数。 取值范围： [0, 2^31-1]，取决于实际查询大小。 表3 roles字段数据结构说明 参数 参数类型 描述 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 参数解释： 用户/角色密码过期时间。 取值范围： 不涉及。

URI GET https://{Endpoint}/v3.1/{project_id}/instances/{instance_id}/db-role 表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。

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

请求消息 表2 参数说明 名称 是否必选 参数类型 说明 db_name 是 String 数据库名称。 不能使用模板库，且是已存在的数据库名称。 模板库包括postgres， template0 ，template1。 user 是 Object 角色权限信息。详情请参见表表3 user字段数据结构说明。 表3 user字段数据结构说明 名称 是否必选 参数类型 说明 name 是 String 数据库角色名称。 不能使用系统用户或角色，且名称必须存在。 系统用户/角色包括“rdsAdmin”,“rdsMetric”, “rdsBackup”, “rdsRepl”, “root”。 readonly 是 Boolean 数据库权限。 true：只读。 false：可读可写。 schema 是 String SCHEMA名称。 不能和模板库以及系统内schema重名，且schema名称必须存在。 模板库包括postgres， template0 ，template1, 系统内schema包括public，information_schema。 default_privilege_grantee 否 String 数据库用户/角色名称。 该字段的含义是将此用户/角色的权限授予给name字段指定的角色，通过readonly字段判断是否授予只读权限。 不能和系统用户/角色名称相同，且用户/角色名称必须存在，系统用户/角色包括“rdsAdmin”,“ rdsMetric”, “rdsBackup”, “rdsRepl”, “root”。

请求示例 设置数据库角色权限。 POST https://gaussdb-opengauss.cn-north-1.myhuaweicloud.com/v3.1/0483b6b16e954cb88930a360d2c4e663/instances/{instance_id}/db-privilege{ "db_name" : "gaussdb_test", "user" : { "name" : "rds", "schema" : "rds001", "readonly" : false , "default_privilege_grantee": "" } }

请求示例 查询批量实例可升级的版本和升级类型。 POST https://gaussdb-opengauss.cn-north-4.myhuaweicloud.com/v3/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": [ "8.302.90" ], "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/{project_id}/instances/db-upgrade/candidate-versions 表1 参数说明 参数 是否必选 参数类型 描述 project_id 是 String 参数解释： 租户在某一Region下的项目ID。 获取方法请参见获取项目ID。 约束限制： 不涉及。 取值范围： 只能由英文字母、数字组成，且长度为32个字符。 默认取值： 不涉及。

请求参数 表2 参数说明 名称 是否必选 参数类型 说明 name 是 String 数据库角色名称，不可与已有角色名称重复。 数据库角色名称在1到63个字符之间，由字母、数字、或下划线组成，不能包含其他特殊字符，不能以“pg”和数字开头，不能和系统用户/角色名称相同。 系统用户/角色包括“rdsAdmin”,“ rdsMetric”, “rdsBackup”, “rdsRepl”, “root”。 password 是 String 数据库角色密码。 取值范围：非空，密码长度在8到32个字符之间，至少包含大写字母、小写字母、数字、特殊字符~!@#%^*-_=+?,三种字符的组合，不能和数据库账号“name”或“name”的逆序相同。 建议您输入高强度密码，以提高安全性，防止出现密码被暴力破解等安全风险。

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

请求示例 创建一个 GaussDB数据库 角色，角色名为dbs。 POST https://gaussdb-opengauss.cn-north-1.myhuaweicloud.com/v3.1/0483b6b16e954cb88930a360d2c4e663/instances/{instance_id}/db-role{ "name" : "dbs", "password" : "******" }

响应示例 实例在滚动升级中时，只返回滚动升级目标版本与滚动升级分片和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": "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": [ "8.300.0", "8.103.0" ], "hotfix_upgrade_candidate_versions": [], "hotfix_rollback_candidate_versions": [], "hotfix_upgrade_infos": [], "hotfix_rollback_infos": []}

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

状态码 状态码如表1所示： 表1 状态码 状态码 编码 错误码说明 100 Continue 继续请求。 这个临时响应用来通知客户端，它的部分请求已经被服务器接收，且仍未被拒绝。 101 Switching Protocols 切换协议。只能切换到更高级的协议。 例如，切换到HTTP的新版本协议。 200 OK 请求成功。 201 Created 创建类的请求完全成功。 202 Accepted 已经接受请求，但未处理完成。 203 Non-Authoritative Information 非授权信息，请求成功。 204 NoContent 请求完全成功，同时HTTP响应不包含响应体。 在响应OPTIONS方法的HTTP请求时返回此状态码。 205 Reset Content 重置内容，服务器处理成功。 206 Partial Content 服务器成功处理了部分GET请求。 300 Multiple Choices 多种选择。请求的资源可包括多个位置，相应可返回一个资源特征与地址的列表用于用户终端（例如：浏览器）选择。 301 Moved Permanently 永久移动，请求的资源已被永久的移动到新的URI，返回信息会包括新的URI。 302 Found 资源被临时移动。 303 See Other 查看其它地址。 使用GET和POST请求查看。 304 Not Modified 所请求的资源未修改，服务器返回此状态码时，不会返回任何资源。 305 Use Proxy 所请求的资源必须通过代理访问。 306 Unused 已经被废弃的HTTP状态码。 400 BadRequest 非法请求。 建议直接修改该请求，不要重试该请求。 401 Unauthorized 在客户端提供认证信息后，返回该状态码，表明服务端指出客户端所提供的认证信息不正确或非法。 402 Payment Required 保留请求。 403 Forbidden 请求被拒绝访问。 返回该状态码，表明请求能够到达服务端，且服务端能够理解用户请求，但是拒绝做更多的事情，因为该请求被设置为拒绝访问，建议直接修改该请求，不要重试该请求。 404 NotFound 所请求的资源不存在。 建议直接修改该请求，不要重试该请求。 405 MethodNotAllowed 请求中带有该资源不支持的方法。 建议直接修改该请求，不要重试该请求。 406 Not Acceptable 服务器无法根据客户端请求的内容特性完成请求。 407 Proxy Authentication Required 请求要求代理的身份认证，与401类似，但请求者应当使用代理进行授权。 408 Request Time-out 服务器等候请求时发生超时。 客户端可以随时再次提交该请求而无需进行任何更改。 409 Conflict 服务器在完成请求时发生冲突。 返回该状态码，表明客户端尝试创建的资源已经存在，或者由于冲突请求的更新操作不能被完成。 410 Gone 客户端请求的资源已经不存在。 返回该状态码，表明请求的资源已被永久删除。 411 Length Required 服务器无法处理客户端发送的不带Content-Length的请求信息。 412 Precondition Failed 未满足前提条件，服务器未满足请求者在请求中设置的其中一个前提条件。 413 Request Entity Too Large 由于请求的实体过大，服务器无法处理，因此拒绝请求。为防止客户端的连续请求，服务器可能会关闭连接。如果只是服务器暂时无法处理，则会包含一个Retry-After的响应信息。 414 Request-URI Too Large 请求的URI过长（URI通常为网址），服务器无法处理。 415 Unsupported Media Type 服务器无法处理请求附带的媒体格式。 416 Requested range not satisfiable 客户端请求的范围无效。 417 Expectation Failed 服务器无法满足Expect的请求头信息。 422 UnprocessableEntity 请求格式正确，但是由于含有语义错误，无法响应。 429 TooManyRequests 表明请求超出了客户端访问频率的限制或者服务端接收到多于它能处理的请求。建议客户端读取相应的Retry-After首部，然后等待该首部指出的时间后再重试。 500 InternalServerError 表明服务端能被请求访问到，但是不能理解用户的请求。 501 Not Implemented 服务器不支持请求的功能，无法完成请求。 502 Bad Gateway 充当网关或代理的服务器，从远端服务器接收到了一个无效的请求。 503 ServiceUnavailable 被请求的服务无效。 建议直接修改该请求，不要重试该请求。 504 ServerTimeout 请求在给定的时间内无法完成。客户端仅在为请求指定超时（Timeout）参数时会得到该响应。 505 HTTP Version not supported 服务器不支持请求的HTTP协议的版本，无法完成处理。 父主题： 附录

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用 IAM 服务获取用户Token接口获取。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 X-Language 否 String 语言。 缺省值：en-us 枚举值： zh-cn en-us 表3 请求Body参数 参数 是否必选 参数类型 描述 params 是 Object 需要修改的特性列表，参数值为JSON格式，可通过查询高级特性接口的响应参数获取。其中，key值对应查询高级特性接口响应参数中name的值，value值可通过响应参数range_description的值获取。 { "key" : "value" }

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

请求示例 修改高级特性。 POST https://gaussdb-opengauss.cn-north-1.myhuaweicloud.com/v3/0483b6b16e954cb88930a360d2c4e663/instances/e73893ef73754465a8bd2e0857bbf13ein14/advance-features{ "params": { "ledger": "on", "security": "on", "ilm": "on", "vectordb": "on" }}

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

请求参数 表2 请求Body参数 参数 是否必选 参数类型 描述 port 是 string M兼容端口，可选范围为：0, 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]。 取值为0，表示关闭M兼容端口。

请求示例 修改M兼容端口为3307。 PUT https://gaussdb-opengauss.cn-north-1.myhuaweicloud.com/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/1bb786201ae54b179b45c17e0f332f4bin14/mysql-compatibility{ "port" : "3307"} 关闭M兼容端口。 PUT https://gaussdb-opengauss.cn-north-1.myhuaweicloud.com/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/1bb786201ae54b179b45c17e0f332f4bin14/mysql-compatibility{ "port" : "0"}

响应示例 { "backups": [ { "id": "a696cd25e4fc453aa503650225cece8bbr14", "name": "GaussDB-hly-ha-20220509080110906", "description": null, "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", "description": null, "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/{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" ] }