tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

CreateSubscribe

Last updated: 2024-12-04 15:34:47

1. API Description

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

This API is used to create a data subscription task.

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: 2021-12-06.
Region Yes String Common Params. For more information, please see the list of regions supported by the product.
Product Yes String Subscription database type. Currently, cynosdbmysql, mariadb, mongodb, mysql, percona, tdpg, and tdsqlpercona are supported.
PayType Yes Integer Payment method. Valid values: 0 (monthly subscription); 1 (pay-as-you-go).
Duration No Integer Purchase duration. This field needs to be filled in when the payType is monthly subscription. The unit is month. Value range: 1-120. Default value: 1.
AutoRenew No Integer Whether to renew automatically. This field needs to be filled in when the payType is monthly subscription. Valid values: 0 (auto-renewal disabled); 1 (auto-renewal enabled). Automatic renewal is not performed by default. This flag is invalid for pay-as-you-go.
Count No Integer Quantity. Default value: 1. Maximum value: 10.
Tags.N No Array of TagItem Instance resource tags
Name No String Custom task name

3. Output Parameters

Parameter Name Type Description
SubscribeIds Array of String Array of data subscription instance IDs
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 a pay-as-you-go mysql subscription task

This example shows you how to create a pay-as-you-go mysql subscription task.

Input Example

POST / HTTP/1.1
Host: dts.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateSubscribe
<Common Request Parameters>

{
    "Product": "mysql",
    "PayType": 1,
    "Count": 1,
    "Tags": [
        {
            "TagKey": "abc",
            "TagValue": "abc"
        }
    ],
    "Name": "test-subscribe"
}

Output Example

{
    "Response": {
        "SubscribeIds": [
            "subs-b6x64o31tm"
        ],
        "RequestId": "xxxxxxxxxxxxxxx"
    }
}

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
AuthFailure The CAM signature/authentication information is incorrect.
AuthFailure.AuthFailureError Authentication failed.
FailedOperation Operation failed.
FailedOperation.FailedOperationError The operation failed.
FailedOperation.UserNotAuthed
InternalError An internal error occurred.
InternalError.InternalErrorError An internal error occurred.
InvalidParameter The parameter is incorrect.
InvalidParameter.InvalidParameterError The parameter is invalid.
InvalidParameterValue Invalid parameter value.
InvalidParameterValue.InvalidParameterValueError The parameter is invalid.
OperationDenied The operation was denied.
OperationDenied.NotEnoughMoneyError The account balance is insufficient.
OperationDenied.OperationDenied This operation cannot be performed.
OperationDenied.OperationDeniedError The operation was denied.
UnauthorizedOperation The operation is unauthorized.
UnauthorizedOperation.UnauthorizedOperationError The operation is unauthorized.
UnsupportedOperation The operation is not supported.
UnsupportedOperation.UnsupportedOperationError The operation is not supported.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy