1. 接口描述
接口请求域名： dlc.tencentcloudapi.com 。
本接口用于更新数据引擎配置
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：UpdateDataEngine。 |
| Version | 是 | String | 公共参数，本接口取值：2021-01-25。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| Size | 是 | Integer | 资源大小 示例值：10 |
| MinClusters | 是 | Integer | 最小资源 示例值：1 |
| MaxClusters | 是 | Integer | 最大资源 示例值：10 |
| AutoResume | 是 | Boolean | 开启自动刷新：true：开启、false（默认）：关闭 示例值：true |
| DataEngineName | 是 | String | 数据引擎名称 示例值：testHouse |
| Message | 是 | String | 相关信息 示例值：xxx |
| AutoSuspend | 否 | Boolean | 是否自定挂起集群：false（默认）：不自动挂起、true：自动挂起 示例值：false |
| CrontabResumeSuspend | 否 | Integer | 定时启停集群策略：0（默认）：关闭定时策略、1：开启定时策略（注：定时启停策略与自动挂起策略互斥） 示例值：1 |
| CrontabResumeSuspendStrategy | 否 | CrontabResumeSuspendStrategy | 定时启停策略，复杂类型：包含启停时间、挂起集群策略 示例值：复杂类型 |
| MaxConcurrency | 否 | Integer | 单个集群最大并发任务数，默认5 示例值：5 |
| TolerableQueueTime | 否 | Integer | 可容忍的排队时间，默认0。当任务排队的时间超过可容忍的时间时可能会触发扩容。如果该参数为0，则表示一旦有任务排队就可能立即触发扩容。 示例值：0 |
| AutoSuspendTime | 否 | Integer | 集群自动挂起时间 示例值：10 |
| ElasticSwitch | 否 | Boolean | spark jar 包年包月集群是否开启弹性 示例值：false |
| ElasticLimit | 否 | Integer | spark jar 包年包月集群弹性上限 示例值：0 |
| SessionResourceTemplate | 否 | SessionResourceTemplate | Spark批作业集群Session资源配置模板 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 引擎变配
引擎变配
输入示例
POST / HTTP/1.1
Host: dlc.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: UpdateDataEngine
<公共请求参数>
{
"MaxClusters": 0,
"CrontabResumeSuspend": 0,
"AutoSuspend": true,
"CrontabResumeSuspendStrategy": {
"SuspendTime": "0",
"SuspendStrategy": 0,
"ResumeTime": "0"
},
"AutoResume": true,
"DataEngineName": "test",
"Message": "modify",
"MinClusters": 0,
"Size": 0
}输出示例
{
"Response": {
"RequestId": "xx-xxxx-xxx-xxxx"
}
}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.AnotherProcessRunning | 另一个操作正在处理中，请稍后再试。 |
| FailedOperation.AnotherRequestProcessing | 另一个请求正在处理中，请稍后再试。 |
| FailedOperation.BalanceNotEnough | 账户余额不足。 |
| FailedOperation.BillingSystemError | 计费系统异常。 |
| FailedOperation.DeliverGoodsFailed | 发货失败。 |
| FailedOperation.FeeDeductionFailed | 扣费失败。 |
| FailedOperation.GetProductInformationFailed | 获取商品信息失败。 |
| FailedOperation.ModifyInstanceFailed | 实例变配失败。 |
| FailedOperation.NumberExceedLimit | 采购数量超过限制。 |
| FailedOperation.ParameterValidationFailed | 参数校验失败。 |
| FailedOperation.RefundDepositFailed | 退押金失败。 |
| FailedOperation.TooManyResources | 资源数量超出限制。 |
| InternalError | 内部错误。 |
| InternalError.InternalSystemException | 业务系统异常，请重试或提工单联系我们。 |
| InvalidParameter | 参数错误。 |
| InvalidParameter.InstanceInProcess | 实例在其他流程中。 |
| InvalidParameter.InvalidDataEngineDescription | 无效的引擎描述信息。 |
| InvalidParameter.InvalidDataEngineMode | 无效的数据引擎模式。 |
| InvalidParameter.InvalidDataEngineName | 无效的数据引擎名。 |
| InvalidParameter.InvalidDataEngineSpecs | 无效的数据引擎规格。 |
| InvalidParameter.InvalidDefaultDataEngine | 无效的默认数据引擎参数。 |
| InvalidParameter.InvalidDescription | 无效的描述信息。 |
| InvalidParameter.InvalidMinClusters | 无效的最小集群数量。 |
| InvalidParameter.InvalidSQL | SQL解析失败。 |
| ResourceInUse.UnfinishedSQLs | 有SQL任务尚未执行完成。 |
| ResourceNotFound | 资源不存在。 |
| UnauthorizedOperation.ModifyComputingEngine | 子用户无权修改引擎配置。 |
| UnauthorizedOperation.NoPaymentAuthority | 没有支付权限。 |