获取数据引擎详细信息

最近更新时间:2025-05-08 01:27:46

我的收藏

1. 接口描述

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

本接口根据名称用于获取数据引擎详细信息

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeDataEngine。
Version String 公共参数,本接口取值:2021-01-25。
Region String 公共参数,详见产品支持的 地域列表
DataEngineName String House名称
示例值:testHouse

3. 输出参数

参数名称 类型 描述
DataEngine DataEngineInfo 数据引擎详细信息
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 获取数据引擎详细信息

获取数据引擎详细信息

输入示例

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

{
    "DataEngineName": "dlc-spark"
}

输出示例

{
    "Response": {
        "DataEngine": {
            "AccessInfos": null,
            "AutoAuthorization": true,
            "AutoResume": false,
            "AutoSuspend": false,
            "AutoSuspendTime": 10,
            "ChildImageVersionId": "681fab43-a79c-42ec-9c7b-42917af33611",
            "CidrBlock": "10.0.0.0/16",
            "ClusterType": "spark_cu",
            "CreateTime": 1735872007,
            "CrontabResumeSuspend": 0,
            "CrontabResumeSuspendStrategy": {
                "ResumeTime": "",
                "SuspendStrategy": 0,
                "SuspendTime": ""
            },
            "DataEngineId": "DataEngine-houseid",
            "DataEngineName": "dlc-spark",
            "DefaultDataEngine": false,
            "DefaultHouse": false,
            "ElasticLimit": 0,
            "ElasticSwitch": false,
            "EngineExecType": "BATCH",
            "EngineGeneration": "Native",
            "EngineNetworkId": "DataEngine-Networkid",
            "EngineNetworkName": "",
            "EngineResourceGroupCount": 0,
            "EngineResourceUsedCU": 0,
            "EngineType": "spark",
            "EngineTypeDetail": "StandardSpark",
            "ExpireTime": "0",
            "GatewayId": "DataEngine-gatewayid",
            "GatewayState": 2,
            "ImageVersionId": "c3a40d9a-f5fe-40ac-9c17-16fed3fd2644",
            "ImageVersionName": "Standard-S 1.1",
            "IsAIEngine": 1,
            "IsAIGateway": true,
            "IsPoolMode": null,
            "IsSupportAI": false,
            "IsolatedTime": "0",
            "MaxClusters": 1,
            "MaxConcurrency": 5,
            "Message": "",
            "MinClusters": 1,
            "Mode": 1,
            "NetworkConnectionSet": [],
            "Permissions": [
                "USE",
                "MODIFY",
                "OPERATE",
                "MONITOR",
                "DELETE"
            ],
            "QuotaId": "",
            "RenewFlag": 0,
            "ResourceType": "Standard_CU",
            "ReversalTime": "0",
            "SessionResourceTemplate": {
                "DriverSize": "large",
                "ExecutorMaxNumbers": 3,
                "ExecutorNums": 3,
                "ExecutorSize": "large"
            },
            "Size": 16,
            "SpendAfter": 0,
            "StartStandbyCluster": false,
            "State": 2,
            "SubAccountUin": "1000****2040",
            "TagList": [],
            "TolerableQueueTime": 0,
            "UiURL": "-1",
            "UpdateTime": 1735872007,
            "UserAlias": "1000****2040",
            "UserAppId": "1301234123",
            "UserUin": "1000****7117"
        },
        "RequestId": "b040e00f-9f7f-46c1-a7aa-5e3382225d62"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
InternalError 内部错误。
InternalError.InternalSystemException 业务系统异常,请重试或提工单联系我们。
InvalidParameter 参数错误。
InvalidParameter.InvalidSQL SQL解析失败。
ResourceNotFound 资源不存在。
ResourceNotFound.DataEngineNotFound 指定的引擎不存在
UnauthorizedOperation.UnauthorizedOperationCode_NoEngineCamPermissions 无引擎cam权限