华为云用户手册

响应消息 正常响应要素说明 表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 } 异常响应 请参见异常请求结果。

请求示例 MySQL请求示例 https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in01/configurations { "values" : { "max_connections" : "10", "autocommit" : "OFF", "binlog_checksum" : "CRC32", "innodb_purge_threads" : "4" } } PostgreSQL请求示例 { "values" : { "max_connections" : "10", "autovacuum" : "on", "bytea_output" : "escape", "client_encoding" : "UTF8", "cpu_tuple_cost" : "0.01" } }

响应消息 正常响应要素说明 表3 要素说明 名称 参数类型 说明 job_id String 任务ID。 restart_required Boolean 实例是否需要重启。 “true”需要重启。 “false”不需要重启。 ignored_params List 请求参数“values”中被忽略掉，没有生效的参数名称列表。 当参数不存在时，参数修改不会下发，并通过此参数返回所有被忽略的参数名称。 正常响应样例 { "job_id" : "e7a7535b-eb9b-45ac-a83a-020dc5016d94", "restart_required" : "false", "ignored_params": [] } 异常响应 请参见异常请求结果。

响应消息 正常响应要素说明 表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

修订记录 发布日期 更新特性 2024-03-28 第七十八次正式发布。包含以下修改点： 新增批量停止实例。 2024-03-11 第七十七次正式发布。包含以下修改点： 新增新增SQL限流。 新增删除SQL限流。 新增修改SQL限流。 新增查询SQL限流列表。 新增开启/关闭/禁用所有SQL限流。 2024-03-05 第七十六次正式发布。包含以下修改点： 新增开启数据库代理。 新增查询数据库代理信息列表。 新增查询数据库代理规格信息。 新增设置读写分离路由模式。 新增关闭数据库代理。 新增停止创建备份（PostgreSQL）。 新增修改数据库owner。 新增授予用户角色。 新增撤回用户角色。 新增查询数据库角色信息。 新增更新插件。 2024-01-26 第七十五次正式发布。包含以下修改点： 查询数据库规格增加“is_serverless”参数。 创建数据库实例增加“serverless_info”参数。 查询数据库实例列表增加“serverless_info”参数。 恢复到新实例增加“serverless_info”参数。 查询回收站实例信息增加“is_serverless”参数。 2023-12-27 第七十四次正式发布。包含以下修改点： 新增收缩数据库日志。 说明： 以上接口用于替换原收缩数据库日志接口，原接口文档已迁移至“历史API”章节，具体请参考收缩数据库日志（不推荐使用）。 2023-12-06 第七十三次正式发布。包含以下修改点： 新增查询指定时间点可恢复的库（MySQL）。 新增库级时间点恢复（MySQL）。 2023-11-30 第七十二次正式发布。包含以下修改点： 新增收缩数据库日志（不推荐使用）。 新增设置数据库账号密码。 2023-11-27 第七十一次正式发布。包含以下修改点： 新增开启实例TDE（SQL Server）。 新增查询实例TDE状态（SQL Server）。 新增查询实例可升级的目标版本（PostgreSQL）。 新增大版本升级检查（PostgreSQL）。 新增查询大版本检查状态或升级状态（PostgreSQL）。 新增查询实例大版本升级检查历史（PostgreSQL）。 新增大版本升级（PostgreSQL）。 新增查询实例大版本升级历史（PostgreSQL）。 2023-11-15 第七十次正式发布。包含以下修改点： 新增获取诊断后的实例数。 新增获取指定诊断项的诊断结果。 2023-11-06 第六十九次正式发布。包含以下修改点： 新增查询实例的pg_hba.conf文件配置。 新增修改pg_hba.conf文件的单个或多个配置。 新增覆盖当前pg_hba.conf文件的配置。 新增删除pg_hba.conf文件的单个或多个配置。 新增查询实例的pg_hba.conf文件修改历史。 2023-09-15 第六十八次正式发布。包含以下修改点： 新增表级时间点恢复（MySQL）。 新增升级内核小版本。 说明： 以上接口用于替换原表级时间点恢复、升级内核小版本接口，原接口文档已迁移至“历史API”章节，具体请参考表级时间点恢复（MySQL）和升级内核小版本。 2023-07-24 第六十七次正式发布。包含以下修改点： 表级时间点恢复（MySQL）增加“is_fast_restore”参数。 新增查询实例是否能在库表恢复时使用极速恢复（MySQL）。 2023-06-01 第六十六次正式发布。包含以下修改点： 新增修改指定实例的数据库备注。 新增修改数据库用户的备注。 新增删除数据库。 新增删除数据库用户。 2023-05-25 第六十五次正式发布。包含以下修改点： 新增获取SSL证书下载地址。 查询数据库列表增加“recover_model”参数。 2023-04-10 第六十四次正式发布。包含以下修改点： 新增授权数据库账号的操作权限。 2023-03-17 第六十三次正式发布。包含以下修改点： 新增查询回收站策略。 新增查询回收站实例信息。 2023-02-24 第六十二次正式发布。包含以下修改点： 创建RDS for MySQL实例支持请求幂等性。 新增请求幂等性说明。 2023-02-22 第六十一次正式发布。包含以下修改点： 新增查询慢日志。 新增查询错误日志。 新增查询慢日志统计信息。 说明： 以上接口用于替换原查询慢日志、查询错误日志、获取慢日志统计信息接口，原接口文档已迁移至“历史API”章节，具体请参考查询数据库错误日志（MySQL）、查询数据库慢日志（MySQL）、查询数据库错误日志和获取慢日志统计信息（MySQL）。 2023-02-08 第六十次正式发布。包含以下修改点： 新增查询实例域名。 新增查询实例IPv6域名。 新增获取实例的复制状态。 2022-12-19 第五十九次正式发布。包含以下修改点： 新增创建插件。 新增查询插件。 新增删除插件。 新增修改实例指定参数的值。 新增获取实例指定参数的值。 2022-12-14 第五十八次正式发布。包含以下修改点： 新增批量查询容灾实例信息。 创建数据库请求消息增加“is_revoke_public_privilege”字段。 新增错误码DBS.200038、DBS.200039。 2022-12-09 第五十七次正式发布。包含以下修改点： 新增设置自动扩容策略。 新增查询自动扩容策略。 新增设置秒级监控策略。 新增查询秒级监控策略。 2022-12-05 第五十六次正式发布。包含以下修改点： 新增复制参数模板。 新增查询实例参数修改历史。 新增添加MSDTC。 新增查询MSDTC的hosts信息。 2022-09-21 第五十五次正式发布。包含以下修改点： 手动倒换主备请求消息增加“force”字段。 创建数据库用户请求消息增加“comment”字段。 查询数据库用户列表响应消息增加“comment”字段。 新增修改数据库用户的备注。 2022-07-30 第五十四次正式发布。包含以下修改点： 支持RDS for PostgreSQL 14版本。 修改创建数据库实例和恢复到新实例接口中请求参数“security_group_id”的说明。 2022-06-30 第五十三次正式发布。包含以下修改点： 新增开启和关闭慢日志明文显示。 2022-04-15 第五十二次正式发布。包含以下修改点： 新增应用参数模板（v3.1版本）。 新增修改指定实例的参数（v3.1版本）。 新增删除数据库（SQL Server）（v3.1版本）。 说明： 以上接口用于替换原v3版本接口，其中v3版本接口文档均迁移至“历史API”章节，具体请参考应用参数模板、修改指定实例的参数和删除数据库（SQL Server）。 2022-03-31 第五十一次正式发布。包含以下修改点： 新增停止实例。 新增开启实例。 原有应用参数模板接口待下线，新增应用参数模板。 新增错误码DBS.301132。 2022-01-28 第五十次正式发布。包含以下修改点： 恢复到已有实例接口待下线。 SQLServer支持低版本到高版本的跨版本恢复能力：恢复到新实例、恢复到已有实例。 SQL Server实例名支持中文：创建数据库实例、修改实例名称、恢复到新实例。 单机转主备实例请求参数增加“ad_domain_info”，删除“password”。 迁移主备实例的备机添加支持本地盘实例的描述。 2021-11-30 第四十九次正式发布。包含以下修改点： MySQL原有查询错误日志和慢日志接口待下线，新增如下接口： MySQL新增查询数据库错误日志（MySQL）。 MySQL新增查询数据库慢日志（MySQL）。 MySQL新增升级内核小版本。 2021-11-04 第四十八次正式发布。包含以下修改点： 查询数据库实例列表响应消息增加“max_iops”和“expiration_time”字段。 2021-08-25 第四十七次正式发布。包含以下修改点： 创建数据库请求消息增加“comment”字段。 查询数据库列表响应消息增加“comment”字段。 授权数据库账号请求消息增加“readonly”字段。 新增接口修改指定实例的数据库备注。 2021-07-21 第四十六次正式发布。包含以下修改点： PostgreSQL支持极速云盘。 PostgreSQL支持查询数据库代理可变更的规格（v3）。 MySQL支持修改实例备注。 查询数据库实例列表增加响应参数“alias”。 2021-06-22 第四十五次正式发布。包含以下修改点： PostgreSQL数据库实例名支持中文字符。 MySQL支持设置Binlog本地保留时长。 MySQL支持获取Binlog本地保留时长。 MySQL数据库账号密码支持()和&。 新增查询配额。 新增错误码DBS.200311、DBS.280020、DBS.200037。 优化错误码DBS.200121。 删除数据库（SQL Server）增加请求参数“is_force_delete”，支持强制删除数据库。 查询数据库实例列表增加响应参数“complete_version”，PostgreSQL支持返回完整版本号。 RDS授权分类增加查询配额、设置Binlog本地保留时长和获取Binlog本地保留时长。 API概览增加配额管理接口说明。 2021-05-18 第四十四次正式发布。包含以下修改点： 查询数据库规格的响应参数“groupType”支持极速型SSD。 查询数据库磁盘类型的响应参数“supportComputeGroupType”支持极速型SSD。 创建数据库实例的请求参数“volume”支持极速型SSD。 恢复到新实例的请求参数和响应参数“volume”支持极速型SSD。 PostgreSQL支持设置跨区域备份策略。 PostgreSQL支持查询跨区域备份策略。 PostgreSQL支持查询跨区域备份列表。 PostgreSQL支持查询跨区域备份实例列表。 PostgreSQL支持查询跨区域备份可恢复时间段。 PostgreSQL支持同云跨Region配置主实例容灾能力。 PostgreSQL支持同云跨Region配置灾备实例容灾能力。 PostgreSQL支持同云跨Region灾备实例升主。 PostgreSQL支持同云跨Region查询容灾复制状态。 2021-05-06 第四十三次正式发布。包含以下修改点： 根据API规范优化错误码。 2021-04-19 第四十二次正式发布。包含以下修改点： 支持PostgreSQL 13。 查询数据库规格的响应参数“groupType”支持通用型和独享型。 查询数据库磁盘类型的响应参数“supportComputeGroupType”支持SSD云盘。 创建数据库实例的请求参数“volume”支持SSD云盘。 PostgreSQL支持迁移主备实例的备机。 2021-03-22 第四十一次正式发布。包含以下修改点： SQL Server恢复到已有实例和新实例时，数据库名支持多个。 2021-02-22 第四十次正式发布。包含以下修改点： 原“重置数据库密码”章节名称修改为“重置数据库root账号密码”，并移动至管理数据库和用户（MySQL）目录下。 SQL Server支持设置跨区域备份策略。 SQL Server支持查询跨区域备份策略。 SQL Server支持查询跨区域备份列表。 SQL Server支持查询跨区域备份实例列表。 SQL Server支持查询跨区域备份可恢复时间段。 MySQL数据库实例名支持中文字符。 MySQL数据库管理员密码支持$字符。 MySQL和PostgreSQL设置可维护时间段的时间间隔支持一至四个小时。 MySQL、PostgreSQL和SQL Server的包周期实例支持单机转主备实例。 MySQL创建数据库实例时支持批量创建，增加请求参数“count”。 MySQL创建数据库实例时支持参数和规格的预校验，增加请求参数“dry_run”。 查询数据库规格响应参数新增“groupType”。 查询数据库磁盘类型响应参数新增“supportComputeGroupType”。 2021-01-18 第三十九次正式发布。包含以下修改点： 新增V3接口申请内网域名。 新增V3接口修改内网域名。 新增V3接口查询容灾复制状态。 新增V3接口设置跨区域备份策略。 新增V3接口查询跨区域备份策略。 新增V3接口查询跨区域备份列表。 新增V3接口查询跨区域备份实例列表。 新增V3接口查询跨区域备份可恢复时间段。 V3接口创建数据库实例请求参数和响应参数新增“collation”，。 SQL Server创建实例时请求参数“password”支持$字符。 V3接口恢复到新实例请求参数和响应参数新增“collation”和“charge_info”。 PostgreSQL和SQL Server的包周期实例支持变更规格和扩容磁盘空间。 2020-12-15 第三十八次正式发布。包含以下修改点： 新增V3接口修改实例名称。 新增V3接口设置回收站策略。 新增V3接口查询数据库列表。 新增V3接口查询数据库用户列表。 新增V3接口查询数据库SCHEMA列表。 V3接口查询数据库磁盘类型新增参数“ha_mode”。 V3接口创建数据库请求参数新增“template”、“character_set”、“lc_collate”。 V3接口查询数据库实例列表和获取备份列表响应参数新增“associated_with_ddm”。 2020-11-16 第三十七次正式发布。包含以下修改点： V3接口创建数据库实例的请求参数新增“data_vip”字段。 新增错误码DBS.280489和DBS.280490。 新增V3接口创建数据库。 新增V3接口创建数据库用户。 新增V3接口创建数据库SCHEMA。 新增V3接口授权数据库账号的读写权限。 2020-10-15 第三十六次正式发布。包含以下修改点： 新增V3接口查询数据库用户列表。 新增V3接口查询指定数据库的已授权用户。 新增V3接口配置主实例容灾能力。 新增V3接口配置灾备实例容灾能力。 新增V3接口灾备实例升主。 包周期支持变更规格。 2020-09-15 第三十五次正式发布。包含以下修改点： 新增V3接口创建数据库用户。 新增V3接口删除数据库用户。 新增V3接口授权数据库账号。 新增V3接口解除数据库账号权限。 新增V3接口重置数据库账号密码。 V3接口查询数据库实例列表的响应消息新增“order_id”字段。 V3接口创建数据库实例的请求参数新增“tags”字段。 2020-08-15 第三十四次正式发布。包含以下修改点： 新增v3接口获取指定实例和时间范围的任务信息（SQL Server）。 2020-07-17 第三十三次正式发布。包含以下修改点： 新增v3接口创建数据库。 新增v3接口查询数据库列表。 新增v3接口删除数据库（SQL Server）。 2020-05-30 第三十二次正式发布。包含以下修改点： 新增v3接口设置可维护时间段。 新增v3接口修改安全组。 新增v3接口获取慢日志下载链接。 2020-05-13 第三十一次正式发布。包含以下修改点： 新增v3接口设置SSL 数据加密 。 新增v3接口修改数据库端口。 新增v3接口修改内网地址。 2020-03-31 第三十次正式发布。包含以下修改点： v1 接口资料下线。 新增接口：切换主备实例的倒换策略。 新增接口：手动倒换主备。 新增接口：更改主备实例的数据同步方式。 新增接口：迁移主备实例的备机。 新增接口：表级时间点恢复（MySQL）。 新增接口：获取慢日志统计信息（MySQL）。 2020-03-06 第二十九次正式发布。包含以下修改点： 新增接口绑定和解绑弹性公网IP。 新增接口重置数据库root账号密码。 2019-12-30 第二十八次正式发布。包含以下修改点： DeC用户支持查询数据库规格、查询数据库磁盘类型、创建数据库实例、单机转主备实例。 2019-12-16 第二十七次正式发布。包含以下修改点： 在接口“查询数据库实例列表”响应中新增“backup_used_space”和“storage_used_space”字段。 新增接口查询SQL Server可用字符集。 2019-11-30 第二十六次正式发布。包含以下修改点： 在接口查询数据库实例列表请求中，新增tag查询条件。 新增接口批量添加标签。 新增接口批量删除标签。 新增接口查询项目标签。 2019-10-15 第二十五次正式发布。包含以下修改点： 新增接口设置审计日志策略。 新增接口查询审计日志策略。 新增接口获取审计日志列表。 新增接口生成审计日志下载链接。 2019-09-20 第二十四次正式发布。包含以下修改点： 在接口查询数据库规格响应消息中，新增“az_status”字段。 新增查询数据库磁盘类型接口。 2019-08-31 第二十三次正式发布。包含以下修改点： 完善v3接口的URI格式，增加URI样例。 在“使用前必读”中，增加“调用说明”、“终端节点”、“约束限制”、“API版本选择建议”等主要章节。 在“如何调用API”中，增加“构造请求”、“认证鉴权”和“返回结果”章节。 修改“模板”为“参数模板”。 对于白名单用户，创建MySQL主实例和只读实例，可选最大存储空间调整为6000GB，可扩容最大存储容量为10000GB。 2019-07-03 第二十二次正式发布。包含以下修改点： 在接口查询可恢复时间段中新增date字段。 2019-06-10 第二十一次正式发布。包含以下修改点： 新增权限和授权项章节。 2019-05-06 第二十次正式发布。包含以下修改点： 在修改MySQL参数相关场景中，增加修改敏感参数的注意事项。 2019-03-30 第十九次正式发布。包含以下修改点： 公共请求消息头中“X-Language”参数由必选修改为非必选。 创建数据库实例和恢复到新实例增加入参UTC时区“time_zone”。 创建只读实例磁盘大小“size”无效， 默认和主实例相同。 对于SQL Server实例，恢复到新实例和恢复到已有实例新增“database_name”字段，即：支持局部恢复和重命名恢复。 获取任务信息中新增实例磁盘空间满的状态“STORAGE FULL”。 2019-02-15 第十八次正式发布。包含以下修改点： 新增v3接口变更数据库实例的规格。 新增v3接口扩容数据库实例的磁盘空间。 新增v3接口单机转主备实例。 2018-12-30 第十七次正式发布。包含以下修改点： 新增v3接口查询数据库引擎的版本。 新增v3接口查询数据库规格。 新增v3接口创建数据库。 新增v3接口查询数据库（已废弃）。 新增v3接口删除数据库。 新增v3接口创建数据库用户。 新增v3接口查询数据库用户（已废弃）。 新增v3接口删除数据库用户。 新增v3接口授权数据库账号。 新增v3接口解除数据库账号权限。 2018-12-26 第十六次正式发布。包含以下修改点： 新增v3接口重启数据库实例。 新增v3接口查询数据库错误日志。 将v1和v3接口按章节进行分类。 2018-11-20 第十五次正式发布。包含以下修改点： 新增v3接口获取参数模板列表。 新增v3接口获取指定实例的参数模板。 新增v3接口获取指定参数模板的参数。 新增v3接口创建参数模板。 新增v3接口应用参数模板 新增v3接口修改参数模板参数。 新增v3接口修改指定实例的参数。 新增v3接口删除参数模板。 新增v3接口查询可恢复时间段。 修改恢复到新实例。 修改恢复到已有实例。 修改创建数据库实例。 新增AK/SK鉴权方式。 新增错误码：DBS.200203、DBS.200506和DBS.212032。 2018-09-30 第十四次正式发布。包含以下修改点： 新增v3接口创建数据库实例。 新增v3接口删除数据库实例。 新增v3接口查询数据库实例列表。 新增v3接口获取任务信息。 新增v3接口设置自动备份策略。 新增v3接口查询自动备份策略。 新增v3接口创建手动备份。 新增v3接口创建手动备份。 新增v3接口获取备份列表。 新增v3接口删除手动备份。 新增v3接口恢复到新实例。 新增v3接口恢复到已有实例。 新增v3错误码。 新增v3异常请求结果。 2018-08-03 第十三次正式发布。包含以下修改点： SQLServer局部备份和局部备份下载支持openapi。 2018-07-16 第十二次正式发布。包含以下修改点： Microsoft SQL Server引擎支持恢复到当前实例。 2018-06-15 第十一次正式发布。包含以下修改点： 修改参数“keepDays”的取值范围。 修改参数“keepday”的取值范围。 2018-06-07 第十次正式发布。包含以下修改点： 新增概述。 新增API概览。 新增如何调用API。 将原“附录章节”中内容调整至附录。 2018-05-15 第九次正式发布。包含以下修改点： Microsoft SQL Server引擎支持2016版本。 2018-04-13 第八次正式发布。包含以下修改点： Microsoft SQL Server引擎支持2014 SP2 EE版本。 2018-03-20 第七次正式发布。包含以下修改点： 修改备份开始时间的参数描述。 2017-12-01 第六次正式发布。包含以下修改点： 修改参数“replicationMode”的说明。 2017-11-08 第五次正式发布。包含以下修改点： 修改错误码，新增错误码RDS.0056。 2017-08-18 第四次正式发布。包含以下修改点： 创建实例接口新增参数“dbPort”，修改请求及响应样例。 2017-05-06 第三次正式发布。 对Open APIs进行归类。 支持数据库引擎PostgreSQL与Microsoft SQL Server。 2017-03-03 第二次发正式布。包含以下修改点： 新增云数据库RDS监控指标说明。 2016-10-29 第一次正式发布。

响应消息 正常响应要素说明 表2 字段说明 名称 参数类型 说明 pageNumber Integer 当前页码。 pageRecord Integer 每页条数。 slowLogList List 请参见表3。 totalRecord Integer 总条数。 startTime Long 开始时间。 endTime Long 结束时间。 表3 slowLogList字段数据结构说明 名称 参数类型 说明 count String 执行次数。 time String 执行时间。 lockTime String 等待锁时间。 rowsSent Long 结果行数量。 rowsExamined Long 扫描的行数量。 database String 所属数据库。 users String 账号。 querySample String 执行语法。 type String 语句类型。 clientIP String IP地址。 正常响应样例 { "pageNumber": 1, "pageRecord": 10, "slowLogList": [], "totalRecord": 0, "startTime": null, "endTime":null } 异常响应 请参见异常请求结果。

URI URI格式 GET /v3/{project_id}/instances/{instance_id}/slowlog/statistics?cur_page={cur_page}&per_page={per_page}&type={type}&start_date={start_date}&end_date={end_date}&sort={sort} 参数说明 表1 参数说明 名称 是否必选 说明 project_id 是 租户在某一Region下的项目ID。 获取方法请参见获取项目ID。 instance_id 是 要查询的实例ID。 cur_page 是 页偏移量，即当前页码，如1、2、3、4等。 per_page 是 每页多少条记录，取值范围是0~100。 start_date 是 开始日期，格式为“yyyy-mm-ddThh:mm:ssZ”。 其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。 end_date 是 结束时间，格式为“yyyy-mm-ddThh:mm:ssZ”。 其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。 type 是 语句类型，取空值，表示查询所有语句类型，也可指定如下日志类型： INSERT UPDATE SELECT DELETE CREATE ALL sort 否 指定排序字段。 "executeTime"，表示按照执行时间降序排序。 字段为空或传入其他值，表示按照执行次数降序排序。

请求消息 请求参数 无。 URI样例 GET https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/cee5265e1e5845649e354841234567dfin01/slowlog/statistics?cur_page=1&per_page=2&type=INSERT&start_date=2020-02-06T10:41:14+0800&end_date=2020-02-07T10:41:14+0800&sort=executeTime

响应消息 正常响应要素说明 表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}/instances/{instance_id}/errorlog?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。 limit 否 每页多少条记录，取值范围是1~100，不填时默认为10。 level 否 日志级别，默认为ALL，可取值如下： ALL INFO LOG WARNING ERROR FATAL PANIC NOTE

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

响应消息 正常响应要素说明 表2 要素说明 名称 参数类型 说明 error_log_list Array of objects 具体信息。 详情请参见表3 errorLogList字段数据结构说明。 total_record Integer 总记录数。 表3 error_log_list字段数据结构说明 名称 参数类型 说明 time String 日期时间UTC时间。 level String 日志级别。 content String 错误日志内容。 正常响应样例 { "error_log_list": [{ "time": "2018-12-04T14:24:42", "level": "WARNING", "content": "Occur error when reading bytes from a network handler. Client actively closes the connection." }, { "time": "2018-12-04T14:24:42", "level": "WARNING", "content": "Occur error when reading bytes from a network handler. Client actively closes the connection." }], "total_record": 2 } 异常响应 请参见异常请求结果。

响应消息 正常响应要素说明 表1 要素说明 名称 参数类型 说明 versions Array of objects API版本详细信息列表。 详情请参见表2。 表2 versions字段数据结构说明 名称 参数类型 说明 id String API版本号。 各个版本号，对应如下： v1：API v1版本。 v3：API v3版本。 links Array of objects 对应API的链接信息，v1、v3版本该字段为空。 详情请参见表3。 status String 版本状态。 取值“CURRENT”，表示该版本为主推版本。 取值“DEPRECATED”，表示为废弃版本，存在后续删除的可能。 updated String 版本更新时间，格式为“yyyy-mm-dd Thh:mm:ssZ”。 其中，T指某个时间的开始；Z指UTC时间。 表3 links字段数据结构说明 名称 参数类型 说明 href String 对应该API的URL，该字段为""。 rel String 取值为“self”，表示href为本地链接。 正常响应样例 { "versions": [{ "id": "v3", "links": [], "status": "CURRENT", "updated": "2019-01-15T12:00:00Z" }, { "id": "v1", "links": [], "status": "DEPRECATED", "updated": "2017-02-07T17:34:02Z" } ] } 异常响应 请参见异常请求结果。

请求示例 恢复表数据到指定时间点。 POST https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in01/restore/tables { "restoreTime": 1583720991838, "restoreTables": [ { "database": "restoretest", "tables": [ { "oldName": "test", "newName": "test_1583720991838" } ] } ], "is_fast_restore" : false }

请求消息 表2 参数说明 名称 是否必选 参数类型 说明 restoreTime 是 Long 备份时间点。 restoreTables 是 Array of objects 数据库信息，详细说明请参见表3。 is_fast_restore 否 Boolean 是否使用极速恢复。取值：true、false。 配置该参数时，参考查询实例是否能在库表恢复时使用极速恢复（MySQL）接口判断本次恢复是否能使用极速恢复。能使用极速恢复时，如果实例存在XA事务，会导致数据丢失，请选择普通恢复，即设置参数值为“false”。 不传该参数时，将根据查询实例是否能在库表恢复时使用极速恢复（MySQL）的查询结果，默认是否使用极速恢复。如果支持极速恢复功能，并且实例存在XA事务，请选择普通恢复，即传参并设置参数值为“false”。 表3 restoreTables字段数据结构说明 名称 是否必选 参数类型 说明 database 是 String 数据库名称。 tables 是 Array of objects 表信息，详细说明请参见表4。 表4 tables字段数据结构说明 名称 是否必选 参数类型 说明 oldName 是 String 恢复前表名。 newName 是 String 恢复后表名。

功能介绍 为了保证数据完整性，降低对原实例的性能影响，在进行表级时间点恢复备份时，首先将选中时间点的全量数据和增量数据在后台恢复至一个临时实例，然后自动导出用户需要恢复的表，再将这些表恢复至原实例。 该接口计划于2025-09-14下线，建议及时切换到新接口表级时间点恢复（MySQL）。 该操作会在原实例上新生成恢复后的库表，请确保您的原实例磁盘空间充足。 调用接口前，您需要了解API 认证鉴权。

URI PUT /v2/{project_id}/workflows/{workflow_id}/executions/{execution_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 用户项目ID。获取方法请参见获取项目ID和名称。 workflow_id 是 String 工作流的ID execution_id 是 String 工作流执行ID

响应示例 状态码： 200 OK { "created_at" : "2022-06-16T23:12:48.458022+08:00", "name" : "execution-056", "execution_id" : "fa412c98-6d94-42a2-891a-99cd1da93916", "description" : "", "status" : "stopped", "workspace_id" : "0", "workflow_id" : "f1642618-43eb-4ab1-a0b1-9cc584182c60", "workflow_name" : "workflow_model_service_no_modify_xiahou_copy", "steps_execution" : [ { "created_at" : "2022-06-16T23:12:48.466906+08:00", "uuid" : "5e8456bd-35ff-4cc9-9624-935c37dabe47", "instance_id" : "{\"model_id\":\"7d795a48-e646-43b0-b4cb-759454acaf2b\"}", "step_name" : "model_step", "step_title" : "model release", "status" : "completed", "duration" : 17, "inputs" : [ { "name" : "model_input", "type" : "obs", "data" : "$ref/data_requirements/model_input", "value" : { "object_type" : [ "DIRECTORY" ], "obs_url" : "/test-crq/train_output/" } } ], "outputs" : [ { "name" : "model_output", "type" : "model", "config" : { "model_id" : "7d795a48-e646-43b0-b4cb-759454acaf2b" } } ], "properties" : { "model_name" : "lh-xh", "model_type" : "TensorFlow" }, "events" : [ "2022-06-16 23:12:49 change status from init to creating", "2022-06-16 23:12:51 change status from creating to created", "2022-06-16 23:12:51 change status from created to running", "2022-06-16 23:13:05 change status from running to completed" ], "policy" : { } }, { "created_at" : "2022-06-16T23:13:05.620354+08:00", "uuid" : "9b452016-cc7b-4bfe-snt9-f9d53dcb4cc1", "step_name" : "service_step", "step_title" : "service install", "status" : "stopped", "duration" : 1, "events" : [ "2022-06-16 23:13:06 change status from init to wait_inputs", "2022-06-16 23:16:13 change status from wait_inputs to stopped" ], "policy" : { } } ], "duration" : 204, "events" : [ "2022-06-16 23:12:49 step model_step change status from init to creating", "2022-06-16 23:12:51 step model_step change status from creating to created", "2022-06-16 23:12:51 step model_step change status from created to running", "2022-06-16 23:13:05 step model_step change status from running to completed", "2022-06-16 23:13:06 step service_step change status from init to wait_inputs", "2022-06-16 23:16:13 step service_step change status from wait_inputs to stopped" ], "data_requirements" : [ { "name" : "model_input", "type" : "obs", "conditions" : [ { "attribute" : "object_type", "operator" : "equal", "value" : "directory" } ], "value" : { "object_type" : [ "DIRECTORY" ], "obs_url" : "/test-crq/train_output/" }, "used_steps" : [ "model_step" ] }, { "name" : "service_model", "type" : "model_list", "delay" : true, "conditions" : [ { "attribute" : "model_name", "operator" : "equal", "value" : "lh-xh" } ], "used_steps" : [ "service_step" ] } ], "parameters" : [ { "name" : "schedule_d5sm", "type" : "int", "format" : "schedule", "description" : "Set how long the deployed service will stop in hours, where -1 means the service will always run", "delay" : true, "used_steps" : [ "service_step" ] } ], "policies" : { } }

响应示例 状态码： 200 OK { "created_at" : "2021-12-14T11:34:24.541809+08:00", "workflow_id" : "a8f31367-3534-4644-a2fe-75d187341ae7", "name" : "demo_workflow", "description" : "this is a demo workflow", "user_name" : "ei_modelarts_z00424192_01", "workspace_id" : "0", "steps" : [ { "created_at" : "2021-12-14T11:34:24.545451+08:00", "name" : "model_step", "title" : "model release", "description" : "", "type" : "model", "inputs" : [ { "name" : "model_input", "type" : "obs", "data" : "$ref/data_requirements/model_input" } ], "outputs" : [ { "name" : "model_output", "type" : "model" } ], "properties" : { "model_name" : "model-name-xh", "model_type" : "TensorFlow" }, "policy" : { } }, { "created_at" : "2021-12-14T11:34:24.549514+08:00", "name" : "service_step", "title" : "service install", "description" : "", "type" : "service", "inputs" : [ { "name" : "service_input", "type" : "model_list", "data" : "$ref/data_requirements/service_model" } ], "outputs" : [ { "name" : "service_output", "type" : "service" } ], "properties" : { "infer_type" : "real-time", "schedule" : "$ref/parameters/schedule_d0MY" }, "depend_steps" : [ "model_step" ], "policy" : { } } ], "data_requirements" : [ { "name" : "model_input", "type" : "obs", "conditions" : [ { "attribute" : "object_type", "operator" : "equal", "value" : "directory" } ], "value" : { "object_type" : [ "DIRECTORY" ], "obs_url" : "/cwf-test/csv/" }, "used_steps" : [ "model_step" ] }, { "name" : "service_model", "type" : "model_list", "delay" : true, "conditions" : [ { "attribute" : "model_name", "operator" : "equal", "value" : "model-name-xh" } ], "used_steps" : [ "service_step" ] } ], "parameters" : [ { "name" : "schedule_1zHw", "type" : "int", "format" : "schedule", "description" : "Set how long the deployed service will stop in hours, where -1 means the service will always run", "delay" : true, "used_steps" : [ "service_step" ] } ], "policy" : { }, "last_modified_at" : "2022-05-20T14:16:40.373445+08:00" }

请求示例 更新工作流信息 PUT https://{endpoint}/v2/{project_id}/workflows/a8f31367-3534-4644-a2fe-75d187341ae7 { "parameters" : [ { "name" : "schedule_1zHw", "type" : "int", "format" : "schedule", "description" : "Set how long the deployed service will stop in hours, where -1 means the service will always run", "delay" : true, "used_steps" : [ "service_step" ] } ], "smn_switch" : true }

URI POST /v2/{project_id}/training-jobs/{training_job_id}/tasks/{task_id}/save-image-job 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 用户项目ID。获取方法请参见获取项目ID和名称。 training_job_id 是 String 训练作业ID。 task_id 是 String 训练作业的任务名称。可从训练作业详情中的 status.tasks 字段中获取。

响应示例 状态码： 201 create image save job successfully { "name" : "imagesave", "namespace" : "dev", "tag" : 0.1, "description" : "hello world!", "status" : "ACTIVE", "message" : "building", "create_time" : 1686718209968 }

请求示例 如下以创建uuid为2cd88daa-31a4-40a8-a58f-d186b0e93e4f的训练作业对应worker-0镜像保存任务为例。 POST https://endpoint/v2/{project_id}/training-jobs/2cd88daa-31a4-40a8-a58f-d186b0e93e4f/tasks/worker-0/save-image-job { "name" : "imagesave", "namespace" : "dev", "tag" : 0.1, "description" : "hello world!" }

请求参数 表2 请求Body参数 参数 是否必选 参数类型 描述 name 否 String 镜像名称，长度限制512个字符，支持小写字母、数字、中划线、下划线和点。 namespace 否 String 镜像所属组织，可以在SWR控制台“组织管理”创建和查看。 tag 否 String 镜像tag，长度限制64个字符， 支持大小写字母、数字、中划线、下划线和点。 description 否 String 该镜像所对应的描述信息，长度限制512个字符。 status 否 String 镜像状态。枚举值如下： INIT：初始化。 CREATING：镜像保存中，此时训练作业不可用。 CREATE_FAILED：镜像保存失败。 ACTIVE：镜像保存成功，保存的镜像可以在SWR控制台查看，同时可以基于保存的镜像创建训练作业。 message 否 String 镜像保存操作过程中，构建信息展示。 create_time 否 Long 镜像创建的时间，UTC毫秒。

响应参数 状态码： 201 表3 响应Body参数 参数 参数类型 描述 name String 镜像名称，长度限制512个字符，支持小写字母、数字、中划线、下划线和点。 namespace String 镜像所属组织，可以在SWR控制台“组织管理”创建和查看。 tag String 镜像tag，长度限制64个字符， 支持大小写字母、数字、中划线、下划线和点。 description String 该镜像所对应的描述信息，长度限制512个字符。 status String 镜像状态。枚举值如下： INIT：初始化。 CREATING：镜像保存中，此时训练作业不可用。 CREATE_FAILED：镜像保存失败。 ACTIVE：镜像保存成功，保存的镜像可以在SWR控制台查看，同时可以基于保存的镜像创建训练作业。 message String 镜像保存操作过程中，构建信息展示。 create_time Long 镜像创建的时间，UTC毫秒。

响应示例 状态码： 200 OK { "total" : 1, "count" : 1, "items" : [ { "created_at" : "2022-06-17T17:08:16.91019+08:00", "name" : "execution-064", "execution_id" : "918cd9bd-62dd-4179-b5f0-773dd7184a56", "description" : "", "status" : "completed", "workspace_id" : "0", "workflow_id" : "f1642618-43eb-4ab1-a0b1-9cc584182c60", "workflow_name" : "workflow_model_service_no_modify_xiahou_copy", "steps_execution" : [ { "created_at" : "2022-06-17T17:08:16.920281+08:00", "uuid" : "d6148a4a-4a5e-47a3-bc90-3183905b4941", "instance_id" : "{\"model_id\":\"253aba02-4bd6-4f64-8d37-66022ae7af4d\"}", "step_name" : "model_step", "step_title" : "model release", "status" : "completed", "duration" : 16, "inputs" : [ { "name" : "model_input", "type" : "obs", "data" : "$ref/data_requirements/model_input", "value" : { "object_type" : [ "DIRECTORY" ], "obs_url" : "/test-crq/train_output/" } } ], "outputs" : [ { "name" : "model_output", "type" : "model", "config" : { "model_id" : "253aba02-4bd6-4f64-8d37-66022ae7af4d" } } ], "properties" : { "model_name" : "lh-xh", "model_type" : "TensorFlow" }, "events" : [ "2022-06-17 17:08:17 change status from init to creating", "2022-06-17 17:08:19 change status from creating to created", "2022-06-17 17:08:20 change status from created to running", "2022-06-17 17:08:33 change status from running to completed" ], "policy" : { } }, { "created_at" : "2022-06-17T17:08:33.038184+08:00", "uuid" : "b34b2b54-eb70-4c7f-a92d-05f849d8c39a", "instance_id" : { "type" : "deploy", "service_id" : "81f22d60-5488-4e3d-bba9-08c812ae84b0", "status" : "", "update_time" : 0 }, "step_name" : "service_step", "step_title" : "service install", "status" : "completed", "duration" : 83430, "inputs" : [ { "name" : "service_input", "type" : "model_list", "data" : "$ref/data_requirements/service_model", "value" : { "model_list" : [ { "envs" : { }, "instance_count" : 1, "model_id" : "253aba02-4bd6-4f64-8d37-66022ae7af4d", "model_name" : "lh-xh", "model_version" : "0.0.62", "specification" : "modelarts.vm.ai1.a310", "weight" : 100 } ] } } ], "outputs" : [ { "name" : "service_output", "type" : "service", "config" : { "service_id" : "81f22d60-5488-4e3d-bba9-08c812ae84b0" } } ], "properties" : { "infer_type" : "real-time", "schedule" : -1 }, "events" : [ "2022-06-17 17:08:34 change status from init to wait_inputs", "2022-06-18 16:16:58 change status from wait_inputs to creating", "2022-06-18 16:17:01 change status from creating to created", "2022-06-18 16:17:02 change status from created to running", "2022-06-18 16:19:03 change status from running to completed" ], "policy" : { } } ], "duration" : 11852428, "events" : [ "2022-06-17 17:08:17 step model_step change status from init to creating", "2022-06-17 17:08:19 step model_step change status from creating to created", "2022-06-17 17:08:20 step model_step change status from created to running", "2022-06-17 17:08:33 step model_step change status from running to completed", "2022-06-17 17:08:34 step service_step change status from init to wait_inputs", "2022-06-18 16:16:58 step service_step change status from wait_inputs to creating", "2022-06-18 16:17:01 step service_step change status from creating to created", "2022-06-18 16:17:02 step service_step change status from created to running", "2022-06-18 16:19:03 step service_step change status from running to completed" ], "data_requirements" : [ { "name" : "model_input", "type" : "obs", "conditions" : [ { "attribute" : "object_type", "operator" : "equal", "value" : "directory" } ], "value" : { "object_type" : [ "DIRECTORY" ], "obs_url" : "/test-crq/train_output/" }, "used_steps" : [ "model_step" ] }, { "name" : "service_model", "type" : "model_list", "delay" : true, "conditions" : [ { "attribute" : "model_name", "operator" : "equal", "value" : "lh-xh" } ], "value" : { "model_list" : [ { "envs" : { }, "instance_count" : 1, "model_id" : "253aba02-4bd6-4f64-8d37-66022ae7af4d", "model_name" : "lh-xh", "model_version" : "0.0.62", "specification" : "modelarts.vm.ai1.a310", "weight" : 100 } ] }, "used_steps" : [ "service_step" ] } ], "parameters" : [ { "name" : "schedule_d5sm", "type" : "int", "format" : "schedule", "description" : "Set how long the deployed service will stop in hours, where -1 means the service will always run", "delay" : true, "value" : -1, "used_steps" : [ "service_step" ] } ], "policies" : { } } ] }

URI GET /v2/{project_id}/workflows/{workflow_id}/executions 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 用户项目ID。获取方法请参见获取项目ID和名称。 workflow_id 是 String 工作流的ID 表2 Query参数 参数 是否必选 参数类型 描述 workspace_id 否 String 工作空间ID，用于过滤具体工作空间下的条目 limit 否 String 分页参数limit，表示单次查询的条目数上限。假如要查询20~29条记录，offset为20，limit为10 sort_by 否 String 排序依据字段，例如sort_by=create_time，则表示以条目的创建时间进行排序 offset 否 String 分页参数offset，表示单次查询的条目偏移数量。假如要查询20~29条记录，offset为20，limit为10 labels 否 String 执行记录标签 status 否 String 执行记录状态 scene_id 否 String 场景ID order 否 String 排序的方式。该字段必须与sort_by同时使用。 缺省值: desc 枚举值： asc：表示升序排列， desc：降序排列。