tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeOperateOpsTasks

Last updated: 2024-06-24 16:58:41

1. API Description

Domain name for API request: wedata.tencentcloudapi.com.

Task Operation and Maintenance List Combined Condition Query

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name Required Type Description
Action Yes String Common Params. The value used for this API: DescribeOperateOpsTasks.
Version Yes String Common Params. The value used for this API: 2021-08-20.
Region Yes String Common Params. For more information, please see the list of regions supported by the product.
ProjectId Yes String Project ID
FolderIdList No String Folder ID, multiple folders separated by commas
WorkFlowIdList No String Workflow ID, multiple Workflow IDs separated by English commas
WorkFlowNameList No String Workflow name, multiple Workflow names separated by English commas
TaskNameList No String Task Name, multiple Task Names separated by English commas
TaskIdList No String Task ID, multiple Task IDs separated by English commas
PageNumber No String Page Number
PageSize No String Page size
SortItem No String Sort Fields, supported fields are FirstSubmitTime and FirstRunTime, indicating the most recent submission and the first execution event
SortType No String Sort Type. Two values DESC,ASC
InChargeList No String Person in Charge, multiple Persons in Charge separated by English commas
TaskTypeIdList No String Task Type ID String, multiple Task Type IDs separated by English commas
StatusList No String Task Status String, multiple Task Statuses separated by English commas
TaskCycleUnitList No String Task Cycle Type String, multiple Task Cycles separated by English commas
ProductNameList No String Task Belonging Product Type
SourceServiceId No String Data Source ID or (only for offline sync tasks) Source Data Source ID
SourceServiceType No String Data Source Type or (only for offline sync tasks) Source Data Source Type
TargetServiceId No String (Only for offline sync tasks) Target Data Source ID
TargetServiceType No String (Only for offline sync tasks) Target Data Source Type
AlarmType No String Alarm Type, multiple types separated by commas
ExecutorGroupIdList No String Resource Group ID, multiple Resource Group IDs separated by English commas
TaskTags.N No Array of TaskTag Task tag
KeyWord No String Query Keyword
InitStrategy No String Instance Generation Method
RequestResourceTypes.N No Array of String Additional Requested Resource Types

3. Output Parameters

Parameter Name Type Description
Data OpsTaskInfoPage Task List Information
RequestId String The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

4. Example

Example1 Failure Example

Failure Example

Input Example

POST / HTTP/1.1
Host: wedata.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeOperateOpsTasks
<Common request parameters>

{
    "ProjectId": "1470561602745229312"
}

Output Example

{
    "Response": {
        "Error": {
            "Code": "AuthFailure.SignatureFailure",
            "Message": "Request Signature Verification failed, please check if your Signature calculation is correct."
        },
        "RequestId": "2aa47359-f740-4c00-a91d-51820f08e30f"
    }
}

Example2 Task List Query

Task List Query

Input Example

POST / HTTP/1.1
Host: wedata.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeOperateOpsTasks
<Common request parameters>

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

Output Example

{
    "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": "Execute once every day at 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. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code Description
FailedOperation Operation Failure.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy