查询实例的主备切换日志。
接口说明
调用本接口时,实例必须满足以下条件:
-
实例的类型为副本集实例或分片集群实例。
-
实例的规格类型为本地物理盘。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
dds:DescribeDBInstanceSwitchLog |
list |
*Instance
|
无 | 无 |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| StartTime |
string |
否 |
查询开始时间,格式为yyyy-mm-ddThh:mmZ(UTC 时间)。 |
2023-05-27T02:46Z |
| EndTime |
string |
否 |
查询结束时间,必须晚于查询开始时间,格式为yyyy-mm-ddThh:mmZ(UTC 时间)。 |
2023-05-28T02:00Z |
| PageNumber |
integer |
否 |
页码,取值为大于 0 且不超过 integer 数据类型的最大值,默认值为 1。 |
1 |
| PageSize |
integer |
否 |
每页记录数,取值:30、50、100,默认值为 30。 |
30 |
| DBInstanceId |
string |
否 |
实例 ID。 |
dds-uf68f1b5a57exxxx |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
Schema of Response |
||
| RequestId |
string |
请求 ID。 |
ECBCA991-XXXX-XXXX-834C-B3E8007F33AA |
| DBInstanceId |
string |
实例 ID。 |
dds-uf68f1b5a57exxxx |
| TotalCount |
integer |
查询结果中主备切换记录的数量。 |
1 |
| PageSize |
integer |
每页记录数。 |
30 |
| PageNumber |
integer |
当前页码。 |
1 |
| LogItems |
array<object> |
主备切换日志列表。 |
|
|
object |
切换记录对象。 |
||
| SwitchStatus |
string |
切换状态。 返回值为:
|
1 |
| SwitchTime |
string |
切换时间,格式为yyyy-mm-ddThh:mm:ssZ(UTC 时间)。 |
2023-02-07T18:00:00Z |
| SwitchCode |
string |
切换原因代码:
|
USER_CONSOLE_OPERATION |
| NodeId |
string |
当实例为副本集实例,展示实例 ID;当实例为分片集实例,展示切换的节点 ID。 |
当实例为副本集实例:dds-uf68f1b5a57exxxx。 当实例为分片集实例:d-uf652b73f554xxxx |
示例
正常返回示例
JSON格式
{
"RequestId": "ECBCA991-XXXX-XXXX-834C-B3E8007F33AA",
"DBInstanceId": "dds-uf68f1b5a57exxxx",
"TotalCount": 1,
"PageSize": 30,
"PageNumber": 1,
"LogItems": [
{
"SwitchStatus": "1",
"SwitchTime": "2023-02-07T18:00:00Z",
"SwitchCode": "USER_CONSOLE_OPERATION",
"NodeId": "当实例为副本集实例:dds-uf68f1b5a57exxxx。\n当实例为分片集实例:d-uf652b73f554xxxx"
}
]
}
错误码
|
HTTP status code |
错误码 |
错误信息 |
描述 |
|---|---|---|---|
| 400 | InvalidParameterCombination | The end time must be greater than the start time | 开始时间不能大于结束时间。 |
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。