CreatePublishSubscribe

下载PDF

最后更新时间：2025-10-28 22:49:00

CreatePublishSubscribe

最后更新时间： 2025-10-28 22:49:00

下载PDF

1. API Description

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

This API is used to create a publish/subscribe relationship between two databases. A subscriber cannot act as a publisher, and a publisher can have multiple subscriber instances.

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: CreatePublishSubscribe.
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.
PublishInstanceId	Yes	String	Publishing instance ID. For example, mssql-j8kv137v.
SubscribeInstanceId	Yes	String	Subscription instance ID. For example, mssql-j8kv137v.
DatabaseTupleSet.N	Yes	Array of DatabaseTuple	Publish/subscribe relationship collection of the database.
PublishSubscribeName	No	String	Publish/subscribe name. The default value is default_name.

3. Output Parameters

Parameter Name	Type	Description
FlowId	Integer	Process ID. The DescribeFlowStatus API can be used to query the status of the immediate switch upgrade task.
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 Creating Publish/Subscribe Relationships

Input Example

https://sqlserver.intl.tencentcloudapi.com/?Action=CreatePublishSubscribe
&PublishSubscribeName=Create_name
&PublishInstanceId=mssql-2cwisu23
&SubscribeInstanceId=mssql-hlh6yka1
&DatabaseTupleSet.0.PublishDatabase=db1
&DatabaseTupleSet.0.SubscribeDatabase=db1
&<Common request parameters>

Output Example

{
    "Response": {
        "FlowId": 1002591,
        "RequestId": "6353b539-bcd4-41fa-8d6a-98c94601f77d"
    }
}

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
InternalError.DBError	Database error
InternalError.SystemError	System error.
InvalidParameter.InputIllegal	Input error.
InvalidParameter.ParamsAssertFailed	An error occurred while converting parameter assertion.
InvalidParameterValue.DBExist	The database already exists.
ResourceNotFound.DBNotFound	The database does not exist.
ResourceNotFound.InstanceNotFound	The instance does not exist.
ResourceUnavailable.InstanceStatusInvalid	Invalid instance status.
UnauthorizedOperation.PermissionDenied	CAM authentication error.

本页内容是否解决了您的问题？

您也可以联系销售或提交工单以寻求帮助。

是

否

文档反馈

tencent cloud