获取Spark SQL批任务消耗

最近更新时间:2024-06-25 01:13:16

我的收藏

1. 接口描述

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

本接口(DescribeSparkSessionBatchSQLCost)用于查询Spark SQL批任务消耗

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeSparkSessionBatchSQLCost。
Version String 公共参数,本接口取值:2021-01-25。
Region String 公共参数,详见产品支持的 地域列表
BatchIds.N Array of String SparkSQL唯一标识
示例值:["d3018ad4-9a7e-4f64-a3f4-f38507c69742"]

3. 输出参数

参数名称 类型 描述
CostInfo Array of BatchSQLCostInfo 任务消耗
注意:此字段可能返回 null,表示取不到有效值。
示例值:[{"BatchId":"8925sdfxv-3-4499-8b41-1f5a213689f0","DataEngineName":"spark_jar","DataEngineId":"DataEngine-xxxx","Cost":0.7466666666666667,"TimeCost":193,"Operator":"100001244200"}]
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 获取SparkSQL批任务消耗

获取SparkSQL批任务消耗

输入示例

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

{
    "BatchIds": [
        "d3018ad4-9a7e-4f64-a3f4-fsjr37c69742"
    ]
}

输出示例

{
    "Response": {
        "CostInfo": [
            {
                "BatchId": "892499-8b41-1f5a213689f0",
                "DataEngineName": "engine_jar",
                "DataEngineId": "DataEngine-xxxx",
                "Cost": 0.7466666666666667,
                "TimeCost": 193,
                "Operator": "1000fsdf0"
            }
        ],
        "RequestId": "2ae4707a-9f72-sdfsd-sdf-cac3c2bc"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation 操作失败。
InternalError 内部错误。
InvalidParameter 参数错误。
InvalidParameter.InvalidSQL SQL解析失败。
ResourceNotFound 资源不存在。
ResourceNotFound.BatchSQLTaskNotFound 指定的交互式SQL任务不存在
ResourceNotFound.SessionStateShuttingDown Session正在关闭,请确认任务是否已经取消