tencent cloud

APIs

ListSubTasks

下载
聚焦模式
字号
最后更新时间: 2026-10-26 11:48:14

1. API Description

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

This API is used to query the subtask list of a query task.

A maximum of 5 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: ListSubTasks.
Version Yes String Common Params. The value used for this API: 2023-05-17.
Region Yes String Common Params. For more information, please see the list of regions supported by the product.
TaskId Yes String Complex task ID
PageNumber No Integer Page number, which is 1 by default.
PageSize No Integer Number of items per page. Default: 10.
Status No Integer Default: no filtering on this field. Otherwise, filter by task status. Status code: 1-NEW, 2-RUNNING, 3-COMPLETED, 4-FAILED.

3. Output Parameters

Parameter Name Type Description
Data ListSubTasksData Returned data.
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 Success

None

Input Example

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

{
    "TaskId": "6d915841-****-****-****-5b278a217051",
    "PageNumber": 1,
    "PageSize": 2,
    "Status": 4
}

Output Example

{
    "Response": {
        "Data": {
            "List": [
                {
                    "Action": "EnableDevice",
"ActionZhDesc": "Enable device",
                    "CreatedAt": "2023-07-19 16:12:50",
"FailReason": "Resource unreachable. The resource is not within this region"
                    "Progress": 1,
                    "ResourceId": "e9b0b611-****-****-****-b307e04b1c25",
                    "Runtime": 0,
                    "StartedAt": "2023-07-19 16:12:51",
                    "Status": 4,
                    "SubTaskId": "beb4f9c9-****-****-****-e7ce5d61b574",
                    "UpdatedAt": "2023-07-19 16:12:51"
                }
            ],
            "TotalCount": 1
        },
        "RequestId": "03d99ae5-6126-447d-91de-d94aefcc7a0f"
    }
}

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.DatabaseError Database error.
FailedOperation.RequestTimeout Request timeout.
InvalidParameter.InvalidParameterFormat Incorrect parameter format or missing required parameters
InvalidParameter.RequiredHeaderParameterEmpty Required request header parameter cannot be empty
InvalidParameter.TaskIdNotExist TaskId not found
InvalidParameterValue.InvalidPageParameter Invalid page parameter value
InvalidParameterValue.InvalidStatus Invalid status
InvalidParameterValue.TaskTypeNotSupported Unsupported task type

帮助和支持

本页内容是否解决了您的问题?

填写满意度调查问卷,共创更好文档体验。

文档反馈