1. 接口描述
接口请求域名： dts.tencentcloudapi.com 。
本接口(CreateSubscribe)用于创建一个数据订阅实例。
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：CreateSubscribe。 |
| Version | 是 | String | 公共参数，本接口取值：2018-03-30。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| Product | 是 | String | 订阅的数据库类型，目前支持的有 mysql 示例值：mysql |
| PayType | 是 | Integer | 实例付费类型，1小时计费，0包年包月 示例值：1 |
| Duration | 否 | Integer | 购买时长。PayType为0时必填。单位为月，最大支持120 示例值：120 |
| Count | 否 | Integer | 购买数量,默认为1，最大为10 示例值：1 |
| AutoRenew | 否 | Integer | 是否自动续费，0表示不自动续费，1表示自动续费，默认为0。小时计费实例设置该标识无效。 示例值：1 |
| Tags.N | 否 | Array of TagItem | 实例资源标签 |
| Name | 否 | String | 用户自定义实例名 示例值：user-defined-name |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| SubscribeIds | Array of String | 数据订阅实例的ID数组 注意：此字段可能返回 null，表示取不到有效值。 示例值：["subs-ieuwi83j2e"] |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 创建数据订阅实例
输入示例
https://dts.tencentcloudapi.com/?Action=CreateSubscribe
&Product=mysql
&PayType=1
&<公共请求参数>输出示例
{
"Response": {
"SubscribeIds": [
"subs-ieuwi83j2e"
],
"RequestId": "14a719b5-ffb34ab6-816c43c1-8c6a23eb"
}
}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. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| InternalError | 内部错误。 |
| InternalError.InternalTradeError | 调用计费服务失败。 |
| InvalidParameter | 参数错误。 |
| OperationDenied | 操作被拒绝。 |
| OperationDenied.OperationDenied | 该操作不能执行。 |
| OperationDenied.OperationDeniedError | 操作被拒绝。 |
