接口功能介绍
获取指定RDS实例下节点的binlog信息。如果未开启binlog开关,则返回空的查询结果。
接口约束
数据库节点开启了binlog开关。
URI
GET /v1/open-api/database/describe-binlog-files
路径参数
无
query参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
outerProdInstId | 是 | String | 主机实例id | 555b89493b1a40e1b97ea05e50dd8170 |
响应参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
statusCode | 是 | String | 返回码 | 0 | |
message | 是 | String | 返回消息 | null | |
returnObj | 是 | Array of Objects | 返回对象 | returnObj |
表 returnObj
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
Res_id | 是 | Integer | 资源ID | 22 | |
Log_name | 是 | String | Binlog文件名 | mysql_bin.000001 | |
File_size | 是 | Integer | Binlog文件大小 | 154 | |
Port | 是 | Integer | 端口 | 6301 | |
Role | 是 | String | 实例角色 | m | |
Host | 是 | String | 地址 | 172.10.2.13 |
请求示例
请求头header
无
请求体body
无
响应示例
开启了binlog的情况:
{
"statusCode": 0,
"message": "success",
"returnObj": [
{
"Role": "m",
"Port": "3306",
"Log_name": "mysql_bin.000001",
"File_size": 154,
"Res_id": 1,
"Host": "127.0.0.1"
},
{
"Role": "m",
"Port": "3306",
"Log_name": "mysql_bin.000002",
"File_size": 154,
"Res_id": 1,
"Host": "127.0.0.1"
},
{
"Role": "m",
"Port": "3306",
"Log_name": "mysql_bin.000003",
"File_size": 177,
"Res_id": 1,
"Host": "127.0.0.1"
},
{
"Role": "m",
"Port": "3306",
"Log_name": "mysql_bin.000004",
"File_size": 154,
"Res_id": 1,
"Host": "127.0.0.1"
},
{
"Role": "m",
"Port": "3306",
"Log_name": "mysql_bin.000005",
"File_size": 154,
"Res_id": 1,
"Host": "127.0.0.1"
}
]
}
未开启binlog的情况:
{
"statusCode": 0,
"message": "success",
"opMessage": "The binlog switch is not turned on",
"returnObj": []
}
状态码
状态码 | 描述 |
---|---|
0 | 请求响应成功 |
错误码
状态码 | 描述 |
---|---|
2001 | 参数异常,失败原因见message |
3001 | 业务异常,失败原因见message |
5001 | 请求响应失败,失败原因见message |