tencent cloud

PrevNext

文档反馈

请输入关键字

Recent Pages

文档
文档

ActivateSubscribe

最后更新时间：2022-05-12 10:02:17

1. API Description

Domain name for API request: dts.tencentcloudapi.com.

This API is used to configure a data subscription, which can be called only for subscription instances in unconfigured status.

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: ActivateSubscribe.
Version Yes String Common Params. The value used for this API: 2018-03-30.
Region Yes String Common Params. For more information, please see the list of regions supported by the product.
SubscribeId Yes String Subscription instance ID.
InstanceId Yes String Database Instance ID
SubscribeObjectType Yes Integer Data subscription type. 0: full instance subscription, 1: data subscription, 2: structure subscription, 3: data subscription and structure subscription
Objects No SubscribeObject Subscription object
UniqSubnetId No String Subnet of data subscription service, which is the subnet of the database instance by default.
Vport No Integer Subscription service port. Default value: 7507

3. Output Parameters

Parameter Name Type Description
AsyncRequestId String Data subscription configuration task ID.
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Configuring data subscription

This example shows you how to configure data subscription.

Input Example

https://dts.tencentcloudapi.com/?Action=ActivateSubscribe
&SubscribeId=subs-ieuwi83j2e
&InstanceId=cdb-9dijwkkw2
&SubscribeObjectType=0
&<Common request parameters>

Output Example

{
  "Response": {
    "AsyncRequestId": "cafebabe-254f-11ea-8995-e92c139e6978",
    "RequestId": "9iu7ueht-c38f-11ea-84e5-d5a93c1b919b"
  }
}

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

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 An internal error occurred.
InternalError.DatabaseError Failed to access the database on the DTS platform.
InvalidParameter A parameter error occurred.
InvalidParameter.InstanceNotFound The instance does not exist.
OperationDenied Operation denied.
OperationDenied.BizOperationDeniedError The operation was denied as the condition was not met.
OperationDenied.OperationDenied This operation cannot be performed.
ResourceNotFound The resource does not exist.
UnsupportedOperation Unsupported operation
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
隐私条款服务条款缓存条款