查询可更新配置的引擎列表

最近更新时间:2024-09-06 01:29:10

我的收藏

1. 接口描述

接口请求域名: dlc.tencentcloudapi.com 。

查询可更新配置的引擎列表

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeUpdatableDataEngines。
Version String 公共参数,本接口取值:2021-01-25。
Region String 公共参数,详见产品支持的 地域列表
DataEngineConfigCommand String 引擎配置操作命令,UpdateSparkSQLLakefsPath 更新托管表路径,UpdateSparkSQLResultPath 更新结果桶路径
示例值:UpdateSparkSQLLakefsPath
UseLakeFs Boolean 是否使用托管存储作为结果存储
示例值:false
CustomResultPath String 用户自定义结果存储路径
示例值:cosn://test-bucket/dir

3. 输出参数

参数名称 类型 描述
DataEngineBasicInfos Array of DataEngineBasicInfo 集群基础信息
示例值:[xxx]
TotalCount Integer 集群个数
示例值:1
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询需要更新结果桶集群配置的sparksql引擎

查询需要更新结果桶集群配置的sparksql引擎

输入示例

POST / HTTP/1.1
Host: dlc.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeUpdatableDataEngines
<公共请求参数>

{
    "DataEngineConfigCommand": "UpdateSparkSQLResultPath"
}

输出示例

{
    "Response": {
        "DataEngineBasicInfos": [
            {
                "DataEngineName": "abc",
                "State": 0,
                "CreateTime": 0,
                "UpdateTime": 0,
                "Message": "abc",
                "DataEngineId": "abc",
                "DataEngineType": "abc",
                "AppId": 0,
                "UserUin": "abc"
            }
        ],
        "TotalCount": 0,
        "RequestId": "abc"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
FailedOperation 操作失败。
InvalidParameter 参数错误。
InvalidParameter.InvalidDataEngineDescription 无效的引擎描述信息。
InvalidParameter.InvalidEngineExecType 引擎执行类型不合法
InvalidParameterValue 参数取值错误。
ResourceNotFound 资源不存在。