1. 接口描述
接口请求域名: dlc.tencentcloudapi.com 。
为用户创建数据引擎
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:CreateDataEngine。 |
Version | 是 | String | 公共参数,本接口取值:2021-01-25。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
EngineType | 是 | String | 引擎类型spark/presto 示例值:spark |
DataEngineName | 是 | String | 虚拟集群名称 示例值:test |
ClusterType | 是 | String | 集群类型 spark_private/presto_private/presto_cu/spark_cu 示例值:presto_cu/spark_cu |
Mode | 是 | Integer | 计费模式 0=共享模式 1=按量计费 2=包年包月 示例值:0 |
AutoResume | 是 | Boolean | 是否自动启动集群 示例值:true |
MinClusters | 否 | Integer | 最小资源 示例值:1 |
MaxClusters | 否 | Integer | 最大资源 示例值:10 |
CidrBlock | 否 | String | VPC网段 示例值:10.10.0.0/16 |
Message | 否 | String | 描述信息 示例值:test |
Size | 否 | Integer | 集群规模 示例值:64 |
PayMode | 否 | Integer | 计费类型,后付费:0,预付费:1。当前只支持后付费,不填默认为后付费。 示例值:0 |
TimeSpan | 否 | Integer | 资源使用时长,后付费:固定填3600,预付费:最少填1,代表购买资源一个月,最长不超过120。默认1 示例值:1 |
TimeUnit | 否 | String | 资源使用时长的单位,后付费:s,预付费:m。默认为s 示例值:s |
AutoRenew | 否 | Integer | 资源的自动续费标志。后付费无需续费,固定填0;预付费下:0表示手动续费、1代表自动续费、2代表不续费,在0下如果是大客户,会自动帮大客户续费。默认为0 示例值:0 |
Tags.N | 否 | Array of TagInfo | 创建资源的时候需要绑定的标签信息 |
AutoSuspend | 否 | Boolean | 是否自定挂起集群:false(默认):不自动挂起、true:自动挂起 示例值:false |
CrontabResumeSuspend | 否 | Integer | 定时启停集群策略:0(默认):关闭定时策略、1:开启定时策略(注:定时启停策略与自动挂起策略互斥) 示例值:1 |
CrontabResumeSuspendStrategy | 否 | CrontabResumeSuspendStrategy | 定时启停策略,复杂类型:包含启停时间、挂起集群策略 |
EngineExecType | 否 | String | 引擎执行任务类型,有效值:SQL/BATCH,默认为SQL 示例值:SQL/BATCH |
MaxConcurrency | 否 | Integer | 单个集群最大并发任务数,默认5 示例值:5 |
TolerableQueueTime | 否 | Integer | 可容忍的排队时间,默认0。当任务排队的时间超过可容忍的时间时可能会触发扩容。如果该参数为0,则表示一旦有任务排队就可能立即触发扩容。 示例值:0 |
AutoSuspendTime | 否 | Integer | 集群自动挂起时间,默认10分钟 示例值:10 |
ResourceType | 否 | String | 资源类型。Standard_CU:标准型;Memory_CU:内存型 示例值:Standard_CU |
DataEngineConfigPairs.N | 否 | Array of DataEngineConfigPair | 集群高级配置 |
ImageVersionName | 否 | String | 集群镜像版本名字。如SuperSQL-P 1.1;SuperSQL-S 3.2等,不传,默认创建最新镜像版本的集群 示例值:SuperSQL-P 1.1 |
MainClusterName | 否 | String | 主集群名称,创建容灾集群时指定 示例值:test |
ElasticSwitch | 否 | Boolean | spark jar 包年包月集群是否开启弹性 示例值:false |
ElasticLimit | 否 | Integer | spark jar 包年包月集群弹性上限 示例值:0 |
SessionResourceTemplate | 否 | SessionResourceTemplate | spark作业集群session资源配置模板 |
AutoAuthorization | 否 | Boolean | 自动授权 示例值:true |
EngineNetworkId | 否 | String | 引擎网络ID 示例值:DataEngine-Network-xxx |
EngineGeneration | 否 | String | 引擎世代,SuperSQL:代表supersql引擎,Native:代表标准引擎。默认值为SuperSQL 示例值:superSQL |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
DataEngineId | String | 虚拟引擎id 示例值:DataEngine-xxx |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 创建数据引擎
创建数据引擎
输入示例
POST / HTTP/1.1
Host: dlc.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateDataEngine
<公共请求参数>
{
"EngineType": "spark",
"DataEngineName": "test",
"ClusterType": "spark",
"MinClusters": 0,
"MaxClusters": 0,
"DefaultDataEngine": true,
"CidrBlock": "10.255.255.0/16",
"Mode": 0,
"Message": "test",
"AutoResume": true,
"Size": 0,
"PayMode": 0,
"TimeSpan": 1,
"TimeUnit": "h",
"AutoRenew": 0,
"Tags": [
{
"TagKey": "key",
"TagValue": "value"
}
],
"AutoSuspend": true,
"CrontabResumeSuspend": 0,
"CrontabResumeSuspendStrategy": {
"ResumeTime": "10",
"SuspendTime": "10",
"SuspendStrategy": 0
},
"EngineExecType": "BATCH",
"MaxConcurrency": 10,
"TolerableQueueTime": 5,
"AutoSuspendTime": 5,
"ResourceType": "spark_cu",
"ImageVersionName": "SuperSQL-P 1.1"
}
输出示例
{
"Response": {
"DataEngineId": "DataEngine-abc123",
"RequestId": "sd01m2-fasfki-231safas"
}
}
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. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
FailedOperation.AbnormalOrderStatus | 订单状态异常。 |
FailedOperation.AnotherCreateProcessRunning | 另一个数据源正在创建中。 |
FailedOperation.AnotherProcessRunning | 另一个操作正在处理中,请稍后再试。 |
FailedOperation.AnotherRequestProcessing | 另一个请求正在处理中,请稍后再试。 |
FailedOperation.BalanceNotEnough | 账户余额不足。 |
FailedOperation.BillingSystemError | 计费系统异常。 |
FailedOperation.BindTooManyTags | 绑定的标签数量超出限制。 |
FailedOperation.CreateDataEngineFailed | 创建引擎失败。 |
FailedOperation.DeliverGoodsFailed | 发货失败。 |
FailedOperation.DuplicateTagKey | 重复的标签键。 |
FailedOperation.FeeDeductionFailed | 扣费失败。 |
FailedOperation.GetProductInformationFailed | 获取商品信息失败。 |
FailedOperation.IllegalResource | 资源不符合规定。 |
FailedOperation.IllegalTagKey | 标签键含有非法字符。 |
FailedOperation.IllegalTagValue | 标签值含有非法字符。 |
FailedOperation.InquirePriceFailed | 询价失败。 |
FailedOperation.ModifyInstanceFailed | 实例变配失败。 |
FailedOperation.NoPermission | 没有操作权限。 |
FailedOperation.NoRealNameAuthentication | 账号未进行实名认证。 |
FailedOperation.NumberExceedLimit | 采购数量超过限制。 |
FailedOperation.ParameterValidationFailed | 参数校验失败。 |
FailedOperation.RefundDepositFailed | 退押金失败。 |
FailedOperation.TagAlreadyAttached | 资源已经绑定了同名标签键。 |
FailedOperation.TagKeyTooLong | 标签键长度超过限制。 |
FailedOperation.TagNotExist | 标签不存在。 |
FailedOperation.TagValueTooLong | 标签值长度超过限制。 |
FailedOperation.TooManyResources | 资源数量超出限制。 |
FailedOperation.TooManyTags | 标签数量超出限制。 |
InternalError | 内部错误。 |
InternalError.DBError | 数据库错误。 |
InvalidParameter.DataEngineModeNotMatch | 指定集群计费模式不匹配,当前仅支持: 1: 按量计费, 2: 包年包月 |
InvalidParameter.DataEngineSizeNotMatch | 指定集群规格不符合规范 |
InvalidParameter.DuplicateDataEngineName | 重复的引擎名称。 |
InvalidParameter.ImageParameterNotFound | 指定集群镜像参数不存在 |
InvalidParameter.InvalidDataEngineCidrFormat | 指定集群CIDR格式不匹配,参考样式: 192.0.2.1/24 |
InvalidParameter.InvalidDataEngineMode | 无效的数据引擎模式。 |
InvalidParameter.InvalidDataEngineName | 无效的数据引擎名。 |
InvalidParameter.InvalidDataEngineSpecs | 无效的数据引擎规格。 |
InvalidParameter.InvalidDataEngineTimeSpan | 指定集群资源使用时长,后付费:固定填3600,预付费:最少填1,代表购买资源一个月,最长不超过120。默认3600 |
InvalidParameter.InvalidDataEngineTimeUnit | 指定集群资源使用时长的单位不匹配,后付费:h,预付费:m。默认为h |
InvalidParameter.InvalidEngineType | 引擎类型不合法 |
InvalidParameter.InvalidPayMode | 无效的计费模式。 |
InvalidParameter.InvalidTimeSpan | 无效的计费时长。 |
InvalidParameter.InvalidTimeUnit | 无效的计费时长单位。 |
InvalidParameter.VpcCidrFormatError | Vpc cidr格式错误。 |
ResourceNotFound | 资源不存在。 |
ResourceNotFound.DataEngineNotUnique | 指定的引擎已存在 |
UnauthorizedOperation.NoPaymentAuthority | 没有支付权限。 |