tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Tencent Cloud WeData
    Documentation
    Download PDF

    DescribeScheduleInstances

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

    1. API Description

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

    Get Instance List

    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: DescribeScheduleInstances.
    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.
    Instances.N No Array of InstanceOpsDto Instance List
    CheckFather No Boolean Check Parent Task Type, true: Check parent task; false: Do not check parent task
    RerunType No String Rerun Type, 1: Self; 3: Child; 2: Self and Child
    DependentWay No String Instance Dependency Mode, 1: Self-dependent; 2: Task-dependent; 3: Self and Parent-Child dependent
    SkipEventListening No Boolean Rerun Ignore Event Listening or Not
    SonInstanceType No String Downstream Instance Range 1: Within the workflow 2: Within the project 3: Across all workflows dependent on the project
    SearchCondition No InstanceApiOpsRequest Query conditions
    OptType No String Access type
    OperatorName No String Operator Name
    OperatorId No String Operator ID
    ProjectId No String Project ID
    ProjectIdent No String Project Identifier
    ProjectName No String Project name
    PageIndex No Integer Index Page Number
    PageSize No Integer Page size
    Count No Integer Total Data
    RequestBaseInfo No ProjectBaseInfoOpsRequest Basic Request Information
    IsCount No Boolean Whether to Calculate Total

    3. Output Parameters

    Parameter Name Type Description
    Data CollectionInstanceOpsDto Instance Result Set
    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 Get Instance List Example

    Get Instance List

    Input Example

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

{
    "SearchCondition": {
        "Instance": {
            "ExecutionSpace": "CYCLIC",
            "ProductName": "DATA_DEV"
        }
    },
    "ProjectId": "1460947878944567296",
    "PageIndex": 1,
    "PageSize": 3
}

    Output Example

    {
    "Response": {
        "Data": {
            "Items": [
                {
                    "AvgCostTime": null,
                    "CostMillisecond": 0,
                    "CostTime": "00:00:00.000",
                    "CreateTime": "2023-03-15 15:15:42",
                    "CurRunDate": "2023-03-15 15:05:00",
                    "CycleType": "MINUTE_CYCLE",
                    "DependenceFulfillTime": null,
                    "DependencyRel": null,
                    "DoFlag": 2,
                    "EndTime": null,
                    "ErrorDesc": "This instance was manually terminated",
                    "ExecutionSpace": "CYCLIC",
                    "FirstDependenceFulfillTime": null,
                    "FirstRunTime": "2023-01-16 11:00:00",
                    "FirstStartTime": null,
                    "FirstSubmitTime": "2023-01-16 11:23:38",
                    "FolderId": "22866126-84c3-11ed-8909-bc97e105ba60",
                    "FolderName": "qminliu",
                    "IgnoreEvent": false,
                    "InCharge": "qminliu",
                    "LastLog": "Had been kill",
                    "LastSchedulerDateTime": null,
                    "LastUpdate": "2023-03-15 15:22:58",
                    "MaxCostTime": null,
                    "MinCostTime": null,
                    "NextCurDate": "2023-03-15 15:10:00",
                    "ProductName": "DATA_DEV",
                    "ProjectId": "1460947878944567296",
                    "ProjectIdent": null,
                    "ProjectName": null,
                    "RedoFlag": 0,
                    "ResourceGroup": "20221229154930684210",
                    "ResourceInstanceId": "any",
                    "RunPriority": 6,
                    "RuntimeBroker": null,
                    "SchedulerDateTime": "2023-03-15 15:05:00",
                    "SchedulerDesc": null,
                    "SonList": null,
                    "StartTime": null,
                    "State": "EXPIRED",
                    "TaskId": "20230101114142907",
                    "TaskName": "retry_hive",
                    "TotalRunNum": 2,
                    "InstanceKey": "your InstanceKey",
                    "TaskType": {
                        "TypeDesc": "Hive SQL",
                        "TypeId": 34,
                        "TypeSort": "Data Calculation"
                    },
                    "TenantId": "1315051789",
                    "Tries": 0,
                    "TryLimit": 5,
                    "VirtualFlag": null,
                    "WorkflowId": "332e31f8-84c3-11ed-8909-bc97e105ba60",
                    "WorkflowName": "up",
                    "YarnQueue": "root.dev"
                },
                {
                    "AvgCostTime": null,
                    "CostMillisecond": 0,
                    "CostTime": "00:00:00.000",
                    "CreateTime": "2023-03-15 15:15:40",
                    "CurRunDate": "2023-03-15 15:00:00",
                    "CycleType": "MINUTE_CYCLE",
                    "DependenceFulfillTime": null,
                    "DependencyRel": null,
                    "DoFlag": 2,
                    "EndTime": null,
                    "ErrorDesc": "This instance was manually terminated",
                    "ExecutionSpace": "CYCLIC",
                    "FirstDependenceFulfillTime": null,
                    "FirstRunTime": "2023-01-16 11:00:00",
                    "FirstStartTime": null,
                    "FirstSubmitTime": "2023-01-16 11:23:38",
                    "FolderId": "22866126-84c3-11ed-8909-bc97e105ba60",
                    "FolderName": "qminliu",
                    "IgnoreEvent": false,
                    "InCharge": "qminliu",
                    "LastLog": "Had been kill",
                    "LastSchedulerDateTime": null,
                    "LastUpdate": "2023-03-15 15:22:58",
                    "MaxCostTime": null,
                    "MinCostTime": null,
                    "NextCurDate": "2023-03-15 15:05:00",
                    "ProductName": "DATA_DEV",
                    "ProjectId": "1460947878944567296",
                    "ProjectIdent": null,
                    "ProjectName": null,
                    "RedoFlag": 0,
                    "ResourceGroup": "20221229154930684210",
                    "ResourceInstanceId": "any",
                    "RunPriority": 6,
                    "RuntimeBroker": null,
                    "SchedulerDateTime": "2023-03-15 15:00:00",
                    "SchedulerDesc": null,
                    "SonList": null,
                    "StartTime": null,
                    "State": "EXPIRED",
                    "TaskId": "20230101114142907",
                    "TaskName": "retry_hive",
                    "TotalRunNum": 2,
                    "InstanceKey": "your InstanceKey",
                    "TaskType": {
                        "TypeDesc": "Hive SQL",
                        "TypeId": 34,
                        "TypeSort": "Data Calculation"
                    },
                    "TenantId": "1315051789",
                    "Tries": 0,
                    "TryLimit": 5,
                    "VirtualFlag": null,
                    "WorkflowId": "332e31f8-84c3-11ed-8909-bc97e105ba60",
                    "WorkflowName": "up",
                    "YarnQueue": "root.dev"
                },
                {
                    "AvgCostTime": null,
                    "CostMillisecond": 0,
                    "CostTime": "00:00:00.000",
                    "CreateTime": "2023-03-15 15:15:38",
                    "CurRunDate": "2023-03-15 14:55:00",
                    "CycleType": "MINUTE_CYCLE",
                    "DependenceFulfillTime": null,
                    "DependencyRel": null,
                    "DoFlag": 2,
                    "EndTime": null,
                    "ErrorDesc": "This instance was manually terminated",
                    "ExecutionSpace": "CYCLIC",
                    "FirstDependenceFulfillTime": null,
                    "FirstRunTime": "2023-01-16 11:00:00",
                    "FirstStartTime": null,
                    "FirstSubmitTime": "2023-01-16 11:23:38",
                    "FolderId": "22866126-84c3-11ed-8909-bc97e105ba60",
                    "FolderName": "qminliu",
                    "IgnoreEvent": false,
                    "InCharge": "qminliu",
                    "LastLog": "Had been kill",
                    "LastSchedulerDateTime": null,
                    "LastUpdate": "2023-03-15 15:22:58",
                    "MaxCostTime": null,
                    "MinCostTime": null,
                    "NextCurDate": "2023-03-15 15:00:00",
                    "ProductName": "DATA_DEV",
                    "ProjectId": "1460947878944567296",
                    "ProjectIdent": null,
                    "ProjectName": null,
                    "RedoFlag": 0,
                    "ResourceGroup": "20221229154930684210",
                    "ResourceInstanceId": "any",
                    "RunPriority": 6,
                    "RuntimeBroker": null,
                    "SchedulerDateTime": "2023-03-15 14:55:00",
                    "SchedulerDesc": null,
                    "SonList": null,
                    "StartTime": null,
                    "State": "EXPIRED",
                    "TaskId": "20230101114142907",
                    "TaskName": "retry_hive",
                    "TotalRunNum": 2,
                    "InstanceKey": "your InstanceKey",
                    "TaskType": {
                        "TypeDesc": "Hive SQL",
                        "TypeId": 34,
                        "TypeSort": "Data Calculation"
                    },
                    "TenantId": "1315051789",
                    "Tries": 0,
                    "TryLimit": 5,
                    "VirtualFlag": null,
                    "WorkflowId": "332e31f8-84c3-11ed-8909-bc97e105ba60",
                    "WorkflowName": "up",
                    "YarnQueue": "root.dev"
                }
            ],
            "PageCount": 3,
            "PageNumber": 1,
            "PageSize": 3,
            "TotalCount": 876,
            "TotalPage": 292
        },
        "RequestId": "20805432-23c1-4c0c-9ae1-a622522034d1"
    }
}

    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