1. 接口描述
接口请求域名: dlc.tencentcloudapi.com 。
本接口(CheckDataEngineImageCanBeUpgrade)用于查看集群镜像是否能够升级。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:CheckDataEngineImageCanBeUpgrade。 |
Version | 是 | String | 公共参数,本接口取值:2021-01-25。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
DataEngineId | 是 | String | 集群id 示例值:DataEngine-1 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
ChildImageVersionId | String | 当前大版本下,可升级的集群镜像小版本id 示例值:d3ftghd4-9a7e-4f64-a3f4-f38507c69742 |
IsUpgrade | Boolean | 是否能够升级 示例值:true |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查看集群镜像是否能够升级
输入示例
POST / HTTP/1.1
Host: dlc.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CheckDataEngineImageCanBeUpgrade
<公共请求参数>
{
"DataEngineId": "DataEngine-1"
}
输出示例
{
"Response": {
"ChildImageVersionId": "d3ftghd4-9a7e-4f64-a3f4-f38507c69742",
"IsUpgrade": true,
"RequestId": "b8sd7dd7-ekd4-4e5e-993e-e5db64fa21c1"
}
}
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 | 操作失败。 |
InternalError | 内部错误。 |
InternalError.InternalSystemException | 业务系统异常,请重试或提工单联系我们。 |
InvalidParameter | 参数错误。 |
InvalidParameter.ImageEngineTypeNotMatch | 指定引擎类型不匹配,当前仅支持: SparkSQL, PrestoSQL, SparkBatch |
InvalidParameter.ImageIsPublicNotMatch | 指定isPublic不匹配,当前仅支持: 1:公共, 2:私有 |
InvalidParameter.ImageStateNotMatch | 指定state不匹配,当前仅支持: 1:初始化, 2:上线, 3:下线 |
InvalidParameter.ImageUserRecordsTypeNotMatch | 指定集群镜像UserRecords不匹配,当前仅支持: 1: parentVersion, 2: childVersion, 3: pySpark |
InvalidParameter.InvalidSQL | SQL解析失败。 |
InvalidParameter.ParameterNotFoundOrBeNone | 找不到参数或参数为空 |
ResourceNotFound | 资源不存在。 |
ResourceNotFound.DataEngineNotFound | 指定的引擎不存在 |
ResourceNotFound.DataEngineNotUnique | 指定的引擎已存在 |
ResourceNotFound.ImageVersionNotFound | 指定集群镜像版本不存在 |
UnauthorizedOperation.UnauthorizedOperationCode_NoEngineCamPermissions | 无引擎cam权限 |