tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Data Development and Governance Platform
    Documentation
    Download PDF

    DescribeEventConsumeTasks

    Last updated: 2024-06-21 15:10:33
    Download PDF

    1. API Description

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

    Viewing consumption tasks of event instances

    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: DescribeEventConsumeTasks.
    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.
    EventCaseId Yes String Event Instance ID
    PageNumber Yes Integer Page Number
    PageSize Yes Integer Number of items per page

    3. Output Parameters

    Parameter Name Type Description
    Data EventCaseConsumeLogOptDtoCollection Event Consumption Task Record List
    Note: This field may return null, indicating that no valid value can be obtained.
    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 Successfully obtained the event instance consumption task

    Successfully obtained the event instance consumption task

    Input Example

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

{
    "EventCaseId": "9e2a0e1f870ec340018712b3925f0006",
    "PageNumber": 1,
    "PageSize": 10
}

    Output Example

    {
    "Response": {
        "Data": {
            "Items": [
                {
                    "ConsumeLogId": "9eb04578870ec50d018712b3938d0005",
                    "ConsumerDetail": {
                        "Submit": true,
                        "TasksStr": "",
                        "BrokerIp": "any",
                        "ClusterId": null,
                        "CreateTime": "2023-03-24 16:09:14",
                        "Creator": "stackxchen",
                        "Crontab": null,
                        "CrontabExpression": null,
                        "CycleNum": null,
                        "CycleStep": 5,
                        "CycleType": "MINUTE_CYCLE",
                        "CycleUnit": null,
                        "DelayTime": 0,
                        "DependencyRel": "and",
                        "DependencyWorkflow": "no",
                        "EndDate": null,
                        "EndTime": "2023-03-24 23:59:59",
                        "EventListenerConfig": null,
                        "EventPublisherConfig": null,
                        "ExecutionEndTime": null,
                        "ExecutionStartTime": null,
                        "ExecutionTTL": -1,
                        "FirstRunTime": null,
                        "FirstSubmitTime": null,
                        "FolderId": null,
                        "FolderName": null,
                        "InCharge": "stackxchen",
                        "InChargeId": "100028590605",
                        "InitStrategy": null,
                        "InstanceInitStrategy": "T_PLUS_0",
                        "LastSchedulerCommitTime": null,
                        "LastUpdate": "2023-03-24 16:18:31",
                        "Layer": null,
                        "LeftCoordinate": 376,
                        "MaxDateTime": null,
                        "MinDateTime": null,
                        "NormalizedJobStartTime": null,
                        "Notes": "",
                        "OwnId": "100028448903",
                        "ProductName": "DATA_DEV",
                        "ProjectId": "1460963739345731584",
                        "ProjectIdent": "us_pre",
                        "ProjectName": "Scheduling Pre-release Validation Project",
                        "RealWorkflowId": null,
                        "ResourceGroup": "20221221143954438902",
                        "RetryAble": 1,
                        "RetryWait": 5,
                        "RunPriority": 6,
                        "ScheduleDesc": null,
                        "SchedulerDesc": "Starting from March 24, 2023, 00:00:00, execute every 5 minutes",
                        "SelfDepend": "parallel",
                        "ShowWorkflow": false,
                        "SourceServiceId": null,
                        "SourceServiceType": null,
                        "StartDate": null,
                        "StartTime": "2023-03-24 00:00:00",
                        "StartupTime": 0,
                        "Status": "Y",
                        "TargetServiceId": null,
                        "TargetServiceType": null,
                        "TaskAction": "",
                        "TaskId": "20230324160914089",
                        "TaskLinkInfo": null,
                        "TaskName": "test_event_minute",
                        "TaskType": {
                            "TypeDesc": "Shell",
                            "TypeId": 35,
                            "TypeSort": "Data Calculation"
                        },
                        "TaskTypeDesc": null,
                        "TaskTypeId": null,
                        "TenantId": "1315051789",
                        "TopCoordinate": 247,
                        "TryLimit": 5,
                        "UpdateTime": "2023-03-24 16:18:29",
                        "UpdateUser": "stackxchen",
                        "UpdateUserId": "100028590605",
                        "UserId": "100028590605",
                        "VirtualFlag": false,
                        "VirtualTaskId": null,
                        "VirtualTaskStatus": null,
                        "WorkflowId": "68ce6df0-7b80-11ed-a3a7-b8cef6c14251",
                        "WorkflowName": "dev_test",
                        "YarnQueue": null
                    },
                    "ConsumerId": "20230324160914089",
                    "CreationTimestamp": "2023-03-24T08:19:31.340Z",
                    "EventCaseId": "9e2a0e1f870ec340018712b3925f0006"
                }
            ],
            "PageCount": 1,
            "PageNumber": 1,
            "PageSize": 10,
            "TotalCount": 1,
            "TotalPage": 1
        },
        "RequestId": "b7d1e5cf-3454-48db-a261-41a760f70ee6"
    }
}

    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.
    Contact Us

    Contact our sales team or business advisors to help your business.

    Contact Us
    Technical Support

    Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

    Submit a Ticket
    7x24 Phone Support
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy