查询DataEngines列表

最近更新时间:2024-09-13 01:28:57

我的收藏

1. 接口描述

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

本接口(DescribeDataEngines)用于查询DataEngines信息列表.

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeDataEngines。
Version String 公共参数,本接口取值:2021-01-25。
Region String 公共参数,详见产品支持的 地域列表
Offset Integer 偏移量,默认为0。
示例值:1
Filters.N Array of Filter 过滤类型,支持如下的过滤类型,传参Name应为以下其中一个, data-engine-name - String(数据引擎名称):engine-type - String(引擎类型:spark:spark 引擎,presto:presto引擎),state - String (数据引擎状态 -2已删除 -1失败 0初始化中 1挂起 2运行中 3准备删除 4删除中) , mode - String(计费模式 0共享模式 1按量计费 2包年包月) , create-time - String(创建时间,10位时间戳) message - String (描述信息),cluster-type - String (集群资源类型 spark_private/presto_private/presto_cu/spark_cu/kyuubi_cu),engine-id - String(数据引擎ID),key-word - String(数据引擎名称或集群资源类型或描述信息模糊搜索),engine-exec-type - String(引擎执行任务类型,SQL/BATCH),engine-network-id - String(引擎网络Id)
SortBy String 排序字段,支持如下字段类型,create-time
示例值:create-time
Sorting String 排序方式,desc表示正序,asc表示反序, 默认为asc。
示例值:desc
Limit Integer 返回数量,默认为10,最大值为100。
示例值:10
DatasourceConnectionName String 已废弃,请使用DatasourceConnectionNameSet
示例值:数据目录名称
ExcludePublicEngine Boolean 是否不返回共享引擎,true不返回共享引擎,false可以返回共享引擎
示例值:false
AccessTypes.N Array of String 参数应该为引擎权限类型,有效类型:"USE", "MODIFY", "OPERATE", "MONITOR", "DELETE"
示例值:[USE]
EngineExecType String 引擎执行任务类型,有效值:SQL/BATCH,默认为SQL
示例值:SQL
EngineType String 引擎类型,有效值:spark/presto/kyuubi,为空时默认获取非kyuubi引擎(网关引擎)
示例值:spark
DatasourceConnectionNameSet.N Array of String 网络配置列表,若传入该参数,则返回网络配置关联的计算引擎
EngineGeneration String 引擎版本,有效值:Native/SuperSQL,为空时默认获取SuperSQL引擎
示例值:Native
EngineTypeDetail String 引擎类型,支持:SparkSQL、SparkBatch、PrestoSQL、Kyuubi
示例值:SparkSQL

3. 输出参数

参数名称 类型 描述
DataEngines Array of DataEngineInfo 数据引擎列表
注意:此字段可能返回 null,表示取不到有效值。
TotalCount Integer 总条数
注意:此字段可能返回 null,表示取不到有效值。
示例值:100
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询DataEngines信息列表

查询DataEngines信息列表

输入示例

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

{
    "Offset": 0,
    "Filters": [
        {
            "Name": "abc",
            "Values": [
                "abc"
            ]
        }
    ],
    "SortBy": "abc",
    "Sorting": "abc",
    "Limit": 0,
    "DatasourceConnectionName": "abc",
    "ExcludePublicEngine": true,
    "AccessTypes": [
        "abc"
    ],
    "EngineExecType": "abc",
    "EngineType": "abc",
    "DatasourceConnectionNameSet": [
        "abc"
    ]
}

输出示例

{
    "Response": {
        "DataEngines": [
            {
                "DataEngineName": "abc",
                "QuotaId": "abc",
                "EngineType": "abc",
                "ClusterType": "abc",
                "State": 0,
                "CreateTime": 0,
                "UpdateTime": 0,
                "Size": 0,
                "Mode": 0,
                "MinClusters": 0,
                "MaxClusters": 0,
                "AutoResume": true,
                "SpendAfter": 0,
                "CidrBlock": "abc",
                "DefaultDataEngine": true,
                "Message": "abc",
                "DataEngineId": "abc",
                "SubAccountUin": "abc",
                "ExpireTime": "abc",
                "IsolatedTime": "abc",
                "ReversalTime": "abc",
                "UserAlias": "abc",
                "TagList": [
                    {
                        "TagKey": "abc",
                        "TagValue": "abc"
                    }
                ],
                "Permissions": [
                    "abc"
                ],
                "AutoSuspend": true,
                "CrontabResumeSuspend": 0,
                "CrontabResumeSuspendStrategy": {
                    "ResumeTime": "abc",
                    "SuspendTime": "abc",
                    "SuspendStrategy": 0
                },
                "EngineExecType": "abc",
                "RenewFlag": 0,
                "AutoSuspendTime": 0,
                "NetworkConnectionSet": [
                    {
                        "Id": 0,
                        "AssociateId": "abc",
                        "HouseId": "abc",
                        "DatasourceConnectionId": "abc",
                        "State": 0,
                        "CreateTime": 0,
                        "UpdateTime": 0,
                        "Appid": 0,
                        "HouseName": "abc",
                        "DatasourceConnectionName": "abc",
                        "NetworkConnectionType": 0,
                        "Uin": "abc",
                        "SubAccountUin": "abc",
                        "NetworkConnectionDesc": "abc",
                        "DatasourceConnectionVpcId": "abc",
                        "DatasourceConnectionSubnetId": "abc",
                        "DatasourceConnectionCidrBlock": "abc",
                        "DatasourceConnectionSubnetCidrBlock": "abc"
                    }
                ],
                "UiURL": "abc",
                "ResourceType": "abc",
                "ImageVersionId": "abc",
                "ChildImageVersionId": "abc",
                "ImageVersionName": "abc",
                "StartStandbyCluster": true,
                "ElasticSwitch": true,
                "ElasticLimit": 0,
                "DefaultHouse": true,
                "MaxConcurrency": 0,
                "TolerableQueueTime": 0,
                "UserAppId": 0,
                "UserUin": "abc",
                "SessionResourceTemplate": {
                    "DriverSize": "abc",
                    "ExecutorSize": "abc",
                    "ExecutorNums": 1,
                    "ExecutorMaxNumbers": 1
                }
            }
        ],
        "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.GetUserInfoFailed 获取用户信息失败,请重试或提工单联系我们
FailedOperation.HttpClientDoRequestFailed HTTP客户端请求失败。
InternalError 内部错误。
InternalError.InternalSystemException 业务系统异常,请重试或提工单联系我们。
InvalidParameter 参数错误。
InvalidParameter.DescribeDataEnginesSortByTypeNotMatch DescribeDataEnginesS Sort by type not match, only support create-time
InvalidParameter.InvalidSQL SQL解析失败。
ResourceNotFound 资源不存在。