Documentation

Recent Pages

CreateSubscribe

Last updated: 2020-07-31 10:04:08

1. API Description

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

This API is used to create a data subscription instance.

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

Note: This API supports Finance regions. If the common parameter Region is a Finance region, a domain name with the Finance region needs to be specified, for example: dts.ap-shanghai-fsi.tencentcloudapi.com

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 parameter. The value used for this API: CreateSubscribe.
Version	Yes	String	Common parameter. The value used for this API: 2018-03-30.
Region	Yes	String	Common parameter. 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-mumbai, ap-nanjing, ap-seoul, ap-shanghai, ap-shanghai-fsi, ap-shenzhen, ap-singapore, ap-tianjin, ap-tokyo, eu-frankfurt, eu-moscow, na-ashburn
Product	Yes	String	Subscribed database type. Currently, MySQL is supported
PayType	Yes	Integer	Instance billing mode, which is always 1 (hourly billing),
Duration	No	Integer	Purchase duration in months, which is required if `PayType` is 0. Maximum value: 120 (this field is not required of global site users and is better to be hidden)
Count	No	Integer	Quantity. Default value: 1. Maximum value: 10
AutoRenew	No	Integer	Whether to auto-renew. Default value: 0. This flag does not take effect for hourly billed instances (this field should be hidden from global site users)

3. Output Parameters

Parameter Name	Type	Description
SubscribeIds	Array of String	Data subscription instance ID array Note: this field may return null, indicating that no valid values can be obtained.
RequestId	String	The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Creating data subscription instance

Input Example

https://dts.tencentcloudapi.com/?Action=CreateSubscribe
&Product=mysql
&PayType=1
&<Common request parameters>

Output Example

{
  "Response": {
    "SubscribeIds": [
      "subs-ieuwi83j2e"
    ],
    "RequestId": "14a719b5-ffb34ab6-816c43c1-8c6a23eb"
  }
}

5. Developer Resources

API Explorer

This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.