有奖捉虫:云通信与企业服务文档专题,速来> HOT

1. 接口描述

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

本接口(DescribePublishSubscribe)用于查询发布订阅关系列表。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribePublishSubscribe。
Version String 公共参数,本接口取值:2018-03-28。
Region String 公共参数,详见产品支持的 地域列表
InstanceId String 实例ID,形如mssql-j8kv137v
示例值:mssql-12klhrx2c
PubOrSubInstanceId String 订阅/发布实例ID,与InstanceId是发布实例还是订阅实例有关;当InstanceId为发布实例时,本字段按照订阅实例ID做筛选;当InstanceId为订阅实例时,本字段按照发布实例ID做筛选;
示例值:mssql-hh598yjo
PubOrSubInstanceIp String 订阅/发布实例内网IP,与InstanceId是发布实例还是订阅实例有关;当InstanceId为发布实例时,本字段按照订阅实例内网IP做筛选;当InstanceId为订阅实例时,本字段按照发布实例内网IP做筛选;
示例值:10.0.1.27
PublishSubscribeId Integer 订阅发布ID,用于筛选
示例值:5
PublishSubscribeName String 订阅发布名字,用于筛选
示例值:Change_name
PublishDBName String 发布库名字,用于筛选
示例值:PublishDBName
SubscribeDBName String 订阅库名字,用于筛选
示例值:SubscribeDBName
Offset Integer 分页,页数
示例值:0
Limit Integer 分页,页大小
示例值:10

3. 输出参数

参数名称 类型 描述
TotalCount Integer 总数
示例值:1
PublishSubscribeSet Array of PublishSubscribe 发布订阅列表
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询发布订阅列表

输入示例

https://sqlserver.tencentcloudapi.com/?Action=DescribePublishSubscribe
&InstanceId=mssql-12klhrx2c
&PubOrSubInstanceId=mssql-hh598yjo
&PubOrSubInstanceIp=10.0.1.27
&PublishSubscribeId=5
&PublishSubscribeName=Change_name
&Offset=0
&Limit=10
&<公共请求参数>

输出示例

{
    "Response": {
        "PublishSubscribeSet": [
            {
                "Id": 5,
                "Name": "Change_name",
                "PublishInstanceId": "mssql-12klhrx2c",
                "PublishInstanceName": "890d5f71-7e4d-493c-bbe8-22fcec655d50",
                "PublishInstanceIp": "192.168.0.7",
                "SubscribeInstanceId": "mssql-hh598yjo",
                "SubscribeInstanceName": "1957199f-f396-47b6-9716-dfae74161f10",
                "SubscribeInstanceIp": "10.0.1.27",
                "DatabaseTupleSet": [
                    {
                        "PublishDatabase": "test01",
                        "SubscribeDatabase": "test01",
                        "LastSyncTime": "2020-07-13 16:57:01",
                        "Status": "SyncNormal"
                    },
                    {
                        "PublishDatabase": "test02",
                        "SubscribeDatabase": "test02",
                        "LastSyncTime": "2020-07-13 16:57:01",
                        "Status": "SyncNormal"
                    }
                ]
            }
        ],
        "RequestId": "b1475330-2c4d-49a7-b063-f3e8b69d23ca",
        "TotalCount": 1
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation.GcsError 操作失败或者网络超时。
InternalError.DBError 数据库错误。
InternalError.GcsError GCS接口错误。
InternalError.SystemError 系统错误。
InvalidParameter.ParamsAssertFailed 参数断言转换错误。
InvalidParameterValue.PubSubNameIsIllegal 发布订阅名称不符合规范。
ResourceNotFound.InstanceNotFound 实例不存在。
UnauthorizedOperation.PermissionDenied cam鉴权错误。