华为云用户手册

  • 请求示例 使用备份文件恢复: MySQL: https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/recovery { "source": { "instance_id": "d8e6ca5a624745bcb546a227aa3ae1cfin01", "type": "backup", "backup_id": "2f4ddb93-b901-4b08-93d8-1d2e472f30fe" }, "target": { "instance_id": "d8e6ca5a624745bcb546a227aa3ae1cfin01" } } SQL Server: { "source": { "instance_id": "61879e6085bc44d1831b0ce62d988fd9in04", "type": "backup", "backup_id": "b021670e69ba4538b7b2ed07257306aebr04", "database_name": { "db1": "dbtest1", "db2": "" } }, "target": { "instance_id": "d8e6ca5a624745bcb546a227aa3ae1cfin04" } } 按时间点恢复: MySQL: { "source": { "instance_id": "d8e6ca5a624745bcb546a227aa3ae1cfin01", "type": "timestamp", "restore_time": 1532001446987 }, "target": { "instance_id": "d8e6ca5a624745bcb546a227aa3ae1cfin01" } } Microsoft SQL Server: { "source": { "instance_id": "61879e6085bc44d1831b0ce62d988fd9in04", "type": "timestamp", "restore_time": 1532001446987, "database_name": { "db1": "dbtest1,dbtest2", "db2": "db2,db02", "db3": "" } }, "target": { "instance_id": "d8e6ca5a624745bcb546a227aa3ae1cfin04" } }
  • 接口约束 该接口仅支持MySQL和PostgreSQL引擎。 Serverless型实例不支持该接口。 仅支持停止存储类型为超高IO、SSD云盘、极速型SSD的按需实例,专属云RDS不支持停止实例。 已停止的实例被删除后不会进入回收站。 停止主实例时,如果存在只读实例,会同时停止只读实例。不支持单独停止只读实例。对于华东-上海一区域,主实例和只读实例均默认停止十五天。对于除华东-上海一外的其他区域,主实例和只读实例均默认停止七天。 对于华东-上海一区域,实例默认停止十五天,如果您在十五天后未手动开启实例,数据库实例将于十五天后的下一个可维护时间段内自动启动。 对于除华东-上海一外的其他区域,实例默认停止七天,如果您在七天后未手动开启实例,数据库实例将于七天后的下一个可维护时间段内自动启动。 实例停止后,虚拟机(VM)停止收费,其余资源包括弹性公网IP(EIP)、存储资源、备份正常计费。 按需付费的数据库实例停止实例后,可能会出现由于资源不足引起开启失败,如遇到无法开启的情况请联系客服人员处理。 实例在以下状态不能执行停止实例: 创建、重启、扩容、变更规格、恢复、修改端口等不能进行此操作。
  • URI URI格式 DELETE /v3/{project_id}/instances/{instance_id}/proxy URI样例 https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/f569f1358436479dbcba8603c32cc4aein03/proxy 参数说明 表1 参数说明 名称 是否必选 说明 project_id 是 租户在某一region下的project ID。 获取方法请参见获取项目ID。 instance_id 是 实例ID。
  • 请求消息 表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 每次自动扩容的步长,单位为百分比,即每次自动扩容当前存储空间的百分比。“switch_option”为true时,且开启了自定义扩容步长功能时,该参数必填。 取值范围为5%~50%。
  • 请求示例 设置实例可用存储空间小于等于总空间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 }
  • 接口约束 该接口公测中,如需使用请联系客服申请。 账户余额必须大于等于0元,余额不足会导致自动扩容失败。 该接口仅支持RDS for MySQL和RDS for PostgreSQL磁盘大小为40GB及以上的云盘实例(即存储类型为SSD云盘或极速型SSD)。 实例在进行规格变更、内核小版本升级、备机迁移、重启时,不能进行自动扩容。 包周期实例存在未完成订单时,不会自动扩容。 实例状态为“正常”和“存储空间满”时可以进行扩容。最大可自动扩容至4000GB。
  • 响应消息 正常响应要素说明 表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条数据后开始查询,默认为0(偏移0条数据,表示从第一条数据开始查询),必须为数字,不能为负数。 支持最多查询数据库最近的2000条慢日志信息,参数值须满足offset + limit取值小于等于2000。示例:offset取值为1900,limit取值100。 limit 否 每页多少条记录(查询结果),取值范围是1~100,不填时默认为10。 type 否 语句类型,取空值,表示查询所有语句类型,也可指定如下日志类型: INSERT UPDATE SELECT DELETE CREATE
  • 请求示例 使用备份文件将数据恢复到实例。 POST https://{endpoint}/v3.1/0483b6b16e954cb88930a360d2c4e663/instances/recovery { "source": { "instance_id": "d8e6ca5a624745bcb546a227aa3ae1cfin01", "type": "backup", "backup_id": "2f4ddb93-b901-4b08-93d8-1d2e472f30fe" }, "target": { "instance_id": "d8e6ca5a624745bcb546a227aa3ae1cfin01" } } 使用SQL Server备份文件将所有数据库恢复到实例。 { "source": { "instance_id": "61879e6085bc44d1831b0ce62d988fd9in04", "type": "backup", "backup_id": "b021670e69ba4538b7b2ed07257306aebr04", "restore_all_database":true }, "target": { "instance_id": "d8e6ca5a624745bcb546a227aa3ae1cfin04" } } 将实例的数据恢复到指定时间点。 { "source": { "instance_id": "d8e6ca5a624745bcb546a227aa3ae1cfin01", "type": "timestamp", "restore_time": 1532001446987 }, "target": { "instance_id": "d8e6ca5a624745bcb546a227aa3ae1cfin01" } } 将SQL Server实例的部分数据库恢复到指定时间点。 { "source": { "instance_id": "61879e6085bc44d1831b0ce62d988fd9in04", "type": "timestamp", "restore_time": 1532001446987, "database_name": { "db1": "dbtest1,dbtest2", "db2": "db2,db02", "db3": "" } }, "target": { "instance_id": "d8e6ca5a624745bcb546a227aa3ae1cfin04" } }
  • 响应消息 正常响应要素说明 表2 要素说明 名称 参数类型 说明 proxy Object Proxy实例信息。 详情请参见表3。 master_instance Object 主实例信息。 详情请参见表4。 readonly_instances Array of objects 只读实例信息。 详情请参见表5。 表3 proxy元素数据结构说明 名称 参数类型 说明 pool_id String Proxy实例ID。 status String Proxy实例开启状态,取值范围如下。 open:打开。 closed:关闭。 frozen:已冻结。 opening:打开中。 closing:关闭中。 freezing:冻结中。 unfreezing:解冻中。 address String Proxy读写分离地址。 elb_vip String elb模式的虚拟ip信息。 eip String 弹性公网IP信息。 port Integer Proxy端口信息。 pool_status String Proxy实例状态。 abnormal:异常。 normal:正常。 creating:创建中。 deleted:已删除。 delay_threshold_in_kilobytes Integer 延时阈值(单位:KB)。 cpu String Proxy实例规格的CPU数量。 mem String Proxy实例规格的内存数量。 node_num Integer Proxy节点个数。 nodes Array of objects Proxy节点信息。 详情请参见表6。 mode String Proxy主备模式,取值范围:Ha。 表4 master_instance元素数据结构说明 名称 参数类型 说明 id String 主实例ID。 status String 主实例状态。 name String 主实例名称。 weight Integer 主实例读写分离权重。 available_zones Array of objects 可用区信息。 详情请参见表7。 cpu_num Integer 主实例CPU个数。 表5 readonly_instances元素数据结构说明 名称 参数类型 说明 id String 只读实例ID。 status String 只读实例状态。 name String 只读实例名称。 weight Integer 只读实例读写分离权重。 available_zones Array of objects 可用区信息。 详情请参见表7。 cpu_num Integer 只读实例CPU个数。 表6 nodes元素数据结构说明 名称 参数类型 说明 id String Proxy节点ID。 name String Proxy节点名称。 role String Proxy节点角色。 master:主节点。 slave:备节点。 az_code String 可用区。 status String Proxy节点状态。 normal:正常。 abnormal:异常。 creating:创建中。 deleted:已删除。 frozen_flag Integer Proxy节点是否被冻结。 0:未冻结。 1:冻结。 2:冻结删除。 表7 available_zones元素数据结构说明 名称 参数类型 说明 code String 可用区编码。 description String 可用区描述。 正常响应样例 { "proxy":{ "pool_id":"c6ee492784b640e694f1da0201cd82c8po03", "status":"open", "address":"192.168.0.60", "elb_vip":null, "eip":null, "port":3306, "pool_status":"normal", "delay_threshold_in_kilobytes":30, "cpu":"4", "mem":"8", "node_num":2, "nodes":[ { "id":"4fb00607cffd42dc9583ca09863df93cpn03", "name":"PROXY-c6ee492784b640e694f1da0201cd82c8po03_1", "role":"slave", "az_code":"az1xahz", "status":"normal", "frozen_flag":0 }, { "id":"191f3164f918463bb6aedeb6ba742920pn03", "name":"PROXY-c6ee492784b640e694f1da0201cd82c8po03_0", "role":"master", "az_code":"az1xahz", "status":"normal", "frozen_flag":0 } ], "mode":"Ha" }, "master_instance":{ "id":"49fcbb94435c4d89930e91dcf5884909in03", "status":"normal", "name":"proxy-hwt-0922-3", "weight":0, "available_zones":[ { "code":"az1xahz", "description":"可用区1" } ], "cpu_num":8 }, "readonly_instances":[ { "id":"83251d1398594b9fbfc8f1ab8b8228b2in03", "status":"normal", "name":"replica-a392", "weight":100, "available_zones":[ { "code":"az1xahz", "description":"可用区1" } ], "cpu_num":4 } ] } 异常响应 请参见异常请求结果。
  • URI URI格式 GET /v3/{project_id}/instances/{instance_id}/proxy URI样例 https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/f569f1358436479dbcba8603c32cc4aein03/proxy 参数说明 表1 参数说明 名称 是否必选 说明 project_id 是 租户在某一region下的project ID。 获取方法请参见获取项目ID。 instance_id 是 实例ID。
  • 请求示例 https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/f569f1358436479dbcba8603c32cc4aein03/proxy/weight { "master_weight":"0", "readonly_instances":[ { "id":"83251d1398594b9fbfc8f1ab8b8228b2in03", "weight":100 } ] }
  • 请求消息 参数说明 表2 参数说明 名称 是否必选 参数类型 说明 master_weight 是 String 主实例权重,取值范围为0~1000。 readonly_instances 是 Array of objects 只读实例信息。 详情请参见表3。 表3 readonly_instances字段数据结构说明 名称 是否必选 参数类型 说明 id 是 String 只读实例ID。 weight 是 Integer 只读实例权重,取值范围为0~1000。
  • URI URI格式 GET /v3/{project_id}/instances/{instance_id}/proxy/scale/flavors URI样例 https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/f569f1358436479dbcba8603c32cc4aein03/proxy/scale/flavors 参数说明 表1 参数说明 名称 是否必选 说明 project_id 是 租户在某一region下的project ID。 获取方法请参见获取项目ID。 instance_id 是 实例ID。
  • 响应消息 正常响应要素说明 表2 要素说明 名称 参数类型 说明 compute_flavor_groups Array of objects 计算规格列表对象。 详情请参见表3。 表3 compute_flavor_groups元素数据结构说明 名称 参数类型 说明 group_type String 群组类型。 X86:X86架构。 ARM:ARM架构。 compute_flavors Array of objects 计算规格信息。 详情请参见表4 表4 ScaleFlavors元素数据结构说明 名称 参数类型 说明 code String 规格码。 cpu String CPU个数。 mem String 内存大小(单位:GB)。 正常响应样例 { "compute_flavor_groups" : { "group_type" : "X86", "compute_flavors" : { "code" : "rds.pg.proxy.c6.large.2.ha", "cpu" : 2, "mem" : 4 } } } 异常响应 请参见异常请求结果。
  • URI URI格式 GET /v3.1/{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 否 索引位置,偏移量。 从第一条数据偏移offset条数据后开始查询,默认为0(偏移0条数据,表示从第一条数据开始查询),必须为数字,不能为负数。 limit 否 每页多少条记录(查询结果),取值范围是1~100,不填时默认为10。 level 否 日志级别,默认为ALL,可取值如下: ALL INFO LOG WARNING ERROR FATAL PANIC NOTE
  • 响应消息 正常响应要素说明 表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": "2022-08-23T22:59:17Z", "level": "WARNING", "content": "Occur error when reading bytes from a network handler. Client actively closes the connection." }, { "time": "2022-08-23T22:54:17Z", "level": "WARNING", "content": "Occur error when reading bytes from a network handler. Client actively closes the connection." } ], "total_record": 2 } 异常响应 请参见异常请求结果。
  • 请求消息 请求参数 无。 URI样例 GET https://{endpoint}/v3.1/0483b6b16e954cb88930a360d2c4e663/instances/cee5265e1e5845649e354841234567dfin01/errorlog?offset=1&limit=10&start_date=2022-08-23T07:41:50+0800&end_date=2022-08-24T07:41:50+0800&level=ALL
  • 响应消息 正常响应要素说明 表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
  • URI URI格式 GET /v3.1/{project_id}/instances/{instance_id}/proxy/scale/flavors URI样例 https://{endpoint}/v3.1/0483b6b16e954cb88930a360d2c4e663/instances/f569f1358436479dbcba8603c32cc4aein03/proxy/scale/flavors 参数说明 表1 参数说明 名称 是否必选 说明 project_id 是 租户在某一region下的project ID。 获取方法请参见获取项目ID。 instance_id 是 实例ID。 offset 否 索引位置,偏移量。从第一条数据偏移offset条数据后开始查询,默认为0(偏移0条数据,表示从第一条数据开始查询),必须为数字,不能为负数。 limit 否 查询记录数。默认为100,不能为负数,最小值为1,最大值为100。
  • 响应消息 正常响应要素说明 表2 要素说明 名称 参数类型 说明 compute_flavor_groups Array of objects 计算规格列表对象。 详情请参见表3。 表3 compute_flavor_groups元素数据结构说明 名称 参数类型 说明 group_type String 群组类型。 X86:X86架构。 ARM:ARM架构。 compute_flavors Array of objects 计算规格信息。 详情请参见表4 表4 ScaleFlavors元素数据结构说明 名称 参数类型 说明 code String 规格码。 cpu String CPU个数。 mem String 内存大小(单位:GB)。 正常响应样例 { "compute_flavor_groups" : { "group_type" : "X86", "compute_flavors" : { "code" : "rds.pg.proxy.c6.large.2.ha", "cpu" : 2, "mem" : 4 } } } 异常响应 请参见异常请求结果。
  • 修订记录 发布日期 更新特性 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
共100000条