DescribePublishSubscribe

Download PDF

Last updated: 2025-10-28 22:48:59

DescribePublishSubscribe

Last updated: 2025-10-28 22:48:59

Download PDF

1. API Description

Domain name for API request: sqlserver.intl.tencentcloudapi.com.

This API is used to query the publish/subscribe relationship list.

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer

Try it

API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name	Required	Type	Description
Action	Yes	String	Common Params. The value used for this API: DescribePublishSubscribe.
Version	Yes	String	Common Params. The value used for this API: 2018-03-28.
Region	Yes	String	Common Params. For more information, please see the list of regions supported by the product. This API only supports: ap-bangkok, ap-beijing, ap-chengdu, ap-chongqing, ap-guangzhou, ap-hongkong, ap-jakarta, ap-nanjing, ap-seoul, ap-shanghai, ap-shanghai-fsi, ap-shenzhen-fsi, ap-singapore, ap-tokyo, eu-frankfurt, na-ashburn, na-siliconvalley, sa-saopaulo.
InstanceId	Yes	String	Instance ID. For example, mssql-j8kv137v.
PubOrSubInstanceId	No	String	Publish/subscribe instance ID, which is related to whether InstanceId is a publishing instance or a subscription instance. When the value of InstanceId is a publishing instance, filtering by subscription instance ID is performed for this field. When the value of InstanceId is a subscription instance, filtering by publishing instance ID is performed for this field.
PubOrSubInstanceIp	No	String	Private address of the publish/subscribe instance, which is related to whether InstanceId is a publishing instance or a subscription instance. When the value of InstanceId is a publishing instance, filtering by private IP address of the subscription instance is performed for this field. When the value of InstanceId is a subscription instance, filtering by private IP address of the publishing instance is performed for this field.
PublishSubscribeId	No	Integer	Publish/subscribe ID, which is used for filtering.
PublishSubscribeName	No	String	Publish/subscribe name, which is used for filtering.
PublishDBName	No	String	Publishing database name, which is used for filtering.
SubscribeDBName	No	String	Subscription database name, which is used for filtering.
Offset	No	Integer	Pagination number.
Limit	No	Integer	Pagination size.

3. Output Parameters

Parameter Name	Type	Description
TotalCount	Integer	Total number.
PublishSubscribeSet	Array of PublishSubscribe	Publish/subscribe list.
RequestId	String	The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

4. Example

Example1 Querying the Publish/Subscribe Relationship List

Input Example

https://sqlserver.intl.tencentcloudapi.com/?Action=DescribePublishSubscribe
&InstanceId=mssql-12klhrx2c
&PubOrSubInstanceId=mssql-hh598yjo
&PubOrSubInstanceIp=10.0.1.27
&PublishSubscribeId=5
&PublishSubscribeName=Change_name
&Offset=0
&Limit=10
&<Common request parameters>

Output Example

{
    "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. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

Tencent Cloud CLI 3.0

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code	Description
FailedOperation.GcsError	The operation failed or the network timed out.
InternalError.DBError	Database error
InternalError.GcsError	GCS API error.
InternalError.SystemError	System error.
InvalidParameter.ParamsAssertFailed	An error occurred while converting parameter assertion.
InvalidParameterValue.PubSubNameIsIllegal	The publish/subscribe name does not meet the requirements.
ResourceNotFound.InstanceNotFound	The instance does not exist.
UnauthorizedOperation.PermissionDenied	CAM authentication error.

Was this page helpful?

You can also Contact Sales or Submit a Ticket for help.

Yes

Feedback

tencent cloud