tencent cloud

All product documents
APIs
DocumentationAPIsTencent Cloud WeDataTask Operations APIsGetInstanceLog
GetInstanceLog
Last updated: 2025-04-15 15:55:28
GetInstanceLog
Last updated: 2025-04-15 15:55:28

1. API Description

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

This API is used to obtain instance lists.

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: GetInstanceLog.
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. This API only supports: ap-singapore, eu-frankfurt, na-ashburn, na-siliconvalley.
ProjectId Yes String Project ID.
InstanceKey Yes String Unique identifier of an instance.
LifeRoundNum Yes Integer Lifecycle no.
ScheduleTimeZone No String Time zone.
Time zone. specifies the time zone. the default value is UTC+8.
BrokerIp No String Indicates the Ip address of the executor where the log is located.
OriginFileName No String Log file.
When executionJobId in instance details is empty but originFileName is not empty, originFileName and brokerIp must be included in the input parameters.
If both executionJobId and originFileName are empty, it indicates that the instance has not been dispatched for execution or has not generated logs. for example, branch node or merge node.
ExecutionJobId No String Execution ID.

When executionJobId in instance details is not empty, executionJobId needs to be included in the input parameters. originFileName and brokerIp are not required parameters.
LogLevel No String Log level.
Default All.

- Info
- Debug
- Warn
- Error
- All
StartLineNum No Integer Start row number for obtaining logs.
The default is 1.
EndLineCount No Integer End line number for obtaining logs.
The default value is 10000.

3. Output Parameters

Parameter Name Type Description
Data InstanceLogVO Scheduling instance details.
Note: This field may return null, indicating that no valid values 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 Example One

This example shows you how to retrieve log details.

Input Example

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

{
    "ProjectId": "1460947878944567296",
    "InstanceKey": "20250326150742906_2025-03-28 00:00:00",
    "LifeRoundNum": 0,
    "ScheduleTimeZone": "UTC+6",
    "BrokerIp": "ins-6m365yvb",
    "ExecutionJobId": "6820250328000318055",
    "LogLevel": "All",
    "StartLineNum": 1,
    "EndLineCount": 10000
}

Output Example

{
    "Response": {
        "Data": {
            "BrokerIp": "ins-6m365yvb",
            "CodeFileSize": "1 KB",
            "CodeInfo": "echo this is log demo;",
            "EndTime": "2025-03-27 22:18:59",
            "ExtInfo": "45308",
            "InstanceKey": "20250326150742906_2025-03-28 00:00:00",
            "InstanceState": 2,
            "IsEnd": true,
            "LineCount": 331,
            "LogFileSize": "1 KB",
            "LogInfo": "2025-03-28 00:18:37 this is log demo",
            "ProjectId": "1460947878944567296",
            "RunType": "PERIODIC",
            "StartTime": "2025-03-27 22:18:43"
        },
        "RequestId": "724045bb-9cad-44ff-8311-bf5c79f7bff0"
    }
}

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.
Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No

Feedback

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 available.

Submit a Ticket
7x24 Phone Support
Hong Kong, China
+852 800 906 020 (Toll Free)
United States
+1 844 606 0804 (Toll Free)
United Kingdom
+44 808 196 4551 (Toll Free)
Canada
+1 888 605 7930 (Toll Free)
Australia
+61 1300 986 386 (Toll Free)
EdgeOne hotline
+852 300 80699
More local hotlines coming soon