1. 接口描述
接口请求域名： dts.tencentcloudapi.com 。
本接口(CreateSubscribe)用于创建一个数据订阅任务。
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：CreateSubscribe。 |
| Version | 是 | String | 公共参数，本接口取值：2021-12-06。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| Product | 是 | String | 订阅的数据库类型，目前支持 cynosdbmysql(tdsql-c mysql版),mariadb,mongodb,mysql,percona,tdpg(tdsql postgresql版),tdsqlpercona(tdsql mysql版) 示例值：mysql |
| PayType | 是 | Integer | 付费方式，枚举值：0-包年包月，1-按量计费 示例值：0 |
| Duration | 否 | Integer | 购买时长。当 payType 为包年包月时，该项需要填，单位为月，最小值为 1，最大值为 120。不填默认1 示例值：1 |
| AutoRenew | 否 | Integer | 是否自动续费。当 payType 为包年包月时，该项需要填。枚举值：0-不自动续费，1-自动续费。默认不自动续费。按量计费设置该标识无效。 示例值：0 |
| Count | 否 | Integer | 购买数量,默认为1，最大为10 示例值：1 |
| Tags.N | 否 | Array of TagItem | 实例资源标签 |
| Name | 否 | String | 任务名，自定义 示例值：test |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| SubscribeIds | Array of String | 数据订阅实例的ID数组 注意：此字段可能返回 null，表示取不到有效值。 示例值：["subs-b6x64o31tm"] |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 购买订阅任务
购买1个按量计费的mysql订阅任务
输入示例
POST / HTTP/1.1
Host: dts.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateSubscribe
<公共请求参数>
{
"Product": "mysql",
"PayType": 1,
"Count": 1,
"Tags": [
{
"TagKey": "abc",
"TagValue": "abc"
}
],
"Name": "test-subscribe"
}输出示例
{
"Response": {
"SubscribeIds": [
"subs-b6x64o31tm"
],
"RequestId": "xxxxxxxxxxxxxxx"
}
}5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| AuthFailure | CAM签名/鉴权错误。 |
| AuthFailure.AuthFailureError | 认证失败。 |
| FailedOperation | 操作失败。 |
| FailedOperation.FailedOperationError | 操作失败。 |
| FailedOperation.UserNotAuthed | 用户没有实名认证。 |
| InternalError | 内部错误。 |
| InternalError.InternalErrorError | 内部错误。 |
| InvalidParameter | 参数错误。 |
| InvalidParameter.InvalidParameterError | 参数无效。 |
| InvalidParameterValue | 参数取值错误。 |
| InvalidParameterValue.InvalidParameterValueError | 非法参数。 |
| OperationDenied | 操作被拒绝。 |
| OperationDenied.NotEnoughMoneyError | 用户余额不足。 |
| OperationDenied.OperationDenied | 该操作不能执行。 |
| OperationDenied.OperationDeniedError | 操作被拒绝。 |
| UnauthorizedOperation | 未授权操作。 |
| UnauthorizedOperation.UnauthorizedOperationError | 未授权的操作。 |
| UnsupportedOperation | 操作不支持。 |
| UnsupportedOperation.UnsupportedOperationError | 不支持的操作。 |
