慢日志下载任务相关接口说明
更新时间：2019-08-16
添加慢日志下载任务
说明
添加慢日志下载任务，添加完成后，可以通过对应的详情接口或列表接口查看任务执行状态。
请求结构
POST /v{version}/instance/slowquery/task/{instanceId} HTTP/1.1
HOST: rds.bj.baidubce.com
Authorization: authorization string
{
"startTime" : startTime,
"endTime" : endTime
}请求头域
除公共头域，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必须 | 参数位置 | 描述 |
|---|---|---|---|---|
| version | string | 是 | URL参数 | API 版本号 |
| instanceId | string | 是 | URL参数 | 实例ID |
| startTime | string | 是 | RequestBody参数 | UTC时间，汇总统计查询的开始时间 |
| endTime | string | 是 | RequestBody参数 | UTC时间，汇总统计查询的结束时间，结束时间与开始时间存在一定的限制，结束时间要晚于开始时间，且其间隔要大于等于30分钟，且小于等于3小时 |
返回头域
除公共头域，无其它特殊头域。
返回参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| taskId | int | 任务ID |
请求示例
GET /v1/instance/slowquery/task/rds-xxx HTTP/1.1
HOST: rds.bj.baidubce.com
Authorization: bce-auth-v1/rdsak/2016-07-03T06:13:13Z/1800/x-bce-date/{signature}
{
"startTime" : "2019-04-03T06:13:13Z",
"endTime" : "2019-04-03T08:13:13Z"
}返回示例
HTTP/1.1 200 OK
x-bce-request-id: 7869616F-7A68-6977-656E-406261696475
Content-Type: application/json
Content-Length: 49
{
"result" : {
"taskId" : 100001
}
}
获取慢日志管理任务列表
返回该实例下的慢日志下载任务列表。
请求结构
GET /v{version}/instance/slowquery/task/{instanceId} HTTP/1.1
HOST: rds.bj.baidubce.com
Authorization: authorization string请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必须 | 参数位置 | 描述 |
|---|---|---|---|---|
| version | string | 是 | URL参数 | API 版本号 |
| instanceId | string | 是 | URL参数 | 实例ID |
| marker | string | 否 | Query参数 | 批量获取列表的查询的起始位置，是一个由系统生成的字符串 |
| maxKeys | string | 否 | Query参数 | 每页包含的最大数量，最大数量通常不超过1000，缺省值为1000 |
| filterStartTime | string | 否 | Query参数 | UTC时间，慢日志任务过滤开始时间 |
| filterEndTime | string | 否 | Query参数 | UTC时间，慢日志任务过滤结束时间 |
返回头域
除公共头域，无其它特殊头域。
返回参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| marker | string | 批量获取列表的查询的起始位置，是一个由系统生成的字符串 |
| maxKeys | int | 每页包含的最大数量，最大数量通常不超过1000，缺省值为1000。 |
| isTruncated | boolean | true表示后面还有数据，false表示已经是最后一页 |
| nextMarker | string | 获取下一页所需要传递的marker值。当isTruncated为false时，该域不出现 |
| result | List Instance | 由Instance对象组成的数组 |
请求示例
GET /v1/instance/slowquery/task/123 HTTP/1.1
HOST: rds.bj.baidubce.com
Authorization: bce-auth-v1/rdsak/2016-07-03T06:13:13Z/1800/x-bce-date/{signature}返回示例
{
"nextMarker": "rds-xktdeMSf",
"marker": "rds-IyWRtII7",
"maxKeys": 1,
"isTruncated": true,
"result":[{
"taskId" : "100001",
"instanceId" : "rds-fkii3341x",
"createTime" : "2019-06-01T12:00:00Z",
"status" : "running"
}]
}获取慢日志下载任务详情
说明
查询慢日志下载任务详情。
请求结构
GET /v{version}/instance/slowquery/task/{instanceId}/{taskId} HTTP/1.1
HOST: rds.bj.baidubce.com
Authorization: authorization string请求参数
| 参数名称 | 类型 | 是否必须 | 参数位置 | 描述 |
|---|---|---|---|---|
| version | string | 是 | URL参数 | API 版本号 |
| instanceId | string | 是 | URL参数 | 实例ID |
| taskId | string | 是 | URL参数 | 慢日志下载任务ID |
返回头域
除公共头域，无其它特殊头域。
返回参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| result | Task Object | 由Instance对象组成的数组 |
Task Object结构
| 参数名称 | 类型 | 描述 |
|---|---|---|
| taskId | int | 慢日志下载任务ID |
| status | string | 状态 |
| downloadUrl | string | 下载链接 |
| expireDate | string | UTC时间，下载链接过期时间 |
请求示例
GET /v1/instance/slowquery/task/rds-fkxiuhbs/100001 HTTP/1.1
HOST: rds.bj.baidubce.com
Authorization: bce-auth-v1/rdsak/2019-04-03T06:13:13Z/1800/x-bce-date/{signature}返回示例
HTTP/1.1 200 OK
x-bce-request-id: 7869616F-7A68-6977-656E-406261696475
Content-Type: application/json
Content-Length: 226
{
"result" : {
"taskId" : 100001,
"instanceId" : "rds-fkxiuhbs",
"status" : "success",
"downloadUrl" : "http://downloadxx.bce.baidu.com/xxxxx",
"expireDate" : "2019-04-04T06:13:13Z"
}
}