查询任务消耗

最近更新时间:2024-09-16 01:38:34

我的收藏

1. 接口描述

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

该接口(DescribeTasksCostInfo)用于查询任务消耗

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeTasksCostInfo。
Version String 公共参数,本接口取值:2021-01-25。
Region String 公共参数,详见产品支持的 地域列表,本接口仅支持其中的: ap-beijing, ap-singapore 。
Filters.N Array of Filter 过滤条件,如下支持的过滤类型,传参Name应为以下其中一个,其中task-id支持最大50个过滤个数,其他过滤参数支持的总数不超过5个。
task-id - String - (任务ID准确过滤)task-id取值形如:e386471f-139a-4e59-877f-50ece8135b99。
task-state - String - (任务状态过滤)取值范围 0(初始化), 1(运行中), 2(成功), -1(失败)。
task-sql-keyword - String - (SQL语句关键字模糊过滤)取值形如:DROP TABLE。
task-operator- string (子uin过滤)
StartTime String 起始时间点,格式为yyyy-mm-dd HH:MM:SS。默认为45天前的当前时刻
示例值:2019-01-21 00:00:00
EndTime String 结束时间点,格式为yyyy-mm-dd HH:MM:SS时间跨度在(0,30天],支持最近45天数据查询。默认为当前时刻
示例值:2019-01-22 00:00:00
DataEngineName String 数据引擎名称,用于筛选
示例值:shared_presto
SearchAfter String 下一页的标识
示例值:上一次返回的searchafter值
PageSize Integer 每页的大小
示例值:10000

3. 输出参数

参数名称 类型 描述
SearchAfter String 下一页的标识
注意:此字段可能返回 null,表示取不到有效值。
示例值:[1716358571169]
Data String 返回的数据,字符串类型的二维数组,首行为列中文名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:[["任务ID","引擎具体类别","任务提交时间","引擎耗时(ms)","引擎名称","使用人","资源总使用情况(cu*ms)","资源拆分情况"],["81e3ca8f-b617-4141-934d-d90dbbf43293","SparkBatchSQL","1716358571169","0","test_hz","100000000000","36396","[{\"TaskId\":\"cbec28d8-4390-44d2-9c88-5ef777a92ecf\",\"TotalTime\":36396}]"]]
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询任务消耗

输入示例

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

{}

输出示例

{
    "Response": {
        "SearchAfter": "abc",
        "Data": "abc",
        "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. 错误码

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

错误码 描述
InternalError 内部错误。
InternalError.DBError 数据库错误。
InternalError.InternalSystemException 业务系统异常,请重试或提工单联系我们。
InvalidParameter 参数错误。
InvalidParameter.FiltersValuesNumberOutOfLimit 指定Filter.Values参数数量超限,当前应小于等于50个
InvalidParameter.InvalidFilterLength 过滤条件个数非法,当指定了过滤条件时,过滤条件的个数应该大于等于1个,且小于等于5个
InvalidParameter.InvalidTimeFormat 指定时间格式不合规,当前仅支持: YYYY-mm-dd HH:MM:SS
InvalidParameter.ParameterBase64DecodeFailed 指定参数Base64解析失败
InvalidParameter.ParameterNotFoundOrBeNone 找不到参数或参数为空
InvalidParameter.SQLTaskFiltersKeyTypeNotMath 指定的Filter.Key不匹配,当前仅支持: task-id/task-sql-keyword/task-kind/task-operator/batch-id/session-id/task-state
InvalidParameter.SQLTaskNotFound 指定的SQL任务不存在
InvalidParameter.SQLTaskSortByTypeNotMatch SQL任务指定SortBy类型不匹配,当前仅支持: create-time/data-amount/used-time/resource-usage
InvalidParameter.SparkJobNotFound 指定的Spark任务不存在
InvalidParameter.TaskStateTypeNotMath 指定的任务状态不匹配,当前仅支持: 0:初始化, 1:运行中, 2:成功, 3:数据写入中, 4:排队中, -1:失败, -3:删除
InvalidParameterValue 参数取值错误。
UnauthorizedOperation.UnauthorizedOperationCode_NoEngineCamPermissions 无引擎cam权限