查询主备切换日志

最近更新时间:2024-03-12 01:47:08

我的收藏

1. 接口描述

接口请求域名: sqlserver.tencentcloudapi.com 。

本接口(DescribeHASwitchLog)用于手动主备切换。

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeHASwitchLog。
Version String 公共参数,本接口取值:2018-03-28。
Region String 公共参数,详见产品支持的 地域列表
InstanceId String 实例ID
示例值:mssql-8ua7ah
StartTime String 开始时间(yyyy-MM-dd HH:mm:ss)
示例值:2023-01-01 00:00:00
EndTime String 结束时间(yyyy-MM-dd HH:mm:ss)
示例值:2023-01-01 00:00:00
SwitchType Integer 切换模式 0-系统自动切换,1-手动切换,不填默认查全部。
示例值:0
Limit Integer 分页,页大小
示例值:20
Offset Integer 分页,页数
示例值:0

3. 输出参数

参数名称 类型 描述
TotalCount Integer 日志总数量
示例值:0
SwitchLog Array of SwitchLog 主备切换日志
示例值:[]
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询实例主备切换日志

输入示例

POST / HTTP/1.1
Host: sqlserver.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: SwitchCloudInstanceHA
<公共请求参数>

{
    "InstanceId": "mssql-98aiauan",
    "SwitchType": 1,
    "StartTime": "2023-01-01 00:00:00",
    "EndTime": "2023-01-01 00:01:00",
    "Limit": 10,
    "Offset": 0
}

输出示例

{
    "Response": {
        "RequestId": "863b2797-858b-49f3-88e9-50159e564cbc",
        "TotalCount": 1,
        "SwitchLog": [
            {
                "EventId": "f39bc24b76d1c5d3ce60f0dcb9e0bd79",
                "SwitchType": 1,
                "StartTime": "2023-01-01 00:00:00",
                "EndTime": "2023-01-01 00:01:00",
                "Reason": "AUTO"
            }
        ]
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
InvalidParameter.InputIllegal 输入错误。
UnauthorizedOperation.PermissionDenied cam鉴权错误。