华为云用户手册

响应消息 正常响应要素说明 表2 要素说明 名称 参数类型 说明 cert_info_list Array 证书列表。详情请参见表3。 表3 cert_info_list字段数据结构说明 名称 参数类型 说明 download_link String 下载链接。 category String 证书类型。枚举值： international national 正常响应样例 { "cert_info_list": [ { "category": "international", "download_link": "https://{region}.huaweicloud.com/rds/Certificate_Download.zip" } ] } 异常响应 请参见异常请求结果。

URI URI格式 POST /v3/{project_id}/instances/{instance_id}/slowlog-download 参数说明 表1 参数说明 名称 是否必选 说明 project_id 是 参数解释： 租户在某一Region下的项目ID。 获取方法请参见获取项目ID。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 instance_id 是 参数解释： 要查询的实例ID。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。

响应消息 正常响应要素说明 表3 要素说明 名称 参数类型 说明 list List 参数解释： 慢日志下载链接列表，详见表4。 status String 参数解释： 慢日志下载链接生成状态。 取值范围： FINISH，表示下载链接已经生成完成。 CREATING，表示正在生成文件，准备下载链接。 FAILED，表示存在日志文件准备失败。 count Integer 参数解释： 慢日志链接数量。 取值范围： 不涉及。 表4 linkInfo字段数据结构说明 名称 参数类型 说明 workflow_id String 参数解释： 任务ID。 取值范围： MySQL引擎该字段值固定为""。 file_name String 参数解释： 生成的下载文件名。 取值范围： 不涉及。 status String 参数解释： 当前链接的生成状态。 取值范围： EXPORTING，下载链接正在生成中。 SUC CES S，下载链接生成成功。 FAILED，下载链接生成失败。 file_size String 参数解释： 文件大小。单位：KB。 取值范围： 不涉及。 file_link String 参数解释： 下载链接。链接有效时间为5分钟。 取值范围： 不涉及。 create_at Long 参数解释： 生成时间。 取值范围： 不涉及。 update_at Long 参数解释： 更新时间。 取值范围： 不涉及。 正常响应样例 { "list": [ { "workflow_id": "44fb1d85-2fcc-4d63-ad3b-c3d1ecd7000e", "file_name": "054bc9c1f680d55c1f36c006e5a9f67b_slowlog_download_20200515080614589", "status": "SUCCESS", "file_size": "0", "file_link": "https://rdsbucket.xxxr.obs.cn-xianhz-1.myhuaweicloud.com:443/054bc9c1f680d55c1f36c006e5a9f67b_slowlog_download_20200515080614589?AWSAccessKeyId=1BQ38TBCQHAVQXBUMUTC&Expires=1589530200&response-cache-control=no-cache%2Cno-store&Signature=Fgi4%2BLOJ9frAXyOkz5hRoW5O%2BUM%3D", "create_at": 1589529991385, "update_at": 1589529991385 } ], "status": "finish", "count": 1 } 异常响应 请参见异常请求结果。

请求示例 获取慢日志文件“Database_slowlog_name”的下载链接。 POST https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/cee5265e1e5845649e354841234567dfin01/slowlog-download { "file_name":"Database_slowlog_name" }

接口约束 如需批量停止实例，请联系客服申请。 最多支持批量停止50个实例。 该接口仅支持MySQL引擎。 仅支持停止存储类型为超高IO、SSD云盘、极速型SSD的按需实例，专属云RDS不支持停止实例。 已停止的实例被删除后不会进入回收站。 停止主实例时，如果存在只读实例，会同时停止只读实例。不支持单独停止只读实例。对于华东-上海一区域，主实例和只读实例均默认停止十五天。对于除华东-上海一外的其他区域，主实例和只读实例均默认停止七天。 对于华东-上海一区域，实例默认停止十五天，如果您在十五天后未手动开启实例，数据库实例将于十五天后的下一个可维护时间段内自动启动。 对于除华东-上海一外的其他区域，实例默认停止七天，如果您在七天后未手动开启实例，数据库实例将于七天后的下一个可维护时间段内自动启动。 实例停止后，虚拟机（VM）停止收费，其余资源包括弹性公网IP（EIP）、存储资源、备份正常计费。 实例在以下状态不能执行停止实例： 创建、重启、扩容、变更规格、恢复、修改端口等不能进行此操作。

响应消息 正常响应要素说明 表3 要素说明 名称 参数类型 说明 records List 停止结果记录。 详情请参见表4。 表4 records字段说明 名称 参数类型 说明 instance_id String 实例ID。 job_id String 任务ID。 正常响应样例 { "records": [ { "instance_id": "5b409baece064984a1b3eef6addae50cin01", "job_id": "2b414788a6004883a02390e2eb0ea227" } ] } 异常响应 请参见异常请求结果。

响应消息 正常响应要素说明 表2 要素说明 名称 参数类型 说明 instance_id String 实例ID。 dns_name String 实例 域名 。 dns_type String 实例域名类型：private ipv6_address String 实例域名绑定的vIP。 status String 域名状态。 正常响应样例 { "instance_id": "2de6315e7197418fbf2fdaed59d65da1in03", "dns_name": "2de6315e7197418fbf2fdaed59d65da1in03.ipv6.internal.***.mysql.rds-dev.myhuaweicloud.com", "dns_type": "private", "ipv6_address": "2001:db8:a583:3:2312:c71d:6e71:c952", "status": "normal" } 异常响应 请参见异常请求结果。

响应消息 正常响应要素说明 表2 要素说明 名称 参数类型 说明 instance_id String 实例ID。 dns_name String 实例域名。 dns_type String 实例域名类型：private ipv4_address String 实例域名绑定的vIP。 status String 域名状态。 正常响应样例 { "instance_id": "2de6315e7197418fbf2fdaed59d65da1in03", "dns_name": "2de6315e7197418fbf2fdaed59d65da1in03.internal.cn-xianhz-1.mysql.rds-dev.myhuaweicloud.com", "dns_type": "private", "ipv4_address": "192.168.6.105", "status": "normal" } 异常响应 请参见异常请求结果。

请求示例 设置实例每1秒监控一次。 PUT https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/3d39c18788b54a919bab633874c159dfin01/second-level-monitor { "switch_option" : true, "interval" : 1 } 关闭秒级监控。 { "switch_option" : false }

接口约束 账户余额必须大于等于0元，余额不足会导致自动扩容失败。 该接口仅支持RDS for MySQL和RDS for PostgreSQL磁盘大小为40GB及以上的云盘实例（即存储类型为SSD云盘或极速型SSD）。 实例在进行规格变更、内核小版本升级、备机迁移、重启时，不能进行自动扩容。 包周期实例存在未完成订单时，不会自动扩容。 实例状态为“正常”和“存储空间满”时可以进行扩容。最大可自动扩容至4000GB。

请求示例 设置实例可用存储空间小于等于总空间10%或者为10GB时触发自动扩容，扩容上限为4000GB。 PUT https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/3d39c18788b54a919bab633874c159dfin01/disk-auto-expansion { "switch_option" : true, "limit_size" : 4000, "trigger_threshold" : 10 } 设置实例可用存储空间小于等于总空间10%或者为10GB时触发自动扩容，扩容上限为4000GB，每次自动扩容当前存储空间的20%。 { "switch_option" : true, "limit_size" : 4000, "trigger_threshold" : 10, "step_percent" : 20 }

请求消息 表2 参数说明 名称 是否必选 参数类型 说明 switch_option 是 Boolean 是否开启自动扩容。 true为开启。 false为关闭。 limit_size 否 Integer 扩容上限，单位GB。“switch_option”为true时，该参数必填。 取值范围40GB~4000GB，需要大于等于实例当前存储空间总大小。 trigger_threshold 否 Integer 可用存储空间百分比，小于等于此值或者为10GB时触发扩容。“switch_option”为true时，该参数必填。 枚举值： 10 15 20 step_percent 否 Integer 每次自动扩容的步长，单位为百分比，即每次自动扩容当前存储空间的百分比。取值范围为5%~50%。 “switch_option”为true，且开启了自定义扩容步长功能时，该参数可选，不填时默认为20%。

响应消息 正常响应要素说明 表2 要素说明 名称 参数类型 说明 switch_option Boolean 是否已开启自动扩容。 true为开启。 false为关闭。 limit_size Integer 扩容上限，单位GB。 trigger_threshold Integer 可用空间百分比，小于等于此值或者为10GB时触发扩容。 step_percent Integer 每次自动扩容的步长，单位为百分比，即每次自动扩容当前存储空间的百分比。 此参数仅会在开启自定义扩容步长功能时返回。 如需自定义扩容步长，请联系客服申请。 正常响应样例 未开启自定义步长功能时查询到的自动扩容策略。 { "switch_option" : true, "limit_size" : 4000, "trigger_threshold" : 10 } 开启自定义步长功能时查询到的自动扩容策略。 { "switch_option" : true, "limit_size" : 4000, "trigger_threshold" : 10, "step_percent" : 30 } 异常响应 请参见异常请求结果。

接口约束 仅支持停止存储类型为超高IO、SSD云盘、极速型SSD的按需实例，专属云RDS不支持停止实例。 已停止的实例被删除后不会进入回收站。 停止主实例时，如果存在只读实例，会同时停止只读实例。不支持单独停止只读实例。对于华东-上海一区域，主实例和只读实例均默认停止十五天。对于除华东-上海一外的其他区域，主实例和只读实例均默认停止七天。 对于华东-上海一区域，实例默认停止十五天，如果您在十五天后未手动开启实例，数据库实例将于十五天后的下一个可维护时间段内自动启动。 对于除华东-上海一外的其他区域，实例默认停止七天，如果您在七天后未手动开启实例，数据库实例将于七天后的下一个可维护时间段内自动启动。 实例停止后，虚拟机（VM）停止收费，其余资源包括弹性公网IP（EIP）、存储资源、备份正常计费。 按需付费的数据库实例停止实例后，可能会出现由于资源不足引起开启失败，如遇到无法开启的情况请联系客服人员处理。 实例在以下状态不能执行停止实例： 创建、重启、扩容、变更规格、恢复、修改端口等不能进行此操作。

请求消息 表2 参数说明 名称 是否必选 参数类型 说明 port 是 Integer 端口号。 RDS for MySQL端口号范围：大于等于1024，小于等于65535，不包含12017、33062和33071。 RDS for PostgreSQL端口号范围：2100～9500。 对于RDS for SQL Server 2022 EE、2022 SE、2022 Web版、2019 EE、2019 SE、2019 Web版、2017 EE、2017 SE、2017 Web版：端口设置范围为1433和2100~9500（其中5050、5353、5355、5985和5986不可设置）。 除此之外的其他版本：端口设置范围为1433和2100~9500（其中5355、5985和5986不可设置）。

接口约束 该接口仅支持MySQL和PostgreSQL引擎。 RDS for MySQL 5.6、5.7、8.0版本的主备实例支持备机可用区迁移功能。其中，RDS for MySQL 5.6和5.7版本的本地盘实例备机可用区迁移，以及8.0版本的备机可用区迁移功能需要联系客服人员申请权限。 仅支持HA实例。 实例在创建、重启、数据库升级、变更规格、修改端口、创建用户、删除用户状态下，不能进行此操作。

响应消息 正常响应要素说明 名称 说明 workflowId 任务ID。 instanceId 实例ID。 replicationMode 同步模式。 正常响应样例 { "instanceId": "c8a7d0abe94840dda99bc437e9442982in01", "replicationMode": "async", "workflowId": "7b55d6ca-dc8e-4844-a9da-6c53a1506db3" } 异常响应 请参见异常请求结果。

响应消息 正常响应要素说明 名称 说明 workflowId 任务ID。 instanceId 实例ID。 nodeId 节点ID。 正常响应样例 { "workflowId":"072beb09-0573-40bf-bfe8-4be5cec9e85a", "instanceId":"794c38e5309344818f4b33b86ebce9b4in03", "nodeId":"b94ba815747040f1b0d641cd13364a06no03" } 异常响应 请参见异常请求结果。

请求消息 表2 参数说明 名称 是否必选 参数类型 说明 repairStrategy 是 String 可用性策略，可选择如下方式： reliability：可靠性优先，数据库应该尽可能保障数据的可靠性，即数据丢失量最少。对于数据一致性要求较高的业务，建议选择该策略。 availability：可用性优先，数据库应该可快恢复服务，即可用时间最长。对于数据库在线时间要求较高的业务，建议选择该策略。

请求消息 表2 参数说明 名称 是否必选 参数类型 说明 db_user_pwd 是 String 数据库密码。 取值范围： RDS for MySQL： 非空，密码长度为8~32个字符，至少包含以下字符中的三种：大写字母、小写字母、数字、特殊字符~!@#$%^*-_=+?,()&组成。 RDS for PostgreSQL： 非空，密码长度为8~32个字符，至少包含以下字符中的三种：大写字母、小写字母、数字、特殊字符~!@#%^*-_=+?,组成。 建议您输入高强度密码，以提高安全性，防止出现密码被暴力破解等安全风险。

请求消息 表2 参数说明 名称 是否必选 参数类型 说明 public_ip 否 String 须知： “is_bind”为“true”时，“public_ip”为必选。 待绑定的弹性公网IP地址，仅允许使用标准的IP地址格式。 public_ip_id 否 String 须知： “is_bind”为“true”时，“public_ip_id”为必选 弹性公网IP对应的ID，仅允许使用标准的UUID格式。 is_bind 是 Boolean true：绑定弹性公网IP。 false：解绑弹性公网IP。

请求示例 绑定弹性公网IP。 PUT https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in01/public-ip { "public_ip":"10.10.10.1", "public_ip_id":"8403e9cd-a7fa-4288-8b15-c7ceac1etest", "is_bind":true } 解绑弹性公网IP。 { "is_bind":false }

请求消息 表2 参数说明 名称 是否必选 参数类型 说明 name 是 String 实例名称。 用于表示实例的名称，同一租户下，同类型的实例名可重名。取值规则如下： RDS for MySQL支持的字符长度是4~64个字节，必须以字母或中文开头，区分大小写，可以包含字母、数字、中文字符（一个中文字符占用3个字节）、中划线、点或者下划线，不能包含其他的特殊字符。 RDS for PostgreSQL和RDS for SQL Server支持的字符长度是4~64个字节，必须以字母或中文开头，区分大小写，可以包含字母、数字、中文字符（一个中文字符占用3个字节）、中划线或者下划线，不能包含其他的特殊字符。

请求示例 生成审计日志下载链接。 POST https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/cee5265e1e5845649e354841234567dfin01/auditlog-links { "ids": ["fa163e9970a3t11e9d834e122fdceb1d6br01", "fa163ea0e2bet11e9d8364943103c94c5br01"] }

响应消息 正常响应要素说明 表3 要素说明 名称 参数类型 说明 links Array of strings 审计日志下载链接列表，有效时间5分钟。 正常响应样例 { "links": ["https://obs.domainname.com/rdsbucket.username.1/xxxxxx", "https://obs.domainname.com/rdsbucket.username.2/xxxxxx"] } 异常响应 请参见异常请求结果。

请求消息 请求参数 无。 URI样例 GET https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/cee5265e1e5845649e354841234567dfin01/auditlog?start_time=2019-11-06T09:00:00+0800&end_time=2019-11-07T10:40:15+0800&offset=0&limit=10

响应消息 正常响应要素说明 表2 要素说明 名称 参数类型 说明 auditlogs Array of objects 参数解释： 具体信息。 详情请参见表3。 total_record Integer 参数解释： 总记录数。 取值范围： 不涉及。 表3 auditlogs字段数据结构说明 名称 参数类型 说明 id String 参数解释： 审计日志ID。当引擎为SQL Server时，ID为审计日志文件名。 取值范围： 不涉及。 name String 参数解释： 审计日志文件名。 取值范围： 不涉及。 size Long 参数解释： 审计日志大小，单位：KB 取值范围： 不涉及。 begin_time String 参数解释： 审计日志开始时间。 取值范围： 格式为“yyyy-mm-ddThh:mm:ssZ”。 其中，T指某个时间的开始，Z指时区偏移量，例如北京时间偏移显示为+0800。 end_time String 参数解释： 审计日志结束时间。 取值范围： 格式为“yyyy-mm-ddThh:mm:ssZ”。 其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。 正常响应样例 { "auditlogs": [{ "id": "fa163ea0e2bet11e9d832166a2cf894c5br01", "name": "2943db4292ee4d4abb1ae2df4870fedf_528f6b03c71c4d559ca4f60b6e20795fin01/39779175_20220825/Audit/317156_20190916032844_eb8fe5d181ec44a2850302691541f760in01_Audit_166a2cf8-d832-11e9-94c5-fa163ea0e2be", "size": 20481.835938, "begin_time": "2019-11-06T09:03:34+0800", "end_time": "2019-11-06T10:39:15+0800" }, { "id": "fa163ea0e2bet11e9d832136a668094c5br01", "name": "2943db4292ee4d4abb1ae2df4870fedf_528f6b03c71c4d559ca4f60b6e20795fin01/39779175_20220825/Audit/317162_20190916032838_eb8fe5d181ec44a2850302691541f760in01_Audit_136a6680-d832-11e9-94c5-fa163ea0e2be", "size": 20481.835938, "begin_time": "2019-11-07T09:04:35+0800", "end_time":"2019-11-07T10:38:16+0800" }], "total_record": 2 } 异常响应 请参见异常请求结果。

URI URI格式 GET /v3/{project_id}/instances/{instance_id}/auditlog?start_time={start_time}&end_time={end_time}&offset={offset}&limit={limit} 参数说明 表1 参数说明 名称 是否必选 说明 project_id 是 参数解释： 租户在某一Region下的项目ID。 获取方法请参见获取项目ID。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 instance_id 是 参数解释： 要查询的实例ID。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 start_time 是 参数解释： 查询开始时间。 约束限制： 不涉及。 取值范围： 格式为“yyyy-mm-ddThh:mm:ssZ”。 其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。 默认取值： 不涉及。 end_time 是 参数解释： 查询结束时间。 约束限制： 不涉及。 取值范围： 格式为“yyyy-mm-ddThh:mm:ssZ”，且大于查询开始时间，时间跨度不超过30天。 其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。 默认取值： 不涉及。 offset 是 参数解释： 索引位置，偏移量。从第一条数据偏移offset条数据后开始查询，值为0表示从第一条数据开始查询）。 约束限制： 必须为数字，不能为负数。 取值范围： 大于等于0的整数。 默认取值： 0 limit 是 参数解释： 查询记录数。 约束限制： 不涉及。 取值范围： [1, 50] 默认取值： 不涉及。

响应消息 正常响应要素说明 表2 要素说明 名称 参数类型 说明 keep_days Integer 审计日志保存天数，审计日志策略关闭时为0。 audit_types Array of strings 审计记录的实际操作类型，空表示不过滤任何操作类型。 all_audit_log_action String 审计记录的所有操作类型。 正常响应样例 { "keep_days":7, "audit_types":["CREATE_USER"], "all_audit_log_action": '{"DCL":"CREATE_USER,DROP_USER,RENAME_USER,GRANT,REVOKE,ALTER_USER,ALTER_USER_DEFAULT_ROLE","DDL":"CREATE,ALTER,DROP,RENAME,TRUNCATE,REPAIR,OPTIMIZE","DML":"INSERT,DELETE,UPDATE,REPLACE,SELECT","OTHER":"BEGIN/COMMIT/ROLLBACK,PREPARED_STATEMENT,CALL_PROCEDURE,KILL,SET_OPTION,CHANGE_DB,UNINSTALL_PLUGIN,UNINSTALL_PLUGIN,INSTALL_PLUGIN,SHUTDOWN,SLAVE_START,SLAVE_STOP,LOCK_TABLES,UNLOCK_TABLES,FLUSH,XA"}' } 异常响应 请参见异常请求结果。

请求消息 表2 参数说明 名称 是否必选 参数类型 说明 keep_days 是 Integer 审计日志保存天数，取值范围0~732。 取值0，表示关闭审计日志策略。 取值1~732，表示开启审计日志策略，并设置审计日志保存天数为该值。 reserve_auditlogs 否 Boolean 仅关闭审计日志策略时有效。 true（默认），表示关闭审计日志策略的同时，延迟删除已有的历史审计日志。 false，表示关闭审计日志策略的同时，删除已有的历史审计日志。 audit_types 否 Array of strings 该参数仅针对RDS for MySQL引擎。 审计日志的操作类型，仅打开审计日志策略时有效。参数值为空时，默认为全部操作类型。 CREATE_USER,DROP_USER,RENAME_USER,GRANT,REVOKE,ALTER_USER,ALTER_USER_DEFAULT_ROLE CREATE,ALTER,DROP,RENAME,TRUNCATE,REPAIR,OPTIMIZE INSERT,DELETE,UPDATE,REPLACE,SELECT BEGIN/COMMIT/ROLLBACK,PREPARED_STATEMENT,CALL_PROCEDURE,KILL,SET_OPTION,CHANGE_DB,UNINSTALL_PLUGIN,UNINSTALL_PLUGIN,INSTALL_PLUGIN,SHUTDOWN,SLAVE_START,SLAVE_STOP,LOCK_TABLES,UNLOCK_TABLES,FLUSH,XA