Tencent Cloud

Download PDF

CreateSubscribe

最后更新时间：2024-12-10 14:46:24

下载PDF

1. API Description

Domain name for API request: dts.intl.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.

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: CreateSubscribe.
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.
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)
Tags.N	No	Array of TagItem	Instance resource tags
Name	No	String	A custom instance name.

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, 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 data subscription instance

Input Example

https://dts.intl.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

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	An internal error occurred.
InternalError.InternalTradeError	Failed to call the billing service.
InvalidParameter	The parameter is incorrect.
OperationDenied	The operation was denied.
OperationDenied.OperationDenied	This operation cannot be performed.
OperationDenied.OperationDeniedError	The operation was denied.

tencent cloud

Recent Pages

CreateSubscribe

1. API Description

2. Input Parameters

3. Output Parameters

4. Example

Example1 Creating data subscription instance

Input Example

Output Example

5. Developer Resources

SDK

Command Line Interface

6. Error Code

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

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

tencent cloud

注册

登录

Recent Pages

CreateSubscribe

1. API Description

2. Input Parameters

3. Output Parameters

4. Example

Example1 Creating data subscription instance

Input Example

Output Example

5. Developer Resources

SDK

Command Line Interface

6. Error Code

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

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