华为云用户手册

响应消息 正常响应要素说明 表2 要素说明 名称 参数类型 说明 slow_log_list Array of objects 参数解释： 具体信息。 详情请参见表3。 total_record Integer 参数解释： 总记录数。 取值范围： 不涉及。 表3 slow_log_list字段数据结构说明 名称 参数类型 说明 count String 参数解释： 执行次数。 取值范围： 不涉及。 time String 参数解释： 执行时间。 取值范围： 不涉及。 lock_time String 参数解释： 等待锁时间。 取值范围： 不涉及。 rows_sent String 参数解释： 结果行数量。 取值范围： 不涉及。 rows_examined String 参数解释： 扫描的行数量。 取值范围： 不涉及。 database String 参数解释： 所属数据库。 取值范围： 不涉及。 users String 参数解释： 账号。 取值范围： 不涉及。 query_sample String 参数解释： 执行语法。慢日志默认脱敏显示，如需明文显示，请联系客服人员添加白名单。 取值范围： 不涉及。 type String 参数解释： 语句类型。 取值范围： 不涉及。 start_time String 参数解释： 发生时间，UTC时间。 取值范围： 不涉及。 client_ip String 参数解释： IP地址。 取值范围： 不涉及。 正常响应样例 { "total_record": 1, "slow_log_list": [ { "count": "1", "time": "1.04899 s", "lock_time": "0.00003 s", "rows_sent": "0", "rows_examined": "0", "database": "mysql", "users": "root", "query_sample": "INSERT INTO time_zone_name (Name, Time_zone_id) VALUES (N, @time_zone_id);", "type": "INSERT", "start_time": "2018-08-06T10:41:14", "client_ip": "192.*.*.1" } ] } 异常响应 请参见异常请求结果。

URI URI格式 GET /v3.1/{project_id}/instances/{instance_id}/slowlog?start_date={start_date}&end_date={end_date} 参数说明 表1 参数说明 名称 是否必选 说明 project_id 是 参数解释： 租户在某一Region下的项目ID。 获取方法请参见获取项目ID。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 instance_id 是 参数解释： 要查询的实例ID。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 start_date 是 参数解释： 开始时间。 约束限制： 不涉及。 取值范围： 格式为“yyyy-mm-ddThh:mm:ssZ”。 其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。 默认取值： 不涉及。 end_date 是 参数解释： 结束时间。 约束限制： 只能查询当前时间前一个月内的慢日志。 取值范围： 格式为“yyyy-mm-ddThh:mm:ssZ”。 其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。 默认取值： 不涉及。 offset 否 参数解释： 索引位置，偏移量。从第一条数据偏移offset条数据后开始查询。 约束限制： 支持最多查询数据库最近的2000条慢日志信息。 取值范围： 必须为数字，不能为负数。参数值须满足offset + limit取值小于等于2000。示例：offset取值为1900，limit取值100。 默认取值： 默认为0。偏移0条数据，表示从第一条数据开始查询。 limit 否 参数解释： 每页多少条记录（查询结果）。 约束限制： 不涉及。 取值范围： 1~100 默认取值： 不填时默认为10。 type 否 参数解释： SQL语句类型。 约束限制： 不涉及。 取值范围： 取空值，表示查询所有语句类型，也可指定如下日志类型： INSERT UPDATE SELECT DELETE CREATE 默认取值： 不涉及。

URI URI格式 GET /v3/{project_id}/datastores/{database_name} 参数说明 表1 参数说明 名称 是否必选 说明 project_id 是 参数解释： 租户在某一Region下的项目ID。 获取方法请参见获取项目ID。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 database_name 是 参数解释： 数据库引擎。 约束限制： 不涉及。 取值范围： 支持的引擎如下，不区分大小写： MySQL PostgreSQL SQLServer 默认取值： 不涉及。

响应消息 正常响应要素说明 表2 要素说明 名称 参数类型 说明 dataStores Array of objects 参数解释： 数据库版本信息列表。 详情请参见表3。 表3 dataStores字段数据结构说明 名称 参数类型 说明 id String 参数解释： 数据库版本ID，该字段不会有重复。 取值范围： 不涉及。 name String 参数解释： 数据库版本号。 取值范围： 对于MySQL引擎可以返回小版本号，例如MySQL 5.6.51版本，将返回5.6.51。 对于PostgreSQL和SQL Server引擎，只返回两位数的大版本号，例如PostgreSQL 9.6.X版本，仅返回9.6。 正常响应样例 { "dataStores": [{ "id": "87620726-6802-46c0-9028-a8785e1f1921", "name": "8.0.21" }, { "id": "87620726-6802-46c0-9028-a8785e1f1922", "name": "5.7.33" }, { "id": "e8a8b8cc-63f8-4fb5-8d4a-24c502317a62", "name": "5.6.51" }] } 异常响应 请参见异常请求结果。

请求示例 POST https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/disaster-recovery-infos { "status": "normal", "order": "ASC", "sort_field": "time", "offset": 0, "limit": 10 }

响应消息 正常响应要素说明 表3 要素说明 名称 参数类型 说明 total_count Integer 总记录数。 instance_dr_infos Array of objects 容灾信息列表。 详情请参见表4。 表4 instance_dr_infos字段说明 名称 参数类型 说明 id String 容灾关系ID。 status String 容灾搭建状态。 failed_message String 失败消息。 replica_state String 同步状态。取值范围是0或-1，0表示正常，-1表示异常。 wal_write_receive_delay_in_mb String 发送延迟大小（MB），即主实例当前wal日志写入位点与灾备实例当前接收wal日志位点的差值。 wal_write_replay_delay_in_mb String 端到端延迟大小（MB），即主实例当前wal日志写入位点与灾备实例当前回放wal日志位点的差值。 wal_receive_replay_delay_in_ms String 回放延迟时间（ms），即数据在灾备上回放的延迟时间。 master_instance_id String 主实例ID。 master_region String 主实例所在Region。 slave_instance_id String 灾备实例ID。 slave_region String 灾备实例所在Region。 build_process String 搭建流程。 master，表示配置主实例容灾能力流程。 slave，表示配置灾备实例容灾能力流程。 time Long 灾备搭建时间。 正常响应样例 { "total_count": 1, "instance_dr_infos": [ { "id": "57160f82-e6bb-44bc-80db-0d950d4f3b40", "status": "failed", "failed_message": "the network is disconnected", "replica_state": "0", "wal_write_receive_delay_in_mb": "10.0", "wal_write_replay_delay_in_mb": "10.0", "wal_receive_replay_delay_in_ms": "0", "master_instance_id": "fab4e3df67c24aa0a5b41bc2bcb41918in03", "master_region": "region-A", "slave_instance_id": "df50adb922ef42a495943b304f8aa551in03", "slave_region": " region-B", "time": 1702551254685 } ] } 异常响应 请参见异常请求结果。

请求消息 表2 参数说明 名称 是否必选 参数类型 说明 id 否 String 容灾关系ID。 status 否 String 容灾搭建状态。 master_instance_id 否 String 主实例ID。 master_region 否 String 主实例Region。 slave_instance_id 否 String 灾备实例ID。 slave_region 否 String 灾备实例Region。 create_at_start 否 Long 创建起始时间。 create_at_end 否 Long 创建结束时间。 order 否 String 排序方式。 DESC，降序。 ASC，升序。 默认降序。 sort_field 否 String 排序字段。 status 容灾搭建状态。 time 容灾搭建时间。 master_region 主实例region。 slave_region 灾备实例region 默认容灾搭建时间。 offset 否 Integer 索引位置，偏移量。从第一条数据偏移offset条数据后开始查询，默认为0（偏移0条数据，表示从第一条数据开始查询），必须为数字，不能为负数。 limit 否 Integer 查询记录数。默认为10，不能为负数，最小值为1，最大值为100。

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

响应消息 正常响应要素说明 表2 要素说明 名称 参数类型 说明 node_id String 参数解释： 实例的节点ID。 取值范围： 不涉及。 used String 参数解释： 磁盘空间使用量（单位GB）。 取值范围： 不涉及。 正常响应样例 { "node_id" : "0314958daf6904c478d17c642ac209abbin01", "used" : "14.21" } 异常响应 请参见异常请求结果。

请求示例 修改MySQ L实例 的参数值。 PUT https://{endpoint}/v3.1/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in01/configurations { "values" : { "div_precision_increment": "6", "connect_timeout": "20", "binlog_checksum" : "CRC32", "innodb_purge_threads" : "4" } } 修改PostgreSQL实例的参数值。 { "values" : { "autovacuum" : "on", "bytea_output" : "escape", "client_encoding" : "UTF8", "cpu_tuple_cost" : "0.01" } } 修改SQL Server实例的参数值。 { "values":{ "max server memory (MB)":"26317", "max degree of parallelism":"4" } }

接口约束 支持的数据库引擎：MySQL、PostgreSQL、Microsoft SQL Server。 修改的参数必须在指定数据库版本的默认参数范围内，具体可配置范围请参见《云数据库RDS用户指南》中“修改RDS for MySQL实例参数”的内容。 敏感参数，例如：“lower_case_table_names”，修改存在风险，详情请参见《云数据库RDS用户指南》中“RDS for MySQL参数调优建议”的内容。

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

响应消息 正常响应要素说明 表3 要素说明 参数 参数类型 描述 job_id String 参数解释： 任务ID。 取值范围： 不涉及。 restart_required Boolean 参数解释： 实例是否需要重启。 取值范围： true：需要重启。 false：不需要重启。 正常响应样例 { "job_id" : "e7a7535b-eb9b-45ac-a83a-020dc5016d94", "restart_required" : false } 异常响应 请参见异常请求结果。

请求消息 表2 参数说明 名称 是否必选 参数类型 说明 resize_flavor 是 Object 请参见表3。 表3 resize_flavor字段数据结构说明 名称 是否必选 参数类型 说明 spec_code 是 String 资源规格编码。例如：rds.mysql.m1.xlarge。其中，rds代表RDS产品，mysql代表数据库引擎，m1.xlarge代表性能规格，为高内存类型。带"rr"的表示只读实例规格，反之表示单实例和HA实例规格。 is_auto_pay 否 Boolean 变更包周期实例的规格时可指定，表示是否自动从客户的账户中支付。 true，为自动支付。 false，为手动支付，默认该方式。 is_delay 否 Boolean 是否进行定时规格变更，该参数目前仅支持MySQL。 true，为定时变更，将在运维时间窗内进行变更操作。 false，为即时变更，默认该方式。

请求示例 变更MySQL数据库实例的规格为rds.mysql.m1.xlarge。 POST https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in01/action { "resize_flavor": { "spec_code": "rds.mysql.m1.xlarge", "is_auto_pay": true, "is_delay": true } } 变更PostgreSQL数据库实例的规格为rds.pg.c2.medium.ha。 { "resize_flavor": { "spec_code": "rds.pg.c2.medium.ha", "is_auto_pay": true } } 变更SQL Server数据库实例的规格为rds.mssql.2014.se.s3.large.2。 { "resize_flavor": { "spec_code": "rds.mssql.2014.se.s3.large.2", "is_auto_pay": true } }

响应消息 正常响应要素说明 表2 要素说明 名称 参数类型 说明 versions Object 参数解释： API版本详细信息列表。 详情请参见表3。 version Object 参数解释： API版本详细信息列表。 详情请参见表3。 表3 versions字段数据结构说明 名称 参数类型 说明 id String 参数解释： API版本号。 取值范围： 不涉及。 links Array 参数解释： 对应该API版本的链接信息，该字段为空。 详情请参见表4。 status String 参数解释： 版本状态。 取值范围： 不涉及。 updated String 参数解释： 版本更新时间。 取值范围： 格式为“yyyy-mm-dd Thh:mm:ssZ”。 其中，T指某个时间的开始；Z指UTC时间。 表4 links字段数据结构说明 名称 参数类型 说明 href String 参数解释： 对应该API的URL。 取值范围： 该字段为""。 rel String 参数解释： URL类型。 取值范围： 取值为“self”，表示href为本地链接。 正常响应样例 { "version": { "id": "v1", "links": [], "status": "DEPRECATED", "updated": "2017-02-07T17:34:02Z" }, "versions": { "id": "v1", "links": [], "status": "DEPRECATED", "updated": "2017-02-07T17:34:02Z" } } 异常响应 请参见异常请求结果。

响应消息 正常响应要素说明 表2 要素说明 名称 是否必选 参数类型 说明 binlog_retention_hours 是 Integer 二进制日志保留时间。 binlog_clear_type 否 String 二进制日志保留策略，取值：time、fast time：表示按时长保留二进制文件。 fast：表示快速清理，不保留二进制文件。 正常响应样例 { "binlog_retention_hours": 3, "binlog_clear_type": "time" } 异常响应 请参见异常请求结果。

响应消息 正常响应要素说明 表2 要素说明 名称 参数类型 说明 quotas Object 参数解释： 配额列表对象。 详情请参见表3。 表3 quotas字段数据结构说明 名称 参数类型 说明 resources Array of objects 参数解释： 资源列表对象。 详情请参见表4。 表4 resources字段数据结构说明 名称 参数类型 说明 quota Integer 参数解释： 项目资源配额。 取值范围： 不涉及。 used Integer 参数解释： 已使用的资源数量。 取值范围： 不涉及。 type String 参数解释： 项目资源类型。 取值范围： instance：实例类型资源。 正常响应样例 { "quotas" : { "resources" : [ { "quota" : 100, "used" : 1, "type" : "instance" } ] } } 异常响应 请参见异常请求结果。

响应消息 正常响应要素说明 表2 要素说明 名称 参数类型 说明 slow_log_list Array of objects 具体信息。 详情请参见表3。 total_record Integer 总记录数。 表3 slow_log_list字段数据结构说明 名称 参数类型 说明 count String 执行次数。 time String 执行时间。 lock_time String 等待锁时间。 rows_sent String 结果行数量。 rows_examined String 扫描的行数量。 database String 所属数据库。 users String 账号。 query_sample String 执行语法。慢日志默认脱敏显示，如需明文显示，请联系客服人员添加白名单。 type String 语句类型。 start_time String 发生时间，UTC时间。 client_ip String IP地址。 正常响应样例 { "total_record": 1, "slow_log_list": [ { "count": "1", "time": "1.04899 s", "lock_time": "0.00003 s", "rows_sent": "0", "rows_examined": "0", "database": "mysql", "users": "root", "query_sample": "INSERT INTO time_zone_name (Name, Time_zone_id) VALUES (N, @time_zone_id);", "type": "INSERT", "start_time": "2018-08-06T10:41:14", "client_ip": "192.*.*.1" } ] } 异常响应 请参见异常请求结果。

请求消息 请求参数 无。 URI样例 GET https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/cee5265e1e5845649e354841234567dfin01/slowlog?offset=1&limit=10&start_date=2018-08-06T10:41:14+0800&end_date=2018-08-07T10:41:14+0800&type=INSERT

URI URI格式 GET /v3/{project_id}/instances/{instance_id}/slowlog?start_date={start_date}&end_date={end_date} 参数说明 表1 参数说明 名称 是否必选 说明 project_id 是 租户在某一Region下的项目ID。 获取方法请参见获取项目ID。 instance_id 是 要查询的实例ID。 start_date 是 开始日期，格式为“yyyy-mm-ddThh:mm:ssZ”。 其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。 end_date 是 结束时间，格式为“yyyy-mm-ddThh:mm:ssZ”。 其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。只能查询当前时间前一个月内的慢日志。 offset 否 页偏移量，如1、2、3、4等，不填时默认为1，表示查询当前第一页的数据。 支持查询数据库最近的2000条慢日志信息，参数值须满足offset x limit取值小于等于2000。示例：offset取值为200，limit取值10。 limit 否 每页多少条记录，取值范围是1~100，不填时默认为10。 type 否 语句类型，取空值，表示查询所有语句类型，也可指定如下日志类型： INSERT UPDATE SELECT DELETE CREATE

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

URI URI格式 GET /v3/{project_id}/instances/{instance_id}/major-version/upgrade-histories?offset={offset}&limit={limit}&order={order}&sort_field={sort_field} 参数说明 表1 参数说明 名称 参数类型 是否必选 说明 project_id String 是 租户在某一Region下的项目ID。 获取方法请参见获取项目ID。 instance_id String 是 实例ID。 offset Integer 否 索引位置，偏移量。从第一条数据偏移offset条数据后开始查询，默认为0（偏移0条数据，表示从第一条数据开始查询），必须为数字，不能为负数。 limit Integer 否 查询记录数。默认为10，不能为负数，最小值为1，最大值为100。 order String 否 排序方式。 DESC：降序。 ASC：升序。 默认为降序。 sort_field String 否 排序字段。 start_time：开始时间。 end_time：结束时间。 默认为开始时间。

响应消息 正常响应要素说明 表2 参数说明 名称 参数类型 说明 total_count Integer 总记录数。 upgrade_reports Array of objects 升级报告信息。 详情请参见表3。 表3 upgrade_report字段数据结构说明 名称 参数类型 说明 id String 升级报告ID。 start_time String 升级开始时间，格式为“yyyy-mm-ddThh:mm:ssZ”。 其中，T指某个时间的开始；Z指时区偏移量，例如偏移1个小时显示为+0100。 end_time String 升级结束时间，格式为“yyyy-mm-ddThh:mm:ssZ”。 其中，T指某个时间的开始；Z指时区偏移量，例如偏移1个小时显示为+0100。 src_instance_id String 原实例ID。 src_database_version String 原数据库版本。 dst_instance_id String 目标实例ID。 dst_database_version String 目标数据库版本。 result String 升级结果。 success：表示成功。 failed：表示失败。 running：表示升级中。 is_private_ip_changed Boolean 是否将实例内网IP切换到目标大版本实例。 true：表示切换。 false：表示不切换。 private_ip_change_time String 实例内网IP修改时间，格式为“yyyy-mm-ddThh:mm:ssZ”。 其中，T指某个时间的开始；Z指时区偏移量，例如偏移1个小时显示为+0100。 statistics_collection_mode String 统计信息收集模式。 before_change_private_ip：修改实例内网IP前收集。 after_change_private_ip：修改实例内网IP后收集。 detail String 升级报告详情。 正常响应样例 { "total_count": 1, "upgrade_reports": [ { "id": "1a8fda5a-17a6-ebc4-bf1f-97ae837f432b", "start_time": "2023-03-06T02:45:49+0800", "end_time": "2023-03-06T02:50:49+0800", "src_instance_id": "dccacebb7b884ee18bc5c02c918ef2b0in03", "src_database_version": "13.9", "dst_instance_id": "6b5750504be1403191c4f00e4ffaee5ein03", "dst_database_version": "14.6", "result": "success", "is_private_ip_changed": true, "private_ip_change_time": "2023-03-06T03:10:49+0800", "statistics_collection_mode": "before_change_private_ip", "detail": "2023-03-06 18:33:26 --- pg_upgrade upgrade task begin" } ] } 异常响应 请参见异常请求结果。

响应消息 正常响应要素说明 表3 要素说明 名称 参数类型 说明 configuration_id String 参数模板ID。 configuration_name String 参数模板名称。 apply_results Array of objects 参数模板应用具体结果。 详情请参见表4。 success Boolean 参数模板是否都应用成功。 “true”表示参数模板都应用成功。 “false”表示存在应用失败的参数模板。 job_id String 任务流ID。 表4 apply_results字段数据结构说明 名称 参数类型 说明 instance_id String 实例ID。 instance_name String 实例名称。 restart_required Boolean 实例是否需要重启。 “true”需要重启。 “false”不需要重启。 success Boolean 参数模板是否应用成功。 “true”表示应用成功。 “false”表示应用失败。 正常响应样例 { "configuration_id": "cf49bbd7d2384878bc3808733c9e9d8bpr01", "configuration_name": "paramsGroup-bcf9", "job_id":"e4942c94-9d66-458e-beb7-90601664641e", "apply_results": [{ "instance_id": "fe5f5a07539c431181fc78220713aebein01", "instance_name": "zyy1", "restart_required": false, "success": false }, { "instance_id": "73ea2bf70c73497f89ee0ad4ee008aa2in01", "instance_name": "zyy2", "restart_required": false, "success": false }], "success": false } 异常响应 请参见异常请求结果。

请求样例 https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/configurations/463b4b58-d0e8-4e2b-9560-5dea4552fde9/apply { "instance_ids": ["73ea2bf70c73497f89ee0ad4ee008aa2in01", "fe5f5a07539c431181fc78220713aebein01"] }

URI URI格式 GET /v3/{project_id}/recycle-instances?offset={offset}&limit={limit} 参数说明 表1 参数说明 名称 是否必选 说明 project_id 是 参数解释： 租户在某一Region下的项目ID。 获取方法请参见获取项目ID。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 offset 是 参数解释： 索引位置，偏移量。从第一条数据偏移offset条数据后开始查询。 约束限制： 不涉及。 取值范围： 必须为数字，不能为负数。 默认取值： 不涉及。 limit 是 参数解释： 每页数据条数。 约束限制： 不涉及。 取值范围： [1, 50] 默认取值： 不涉及。

响应消息 正常响应要素说明 表2 要素说明 名称 参数类型 说明 total_count Integer 参数解释： 回收站数据条数。 取值范围： 不涉及。 instances Array of objects 参数解释： 回收站信息，详细说明请参见表3。 表3 instances字段数据结构说明 参数 参数类型 描述 id String 参数解释： 实例ID。 取值范围： 不涉及。 name String 参数解释： 实例名称。 取值范围： 不涉及。 ha_mode String 参数解释： 实例主备模式。 取值范围： 不区分大小写。 Single：单机实例。 Ha：主备实例。 engine_name String 参数解释： 引擎名称。 取值范围： 不涉及。 engine_version String 参数解释： 数据库引擎版本。 取值范围： 不涉及。 pay_model String 参数解释： 计费方式。 取值范围： 0：按需计费。 1：包周期计费。 created_at String 参数解释： 创建时间。 取值范围： 格式为“yyyy-mm-ddThh:mm:ssZ”。 其中，T指某个时间的开始；Z指时区偏移量，例如偏移1个小时显示为+0100。 deleted_at String 参数解释： 删除时间。 取值范围： 格式为“yyyy-mm-ddThh:mm:ssZ”。 其中，T指某个时间的开始；Z指时区偏移量，例如偏移1个小时显示为+0100。 volume_type String 参数解释： 磁盘类型。 取值范围： ULTRAHIGH，表示超高IO型磁盘。 ULTRAHIGHPRO，表示SSD尊享版，仅支持超高性能型尊享版（需申请权限）。 CLOUDSSD，表示SSD云盘，仅支持通用型和独享型规格实例。 LOCALSSD，表示本地SSD盘。 volume_size Integer 参数解释： 磁盘大小。 取值范围： 40 GB~4000 GB，必须为10的整数倍。 部分用户支持40 GB~6000 GB，如果您想创建存储空间最大为6000 GB的数据库实例，或提高扩容上限到10000 GB，请联系客服开通。 对于只读实例，该参数无效，只读实例磁盘大小默认和主实例相同。 data_vip String 参数解释： 内网地址。 取值范围： 不涉及。 data_vip_v6 String 参数解释： IPv6内网地址。 取值范围： 不涉及。 enterprise_project_id String 参数解释： 企业项目ID。 取值范围： 不涉及。 retained_until String 参数解释： 保留时间。 取值范围： 格式为“yyyy-mm-ddThh:mm:ssZ”。 其中，T指某个时间的开始；Z指时区偏移量，例如偏移1个小时显示为+0100。 recycle_backup_id String 参数解释： 备份ID。 取值范围： 不涉及。 recycle_status String 参数解释： 备份状态。 取值范围： BUILDING：备份中，不能进行重建。 COMPLETED：备份完成，可以重建实例。 is_serverless Boolean 参数解释： 实例类型。 取值范围： true：表示Serverless实例。 false：表示非Serverless实例。 正常响应样例 { "total_count" : 2, "instances" : [ { "id" : "b7dea08c0f0e4fed9f1951fff9013639in01", "name" : "rds-8b86", "ha_mode" : "Ha", "engine_name" : "mysql", "engine_version" : "5.7.38", "pay_model" : "0", "created_at" : "2022-12-26T03:38:10+0000", "deleted_at" : "2023-01-09T08:57:10+0000", "volume_type" : "SSD", "volume_size" : 80, "data_vip" : "192.168.226.188", "enterprise_project_id" : "0", "retained_until" : "2023-01-16T09:20:48+0000", "recycle_backup_id" : "e8e3c329c20442f5aec21b95a8cdaa52br01", "recycle_status" : "COMPLETED", "is_serverless" : false }, { "id" : "cc6d0dff4a9145d0a1335c35a866de23in01", "name" : "rds-82b2", "ha_mode" : "Ha", "engine_name" : "mysql", "engine_version" : "5.7.38", "pay_model" : "0", "created_at" : "2022-12-26T06:17:58+0000", "deleted_at" : "2023-01-09T08:56:49+0000", "volume_type" : "SSD", "volume_size" : 200, "data_vip" : "192.168.2.24", "enterprise_project_id" : "0", "retained_until" : "2023-01-16T09:20:45+0000", "recycle_backup_id" : "3f35a348ae0943979bd302a9788f49e7br01", "recycle_status" : "COMPLETED", "is_serverless" : false } ] } 异常响应 请参见异常请求结果。

响应示例 { "resCode": "0", "resMsg": "成功", "result": { "methodName": "run", "methodObject": "Calculator", "label": "", "description": "do a operation", "script": "命名空间__editEquipment", "types": { "Input": [ { "name": "op", "label": "", "description": "the operation type", "isCollection": false, "required": true, "pattern": "", "message": "", "valueType": "String", "structType": "", "lengthInCharacter": false, "min": null, "max": null }, { "name": "value1", "label": "", "description": "the operation value 1", "isCollection": false, "required": true, "pattern": "", "message": "", "valueType": "Number", "structType": "", "lengthInCharacter": false, "min": null, "max": null }, { "name": "value2", "label": "", "description": "the operation value 2", "isCollection": false, "required": true, "pattern": "", "message": "", "valueType": "Number", "structType": "", "lengthInCharacter": false, "min": null, "max": null } ], "Output": [ { "name": "result", "label": "", "description": "", "isCollection": false, "required": true, "pattern": "", "message": "", "valueType": "Number", "structType": "", "lengthInCharacter": false, "min": null, "max": null } ] }, "inputs": [ { "name": "op", "label": "", "description": "the operation type", "isCollection": false, "required": true, "pattern": "", "message": "", "valueType": "String" }, { "name": "value1", "label": "", "description": "the operation value 1", "isCollection": false, "required": true, "pattern": "", "message": "", "valueType": "Number" }, { "name": "value2", "label": "", "description": "the operation value 2", "isCollection": false, "required": true, "pattern": "", "message": "", "valueType": "Number" } ], "input": "Input", "outputs": [ { "name": "result", "label": "", "description": "", "isCollection": false, "required": true, "pattern": "", "message": "", "valueType": "Number" } ], "output": "Output" } }

响应参数 表2 响应参数 参数 参数类型 描述 resCode String 参数解释： 返回码。 取值范围： 如果返回“0”代表请求成功，其他错误码说明请参考错误码。 resMsg String 参数解释： 返回消息。 取值范围： 成功返回“成功”，其他情况会返回具体的错误信息。 result result object 参数解释： 在成功请求时，会有内容返回。 表3 result参数说明 参数 参数类型 描述 description String 参数解释： 脚本的描述信息。 取值范围： 不涉及。 script String 参数解释： 脚本的名称。 取值范围： 不涉及。 methodName String 参数解释： 方法名称，在脚本使用@action.method注解后才会有方法名。 取值范围： 不涉及。 methodObject String 参数解释： 方法所属的类。 取值范围： 不涉及。 input String 参数解释： 输入类型，一般为Input。在定义脚本出入参时，会定义一个入参类和出参类，这里input即为入参类名。 取值范围： 不涉及。 output String 参数解释： 输出类型，一般为Output。在定义脚本出入参时，会定义一个入参类和出参类，这里output即为出参类名。 取值范围： 不涉及。 label String 参数解释： 脚本的标签。 取值范围： 不涉及。 inputs Array of inputs objects 参数解释： 输入类型中的变量信息描述。 outputs Array of inputs objects 参数解释： 输出类型中的变量信息描述。 types Object 参数解释： 脚本中使用@action.param注解的类名。