智能运维-任务运维列表组合条件查询

最近更新时间：2024-04-16 17:51:18

我的收藏

本页目录：

1. 接口描述

接口请求域名： wedata.tencentcloudapi.com 。

任务运维列表组合条件查询

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeOperateOpsTasks。
Version	是	String	公共参数，本接口取值：2021-08-20。
Region	是	String	公共参数，详见产品支持的地域列表。
ProjectId	是	String	项目id 示例值：1
FolderIdList	否	String	文件夹id，多个文件夹以逗号分隔示例值："11,2222"
WorkFlowIdList	否	String	工作流id，多个工作流id之间以英文字符逗号分隔示例值："111,222"
WorkFlowNameList	否	String	工作流名称，多个工作流名称之间以英文字符逗号分隔示例值："111,222"
TaskNameList	否	String	任务名称，多个任务名称之间以英文字符逗号分隔示例值："111,222"
TaskIdList	否	String	任务id，多个任务id之间以英文字符逗号分隔示例值："111,222"
PageNumber	否	String	页号示例值：1
PageSize	否	String	分页大小示例值：15
SortItem	否	String	排序字段，支持字段为FirstSubmitTime和FirstRunTime，标识最近提交和首次执行事件示例值：LastUpdate
SortType	否	String	排序类型。两种取值 DESC、ASC 示例值：DESC
InChargeList	否	String	责任人，多个责任人之间以英文字符逗号分隔示例值："111,222"
TaskTypeIdList	否	String	任务类型Id字符串，多个任务类型id之间以英文字符逗号分隔示例值："34,35"
StatusList	否	String	任务状态字符串，多个任务状态之间以英文字符逗号分隔示例值："INVALID,Y"
TaskCycleUnitList	否	String	任务周期类型字符串，多个任务周期之间以英文字符逗号分隔示例值："H,D"
ProductNameList	否	String	任务所属产品类型示例值："dev"
SourceServiceId	否	String	数据源id或（仅针对离线同步任务）来源数据源id 示例值："111"
SourceServiceType	否	String	数据源类型或（仅针对离线同步任务）来源数据源类型示例值："mysql"
TargetServiceId	否	String	（仅针对离线同步任务）目标数据源id 示例值："111"
TargetServiceType	否	String	（仅针对离线同步任务）目标数据源类型示例值："mysql"
AlarmType	否	String	告警类型，多个类型以逗号分隔示例值："failure"
ExecutorGroupIdList	否	String	资源组id,多个资源组id之间以英文字符逗号分隔示例值：1
TaskTags.N	否	Array of TaskTag	任务标签示例值：自测
KeyWord	否	String	查询关键字示例值：test

3. 输出参数

参数名称	类型	描述
Data	OpsTaskInfoPage	任务列表信息
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 失败示例

失败示例

输入示例

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

{
    "ProjectId": "1470561602745229312"
}

输出示例

{
    "Response": {
        "Error": {
            "Code": "AuthFailure.SignatureFailure",
            "Message": "请求签名验证失败，请检查您的签名计算是否正确。"
        },
        "RequestId": "2aa47359-f740-4c00-a91d-51820f08e30f"
    }
}

示例2 任务列表查询

任务列表查询

输入示例

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

{
    "WorkFlowIdList": "1282d8d2-68e0-11ee-8d13-a411120f8272",
    "TaskIdList": "20231220103934257",
    "ProjectId": "1531609696110365952"
}

输出示例

{
    "Response": {
        "Data": {
            "Items": [
                {
                    "BrokerIp": null,
                    "ClusterId": null,
                    "CreateTime": "2023-12-20 20:40:59",
                    "Creator": "MaksimGuo",
                    "Crontab": null,
                    "CrontabExpression": null,
                    "CycleNum": 1,
                    "CycleStep": null,
                    "CycleType": null,
                    "CycleUnit": "D",
                    "DelayTime": 0,
                    "DependencyRel": null,
                    "DependencyWorkflow": null,
                    "EndDate": "2099-12-31 23:59:59",
                    "EndTime": null,
                    "EventListenerConfig": null,
                    "EventPublisherConfig": null,
                    "ExecutionEndTime": null,
                    "ExecutionStartTime": null,
                    "ExecutionTTL": -1,
                    "ExecutorGroupId": null,
                    "ExecutorGroupName": null,
                    "FirstRunTime": "2023-10-12 17:18:45",
                    "FirstSubmitTime": "2023-12-21 21:06:36",
                    "FolderId": "0ab0ffbd-68e0-11ee-8d13-a4ae120f8272",
                    "FolderName": "jianweisong",
                    "InCharge": "MaksimGuo",
                    "InChargeId": null,
                    "InitStrategy": "T+0",
                    "InstanceInitStrategy": null,
                    "LastSchedulerCommitTime": "2023-12-21 21:06:36",
                    "LastUpdate": null,
                    "Layer": null,
                    "LeftCoordinate": 367,
                    "MaxDateTime": null,
                    "MinDateTime": null,
                    "NormalizedJobStartTime": null,
                    "Notes": null,
                    "OwnId": null,
                    "ProductName": null,
                    "ProjectId": "1531609696090365952",
                    "ProjectIdent": "project_wedata",
                    "ProjectName": "project_wedata",
                    "RealWorkflowId": null,
                    "ResourceGroup": null,
                    "RetryAble": 1,
                    "RetryWait": 5,
                    "RunPriority": 6,
                    "ScheduleDesc": "每天00:00执行一次",
                    "SchedulerDesc": null,
                    "SelfDepend": "serial",
                    "ShowWorkflow": false,
                    "SourceServiceId": null,
                    "SourceServiceType": null,
                    "StartDate": "2023-10-12 17:18:45",
                    "StartTime": null,
                    "StartupTime": null,
                    "Status": "F",
                    "TargetServiceId": null,
                    "TargetServiceType": null,
                    "TaskAction": "",
                    "TaskId": "20231220203934257",
                    "TaskLinkInfo": null,
                    "TaskName": "1111asdasdadsd",
                    "TaskType": null,
                    "TaskTypeDesc": "MapReduce",
                    "TaskTypeId": 92,
                    "TenantId": "1315051789",
                    "TopCoordinate": 227,
                    "TryLimit": 5,
                    "UpdateTime": null,
                    "UpdateUser": "MaksimGuo",
                    "UpdateUserId": "100029483142",
                    "UserId": "100029483142",
                    "VirtualFlag": false,
                    "VirtualTaskId": null,
                    "VirtualTaskStatus": null,
                    "WorkflowId": "1282d8d2-68e0-11ee-8d13-a4ae120f8272",
                    "WorkflowName": "1002",
                    "YarnQueue": null,
                    "TasksStr": "testss",
                    "Submit": true
                }
            ],
            "PageCount": 1,
            "PageNumber": 1,
            "PageSize": 10,
            "TotalCount": 1,
            "TotalPage": 1
        },
        "RequestId": "ce9d691e-47fc-4378-92db-3fa248e84166"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

Tencent Cloud SDK 3.0 for Python: GitHub Gitee
Tencent Cloud SDK 3.0 for Java: GitHub Gitee
Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
Tencent Cloud SDK 3.0 for Go: GitHub Gitee
Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
Tencent Cloud SDK 3.0 for C++: GitHub Gitee
Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

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

错误码	描述
FailedOperation	操作失败。

上一篇: 根据层级查找上-下游任务节点下一篇: 获取任务全部下游（开发态）