华为云用户手册

URI GET https://{Endpoint}/v3/{project_id}/tasks 表1 参数说明 名称 是否必选 参数类型 说明 project_id 是 String 参数解释： 租户在某一Region下的项目ID。 获取方法请参见获取项目ID。 约束限制： 不涉及。 取值范围： 只能由英文字母、数字组成，且长度为32个字符。 默认取值： 不涉及。 status 否 String 任务状态。 Running：运行中 Completed：完成 Failed：失败 name 否 String 任务名称。 Create GaussDB V5Instance：创建实例。 BackupSnapshotGaussDBV5InInstance：手动创建备份。 CloneGaussDBV5NewInstance：恢复到新实例。 RestoreGaussDBV5InInstance：恢复到当前实例。 RestoreGaussDBV5InInstanceToExistedInst：恢复到已有实例 DeleteGaussDBV5Instance：删除实例。 EnlargeGaussDBV5Volume：磁盘扩容。 ResizeGaussDBV5Flavor：规格变更。 GaussDBV5ExpandClusterCN：协调节点扩容。 GaussDBV5ExpandClusterDN：分片扩容。 start_time 否 String 开始时间。UNIX时间戳格式，单位是毫秒，时区是UTC。 end_time 否 String 结束时间。UNIX时间戳格式，单位是毫秒，时区是UTC。 offset 否 Integer 索引位置，偏移量。从第一条数据偏移offset条数据后开始查询，默认为0（偏移0条数据，表示从第一条数据开始查询），必须为数字，不能为负数。 limit 否 Integer 查询记录数。默认为100，不能为负数，最小值为1，最大值为100。

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

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

URI GET https://{Endpoint}/v3/{project_id}/enterprise-projects/quotas 表1 参数说明 参数 是否必选 参数类型 描述 project_id 是 String 参数解释： 租户在某一Region下的项目ID。 获取方法请参见获取项目ID。 约束限制： 不涉及。 取值范围： 只能由英文字母、数字组成，且长度为32个字符。 默认取值： 不涉及。 enterprise_project_id 否 String 企业项目ID。 - 对于未开通企业多项目服务的用户，不传该参数。 - 对于已开通企业多项目服务的用户，不传该参数时，表示为default企业项目。 offset 否 Integer 索引位置，偏移量。从第一条数据偏移offset条数据后开始查询，默认为0（偏移0条数据，表示从第一条数据开始查询），必须为数字，不能为负数。例如：该参数指定为0，limit指定为10，则只展示第1-10条数据。 limit 否 Integer 查询记录数。默认为100，不能为负数，最小值为1，最大值为100。例如该参数设定为10，则查询结果最多只显示10条记录。

响应参数 表2 参数说明 名称 参数类型 说明 eps_quotas Array of objects 企业项目详情列表。 详情请参见表3。 total_count Integer 总记录数。 表3 eps_quotas字段数据结构说明 名称 参数类型 说明 enterprise_project_id String 企业项目ID。 enterprise_project_name String 企业项目名称。 instance_eps_quota Integer EPS实例资源配额数量，值为-1时表示配额无限制。 vcpus_eps_quota Integer EPS计算资源配额数量，值为-1时表示配额无限制。 ram_eps_quota Integer EPS内存资源配额量，单位为GB，值为-1时表示配额无限制。 volume_eps_quota Integer EPS磁盘资源配额量，单位为GB，值为-1时表示配额无限制。 instance_used Integer EPS实例使用数量。 vcpus_used Integer EPS计算资源使用数量。 ram_used Integer EPS内存使用配额量，单位为GB。 volume_used Integer EPS磁盘使用配额量，单位为GB。

响应示例 { "eps_quotas" : [ { "enterprise_project_id" : "2c049d98-3347-494f-8767-99af6b3aa5f0", "enterprise_project_name" : "default", "instance_eps_quota" : 100, "vcpus_eps_quota" : 1500, "ram_eps_quota" : 20000, "volume_eps_quota" : 100000, "instance_used" : 33, "vcpus_used" : 1460, "ram_used" : 19680, "volume_used" : 8840 }, { "enterprise_project_id" : "2c049d98-3347-494f-8767-99af6b3aa5f0", "enterprise_project_name" : "11111", "instance_eps_quota" : -1, "vcpus_eps_quota" : -1, "ram_eps_quota" : -1, "volume_eps_quota" : -1, "instance_used" : 2, "vcpus_used" : 54, "ram_used" : 384, "volume_used" : 680 }, { "enterprise_project_id" : "bd91e1eb-2e33-4f17-a8d4-05eb2c805781", "enterprise_project_name" : "quota_at_gaussdbv5_test", "instance_eps_quota" : -1, "vcpus_eps_quota" : -1, "ram_eps_quota" : -1, "volume_eps_quota" : -1, "instance_used" : 1, "vcpus_used" : 240, "ram_used" : 1920, "volume_used" : 480 } ], "total_count" : 3 }

URI GET https://{Endpoint}/v3/{project_id}/instances/{instance_id}/restore-time?date={date} 表1 参数说明 参数 是否必选 参数类型 描述 project_id 是 String 参数解释： 租户在某一Region下的项目ID。 获取方法请参见获取项目ID。 约束限制： 不涉及。 取值范围： 只能由英文字母、数字组成，且长度为32个字符。 默认取值： 不涉及。 instance_id 是 String 实例ID。 date 是 String 所需查询的日期，为yyyy-mm-dd字符串格式，时区为UTC。

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

响应示例 查询可恢复时间段成功。 { "restore_time": [ { "start_time": 1652084311000, "end_time": 1652092839000 }, { "start_time": 1652092847000, "end_time": 1652094792000 } ]}

响应参数 表2 参数说明 参数 参数类型 描述 restore_time Array of objects 可恢复时间段列表。 详情请参见表3 表3 restore_time字段数据结构说明 参数 参数类型 描述 start_time Long 可恢复时间段的起始时间点，UNIX时间戳格式，单位是毫秒，时区是UTC+8。 end_time Long 可恢复时间段的结束时间点，UNIX时间戳格式，单位是毫秒，时区是UTC+8。

响应参数 表2 参数说明 参数 参数类型 描述 backup_policy Object 备份策略信息。 详情请参见表3 表3 backup_policy字段数据结构说明 参数 参数类型 描述 keep_days Integer 全量备份文件可以保存的天数。取值范围：1~732。 最小值：1 最大值：732 start_time String 全量备份时间段。自动备份将在该时间段内触发。取值范围：格式必须为hh:mm-HH:MM且有效，当前时间指UTC时间。 HH取值必须比hh大1。 mm和MM取值必须相同，且取值必须为00。 period String 全量备份周期配置。自动备份将在每星期指定的天进行。 取值范围：格式为逗号隔开的数字，数字代表星期。 取值示例： 1,2,3,4 表示备份周期配置为星期一、星期二、星期三和星期四。 1,2,3,4,5,6,7 则表示星期一至星期日每天执行一次自动备份。 1,3,5表示周一、周三、周五执行一次自动备份。 differential_priod String 差量备份周期配置。自动差量备份将每隔周期分钟执行（废弃）。 differential_period Integer 差量备份周期配置。自动差量备份将每隔周期分钟执行。 rate_limit Integer 备份限速,默认值为0MB/s，表示不限速。控制备份是备份数据上传OBS的速度，限速用于限制上传备份对上传带宽的影响 prefetch_block Integer 控制差量备份时读取磁盘上表文件差量修改页面的预取页面个数。当差量修改页面非常集中时（如数据导入场景），可以适当调大该值；当差量修改页面非常分散时（如随机更新），可以适当调小该值。默认为64,单位个数 filesplit_size Integer 废弃字段。 file_split_size Integer 全量、差量备份时产生的备份文件会根据分片大小进行拆分，可设置范围为0~1024GB，设置需为4的倍数，默认4GB，0GB表示不限制大小。 enable_standby_backup Boolean 是否启用备机备份。 true：启用备机备份。 false：不启用备机备份。

响应示例 查询自动备份策略成功。 { "backup_policy": { "period": "1,2,3,4,5,6,7", "keep_days": 7, "start_time": "18:00-19:00", "differential_period": 30 , "rate_limit": 75 , "prefetch_block": 64 , "file_split_size": 4 , "enable_standby_backup" : false }}

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

响应参数 表3 参数说明 参数 参数类型 描述 differences Array of objects 参数组之间的差异集合。 详情请参见表 differences字段数据结构说明 表4 differences字段数据结构说明 参数 参数类型 描述 name String 参数名称。 source_value String 比较参数组的参数值。 target_value String 目标参数组的参数值。

请求示例 复制参数模板。 POST https://gaussdb-opengauss.cn-north-4.myhuaweicloud.com/v3/619d3e78f61b4be68bc5aa0b59edcf7b/configurations/3ca44134a16d4bbab8eb701e025b19f7pr14/copy{ "name" : "paramTemplate-1233", "description" : "描述" }

请求示例 查询两个参数组模板的差异列表。 POST https://gaussdb-opengauss.cn-north-1.myhuaweicloud.com/v3/0483b6b16e954cb88930a360d2c4e663/configurations/comparison{ "source_id" : "3e9f722f27c9477089bdf576b33f9d8epr14", "target_id" : "a51fcdde022a4ea8a016a3c4671644f4pr14"}

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

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

请求示例 切换多个DN分片的主备。 POST https://gaussdb-opengauss.cn-north-1.myhuaweicloud.com/v3/0c8243400d37468bb4aed3cc94c2911d/instances/f9b5f9b296ec6808e067in14/switch-shard{ "shards": [ { "node_id": "0bc478b4d132494a8f7b804da521b4b2no14", "component_id": "dn_6001" }, { "node_id": "53dee94c50574d36a0060db0a6b644f6no14", "component_id": "dn_6004" } ]}

请求参数 表2 参数说明 名称 是否必选 参数类型 说明 shards 是 Array 节点列表，支持对单个或者多个DN分片做主备切换。节点信息为将要升主的备DN分片对应的节点ID(node_id)和组件ID(component_id)。具体请参考表3。 表3 shards参数说明 名称 是否必选 参数类型 说明 node_id 是 String 将要升主的备DN的节点ID。 component_id 是 String 将要升主的备DN的组件ID。最大长度7个字符，不能为null或者空字符串，不能为空格，校验和使用之前会自动过滤掉前后空格。至少包含大写字母（A-Z），小写字母（a-z），数字（0-9），非字母数字字符（限定为_）四类字符中的三类字符。组件ID通过查询实例的组件列表获取。

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

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

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

响应示例 获取指定实例的参数成功。 { "created": "2022-04-11 10:46:59", "updated": "2022-04-11 10:46:59", "datastore_version": "V2.0-2.0", "datastore_name": "GaussDB", "configuration_parameters": [ { "name": "audit_system_object", "value": "12295", "type": "integer", "description": "Determines whether to audit the CREATE, DROP, and ALTER operations on GaussDB Kernel database objects. GaussDB Kernel database objects include databases, users, schemas, and tables. You can change the parameter value to audit only the operations on required database objects. During a forcible primary/standby failover, set audit_system_object to the maximum value and audit all DDL objects. If the parameter value is incorrectly changed, DDL audit logs will be lost. Contact customer service personnel to change it.", "restart_required": false, "value_range": "0-2097151" } ]}

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

请求示例 停止实例且开启透明事务。 POST https://gaussdb-opengauss.cn-north-4.myhuaweicloud.com/v3/054e292c9880d4992f02c0196d3ea468/instances/d8e6ca5a624745bcb546a227aa3ae1cfin14/db-stop{ "node_ids": ["187ff420e15c467eaaef226154eb1578no14","4ed9cbb0d61144e0802a82c0ab0e1de5no14"]}

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用 IAM 服务获取用户Token接口获取。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 X-Language 否 String 语言。 缺省值：en-us 枚举值： zh-cn en-us 表3 请求Body参数 参数 是否必选 参数类型 描述 node_ids 是 Array of strings 需要停止的节点的ID，取值不能为null，如果为空列表，则停止整个实例。

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

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

请求示例 为GaussDB实例绑定弹性公网IP。 POST https://gaussdb-opengauss.cn-north-1.myhuaweicloud.com/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in14/nodes/0bc478b4d132494a8f7b804da521b4b2no14/public-ip{ "action": "BIND", "public_ip": "10.154.218.161", "public_ip_id": "45da4782-e0c8-4aa4-a290-b8740014f710"}