ListInstances
Last updated:2025-11-13 20:55:25
ListInstances
Last updated: 2025-11-13 20:55:25
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: ListInstances. |
| 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. |
| ScheduleTimeFrom | Yes | String | Filter criteria for instance planned scheduling time. Specifies the start time for filtering. the time format is yyyy-MM-dd HH:MM:ss. |
| ScheduleTimeTo | Yes | String | Filter criteria for instance planned scheduling time. Filter expiration time. the time format is yyyy-MM-dd HH:MM:ss. |
| PageNumber | No | Integer | Page number, integer. Use in conjunction with pageSize and cannot be less than 1. the default value is 1. |
| PageSize | No | Integer | Number of items per page, integer. Use in conjunction with pageNumber and should not exceed 200. default value: 10. |
| SortColumn | No | String | Sorting field for query results. -SCHEDULE_DATE indicates sorting based on the planned scheduling time. -START_TIME indicates sorting by the instance's start execution time. -END_TIME indicates sorting based on the instance execution end time. -COST_TIME indicates sorting based on instance execution duration. |
| SortType | No | String | Instance sorting order. - ASC - DESC |
| InstanceType | No | Integer | Instance type. -0 indicates Replenished Instance. -1 indicates Periodic Instance. -2 indicates Non-Periodic instance. |
| InstanceStateList.N | No | Array of Integer | Instance execution status. Support filtering multiple items with an "or" relationship between conditions. -[0] Indicates waiting for event. -[12] indicates waiting for upstream. -[6, 7, 9, 10, 18] indicates awaiting execution. -[1, 19, 22] indicate running. -[21] indicates skipping running. -[3] indicates retry on failure. -[8, 4, 5, 13] indicates a failure. -[2] indicates a success. |
| TaskTypeIdList.N | No | Array of Integer | Task type Id specifies the identifier for the task type. -Supports filtering multiple items with an or relationship between conditions. -You can use the DescribeAllTaskType API to obtain all task types supported by the project. |
| TaskCycleList.N | No | Array of String | Task cycle type. Supports filtering multiple conditions with an or relationship between them. * O: ONEOFF_CYCLE * Y: YEAR_CYCLE * M: MONTH_CYCLE * W: WEEK_CYCLE * D: DAY_CYCLE * H: HOUR_CYCLE * I: MINUTE_CYCLE * C: CRONTAB_CYCLE |
| Keyword | No | String | Task name or task ID. Supports fuzzy search filtering. multiple items are separated by english commas. |
| InChargeList.N | No | Array of String | Task owner. Support filtering multiple items with an or relationship between conditions. |
| TaskFolderIdList.N | No | Array of String | File to which the task belongs. Supports filtering multiple conditions with an or relationship between them. The FindAllFolder API can be used to obtain the folder list under a project. |
| WorkflowIdList.N | No | Array of String | Associated workflow of the task. Supports filtering multiple conditions with an or relationship between them. The workflow list under a project can be obtained through the DescribeOpsWorkflows api. |
| ExecutorGroupIdList.N | No | Array of String | Execution resource group Id. Supports filtering multiple conditions with an or relationship between them. The scheduling resource group list under the project can be obtained through the DescribeNormalSchedulerExecutorGroups api. The DescribeNormalIntegrationExecutorGroups API can be used to obtain the list of all integration resource groups under a project. |
| StartTimeFrom | No | String | Instance execution start time filter criteria. Specifies the start time for filtering. the time format is yyyy-MM-dd HH:MM:ss. |
| StartTimeTo | No | String | Instance execution start time filter criteria. Filter expiration time. the time format is yyyy-MM-dd HH:MM:ss. |
| ScheduleTimeZone | No | String | Time zone. Time zone. specifies the time zone. the default value is UTC+8. |
3. Output Parameters
| Parameter Name | Type | Description |
|---|---|---|
| Data | InstancePageVO | 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 Example One
This example shows you how to query instance list.
Input Example
POST / HTTP/1.1
Host: wedata.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ListInstances
<Common request parameters>
{
"ProjectId": "1460947878944567296",
"ScheduleTimeFrom": "2025-03-28 00:00:00",
"ScheduleTimeTo": "2025-03-28 23:59:59",
"PageNumber": 1,
"PageSize": 10,
"SortColumn": "START_TIME",
"SortType": "ASC",
"InstanceType": 1,
"InstanceStateList": [
2,
8
],
"TaskTypeIdList": [
35
],
"TaskCycleList": [
"D",
"H",
"I"
],
Keyword: dq_test_dylan_shell_01, block cross-time-zone dependency 1_UTC_PLUS_8
"InChargeList": [
"dylandlwu",
"hongdianlin"
],
"TaskFolderIdList": [
"2493fc25-643d-11ef-8ec8-b8599f277de5",
"d56ffd9e-e916-11ef-8ec8-b8599f277de5"
],
"WorkflowIdList": [
"14f315e6-4994-41dd-8a55-529c3bfa01cd",
"ec66594e-53a0-48cb-8044-a9eb3a58efe5"
],
"ExecutorGroupIdList": [
"20240222212719833743"
],
"StartTimeFrom": "2025-03-27 00:00:00",
"StartTimeTo": "2025-03-28 23:59:59",
"ScheduleTimeZone": "UTC+8"
}Output Example
{
"Response": {
"Data": {
"Items": [
{
"CostTime": "00:00:12.000",
"CurRunDate": "2025-03-28 00:00:00",
"EndTime": "2025-03-28 00:18:55",
"ExecutorGroupId": "20240222212719833743",
"ExecutorGroupName": "qfh_test",
"FolderId": "2493fc25-643d-11ef-8ec8-b8599f277de5",
"FolderName": "dylandlwu",
"InChargeList": [
"dylandlwu"
],
"InstanceKey": "20250326150742906_2025-03-28 00:00:00",
"InstanceState": 2,
"InstanceType": null,
"ProjectId": "1460947878944567296",
"SchedulerTime": "2025-03-28 00:00:00",
"StartTime": "2025-03-28 00:18:43",
"TaskCycleType": "I",
"TaskId": "20250326150742906",
"TaskName": "dq_test_dylan_shell_01",
"TaskType": {
"TypeDesc": "Shell",
"TypeId": 35,
TypeSort: Data computing
},
"TotalRunNum": 1,
"Tries": 1,
"TryLimit": 5,
"WorkflowId": "ec66594e-53a0-48cb-8044-a9eb3a58efe5",
"WorkflowName": "dq_test_0326"
},
{
"CostTime": "00:00:23.000",
"CurRunDate": "2025-03-28 00:20:00",
"EndTime": "2025-03-28 00:21:09",
"ExecutorGroupId": "20240222212719833743",
"ExecutorGroupName": "qfh_test",
"FolderId": "2493fc25-643d-11ef-8ec8-b8599f277de5",
"FolderName": "dylandlwu",
"InChargeList": [
"dylandlwu"
],
"InstanceKey": "20250326150742906_2025-03-28 00:20:00",
"InstanceState": 2,
"InstanceType": null,
"ProjectId": "1460947878944567296",
"SchedulerTime": "2025-03-28 00:20:00",
"StartTime": "2025-03-28 00:20:46",
"TaskCycleType": "I",
"TaskId": "20250326150742906",
"TaskName": "dq_test_dylan_shell_01",
"TaskType": {
"TypeDesc": "Shell",
"TypeId": 35,
TypeSort: data computing
},
"TotalRunNum": 1,
"Tries": 1,
"TryLimit": 5,
"WorkflowId": "ec66594e-53a0-48cb-8044-a9eb3a58efe5",
"WorkflowName": "dq_test_0326"
},
{
"CostTime": "00:00:09.000",
"CurRunDate": "2025-03-28 00:40:00",
"EndTime": "2025-03-28 00:40:30",
"ExecutorGroupId": "20240222212719833743",
"ExecutorGroupName": "qfh_test",
"FolderId": "2493fc25-643d-11ef-8ec8-b8599f277de5",
"FolderName": "dylandlwu",
"InChargeList": [
"dylandlwu"
],
"InstanceKey": "20250326150742906_2025-03-28 00:40:00",
"InstanceState": 2,
"InstanceType": null,
"ProjectId": "1460947878944567296",
"SchedulerTime": "2025-03-28 00:40:00",
"StartTime": "2025-03-28 00:40:21",
"TaskCycleType": "I",
"TaskId": "20250326150742906",
"TaskName": "dq_test_dylan_shell_01",
"TaskType": {
"TypeDesc": "Shell",
"TypeId": 35,
TypeSort: Data computing
},
"TotalRunNum": 1,
"Tries": 1,
"TryLimit": 5,
"WorkflowId": "ec66594e-53a0-48cb-8044-a9eb3a58efe5",
"WorkflowName": "dq_test_0326"
},
{
"CostTime": "00:00:09.000",
"CurRunDate": "2025-03-28 01:00:00",
"EndTime": "2025-03-28 01:12:16",
"ExecutorGroupId": "20240222212719833743",
"ExecutorGroupName": "qfh_test",
"FolderId": "2493fc25-643d-11ef-8ec8-b8599f277de5",
"FolderName": "dylandlwu",
"InChargeList": [
"dylandlwu"
],
"InstanceKey": "20250326150742906_2025-03-28 01:00:00",
"InstanceState": 2,
"InstanceType": null,
"ProjectId": "1460947878944567296",
"SchedulerTime": "2025-03-28 01:00:00",
"StartTime": "2025-03-28 01:12:07",
"TaskCycleType": "I",
"TaskId": "20250326150742906",
"TaskName": "dq_test_dylan_shell_01",
"TaskType": {
"TypeDesc": "Shell",
"TypeId": 35,
TypeSort: Data computing
},
"TotalRunNum": 1,
"Tries": 1,
"TryLimit": 5,
"WorkflowId": "ec66594e-53a0-48cb-8044-a9eb3a58efe5",
"WorkflowName": "dq_test_0326"
},
{
"CostTime": "00:00:10.000",
"CurRunDate": "2025-03-28 01:20:00",
"EndTime": "2025-03-28 01:20:21",
"ExecutorGroupId": "20240222212719833743",
"ExecutorGroupName": "qfh_test",
"FolderId": "2493fc25-643d-11ef-8ec8-b8599f277de5",
"FolderName": "dylandlwu",
"InChargeList": [
"dylandlwu"
],
"InstanceKey": "20250326150742906_2025-03-28 01:20:00",
"InstanceState": 2,
"InstanceType": null,
"ProjectId": "1460947878944567296",
"SchedulerTime": "2025-03-28 01:20:00",
"StartTime": "2025-03-28 01:20:11",
"TaskCycleType": "I",
"TaskId": "20250326150742906",
"TaskName": "dq_test_dylan_shell_01",
"TaskType": {
"TypeDesc": "Shell",
"TypeId": 35,
TypeSort: Data computing
},
"TotalRunNum": 1,
"Tries": 1,
"TryLimit": 5,
"WorkflowId": "ec66594e-53a0-48cb-8044-a9eb3a58efe5",
"WorkflowName": "dq_test_0326"
},
{
"CostTime": "00:00:08.000",
"CurRunDate": "2025-03-28 01:40:00",
"EndTime": "2025-03-28 01:40:27",
"ExecutorGroupId": "20240222212719833743",
"ExecutorGroupName": "qfh_test",
"FolderId": "2493fc25-643d-11ef-8ec8-b8599f277de5",
"FolderName": "dylandlwu",
"InChargeList": [
"dylandlwu"
],
"InstanceKey": "20250326150742906_2025-03-28 01:40:00",
"InstanceState": 2,
"InstanceType": null,
"ProjectId": "1460947878944567296",
"SchedulerTime": "2025-03-28 01:40:00",
"StartTime": "2025-03-28 01:40:19",
"TaskCycleType": "I",
"TaskId": "20250326150742906",
"TaskName": "dq_test_dylan_shell_01",
"TaskType": {
"TypeDesc": "Shell",
"TypeId": 35,
TypeSort: Data computing
},
"TotalRunNum": 1,
"Tries": 1,
"TryLimit": 5,
"WorkflowId": "ec66594e-53a0-48cb-8044-a9eb3a58efe5",
"WorkflowName": "dq_test_0326"
},
{
"CostTime": "00:00:08.000",
"CurRunDate": "2025-03-28 02:00:00",
"EndTime": "2025-03-28 02:00:34",
"ExecutorGroupId": "20240222212719833743",
"ExecutorGroupName": "qfh_test",
"FolderId": "2493fc25-643d-11ef-8ec8-b8599f277de5",
"FolderName": "dylandlwu",
"InChargeList": [
"dylandlwu"
],
"InstanceKey": "20250326150742906_2025-03-28 02:00:00",
"InstanceState": 2,
"InstanceType": null,
"ProjectId": "1460947878944567296",
"SchedulerTime": "2025-03-28 02:00:00",
"StartTime": "2025-03-28 02:00:26",
"TaskCycleType": "I",
"TaskId": "20250326150742906",
"TaskName": "dq_test_dylan_shell_01",
"TaskType": {
"TypeDesc": "Shell",
"TypeId": 35,
TypeSort: Data computing
},
"TotalRunNum": 1,
"Tries": 1,
"TryLimit": 5,
"WorkflowId": "ec66594e-53a0-48cb-8044-a9eb3a58efe5",
"WorkflowName": "dq_test_0326"
},
{
"CostTime": "00:00:10.000",
"CurRunDate": "2025-03-28 02:20:00",
"EndTime": "2025-03-28 02:20:22",
"ExecutorGroupId": "20240222212719833743",
"ExecutorGroupName": "qfh_test",
"FolderId": "2493fc25-643d-11ef-8ec8-b8599f277de5",
"FolderName": "dylandlwu",
"InChargeList": [
"dylandlwu"
],
"InstanceKey": "20250326150742906_2025-03-28 02:20:00",
"InstanceState": 2,
"InstanceType": null,
"ProjectId": "1460947878944567296",
"SchedulerTime": "2025-03-28 02:20:00",
"StartTime": "2025-03-28 02:20:12",
"TaskCycleType": "I",
"TaskId": "20250326150742906",
"TaskName": "dq_test_dylan_shell_01",
"TaskType": {
"TypeDesc": "Shell",
"TypeId": 35,
TypeSort: Data computing
},
"TotalRunNum": 1,
"Tries": 1,
"TryLimit": 5,
"WorkflowId": "ec66594e-53a0-48cb-8044-a9eb3a58efe5",
"WorkflowName": "dq_test_0326"
},
{
"CostTime": "00:00:14.000",
"CurRunDate": "2025-03-28 02:40:00",
"EndTime": "2025-03-28 02:40:31",
"ExecutorGroupId": "20240222212719833743",
"ExecutorGroupName": "qfh_test",
"FolderId": "2493fc25-643d-11ef-8ec8-b8599f277de5",
"FolderName": "dylandlwu",
"InChargeList": [
"dylandlwu"
],
"InstanceKey": "20250326150742906_2025-03-28 02:40:00",
"InstanceState": 2,
"InstanceType": null,
"ProjectId": "1460947878944567296",
"SchedulerTime": "2025-03-28 02:40:00",
"StartTime": "2025-03-28 02:40:17",
"TaskCycleType": "I",
"TaskId": "20250326150742906",
"TaskName": "dq_test_dylan_shell_01",
"TaskType": {
"TypeDesc": "Shell",
"TypeId": 35,
TypeSort: Data computing
},
"TotalRunNum": 1,
"Tries": 1,
"TryLimit": 5,
"WorkflowId": "ec66594e-53a0-48cb-8044-a9eb3a58efe5",
"WorkflowName": "dq_test_0326"
},
{
"CostTime": "00:00:10.000",
"CurRunDate": "2025-03-28 03:00:00",
"EndTime": "2025-03-28 03:00:30",
"ExecutorGroupId": "20240222212719833743",
"ExecutorGroupName": "qfh_test",
"FolderId": "2493fc25-643d-11ef-8ec8-b8599f277de5",
"FolderName": "dylandlwu",
"InChargeList": [
"dylandlwu"
],
"InstanceKey": "20250326150742906_2025-03-28 03:00:00",
"InstanceState": 2,
"InstanceType": null,
"ProjectId": "1460947878944567296",
"SchedulerTime": "2025-03-28 03:00:00",
"StartTime": "2025-03-28 03:00:20",
"TaskCycleType": "I",
"TaskId": "20250326150742906",
"TaskName": "dq_test_dylan_shell_01",
"TaskType": {
"TypeDesc": "Shell",
"TypeId": 35,
TypeSort: Data computing
},
"TotalRunNum": 1,
"Tries": 1,
"TryLimit": 5,
"WorkflowId": "ec66594e-53a0-48cb-8044-a9eb3a58efe5",
"WorkflowName": "dq_test_0326"
}
],
"PageCount": 10,
"PageNumber": 1,
"PageSize": 10,
"TotalCount": 34,
"TotalPage": 4
},
"RequestId": "39304e20-9974-4c65-844f-e31357386eba"
}
}5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
- Tencent Cloud SDK 3.0 for Python
- Tencent Cloud SDK 3.0 for Java
- Tencent Cloud SDK 3.0 for PHP
- Tencent Cloud SDK 3.0 for Go
- Tencent Cloud SDK 3.0 for Node.js
- Tencent Cloud SDK 3.0 for .NET
- Tencent Cloud SDK 3.0 for C++
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