tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeInstanceList

Last updated: 2024-06-21 15:11:10

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: DescribeInstanceList.
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.
ProjectId Yes String Project/workspace ID
PageIndex Yes Integer Page Number
PageSize Yes Integer Number of items displayed per page
CycleList.N Yes Array of String Cycle List (e.g., daily, one-time), optional
OwnerList.N Yes Array of String Person in Charge
InstanceType Yes String Keep consistent with previous
Sort Yes String Sorting Order (asc, desc)
SortCol Yes String Sort Column (costTime Runtime duration, startTime Start Time, state Instance status, curRunDate Data Timestamp)
TaskTypeList.N Yes Array of Integer Type List (e.g., Python Task Type: 30
PySpark Task Type: 31
hivesql task type:34
shell task type:35
sparksql task type:36 jdbcsql task type:21 dlc task type:32), optional
StateList.N Yes Array of Integer Status list (e.g., success 2, executing 1), optional
Keyword No String Task Name

3. Output Parameters

Parameter Name Type Description
Data String Result
InstanceList Array of InstanceList Instance ListNote: This field may return null, indicating that no valid value can be obtained.
TotalCount Integer Total number of itemsNote: 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 Get Offline Operation and Maintenance Instance List

Get Offline Operation and Maintenance Instance List

Input Example

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

{
    "ProjectId": "11022568003970304",
    "PageIndex": 0,
    "PageSize": 0,
    "CycleList": [
        "12312"
    ],
    "OwnerList": [
        "tom"
    ],
    "InstanceType": "2",
    "Sort": "DESC",
    "SortCol": "name",
    "TaskTypeList": [
        0
    ],
    "StateList": [
        0
    ],
    "Keyword": "123"
}

Output Example

{
    "Response": {
        "Data": "true",
        "InstanceList": [
            {
                "CostTime": "1234",
                "CurRunDate": "2022-04-10 19:38:37",
                "CycleType": "2",
                "DoFlag": 0,
                "InCharge": "1231",
                "LastLog": "LastLog",
                "SchedulerDesc": "descripe",
                "StartTime": "2022-04-10 19:38:37",
                "State": "COMPLETED",
                "TaskId": "20220408130054538",
                "TaskName": "1",
                "TryLimit": 0
            }
        ],
        "TotalCount": 0,
        "RequestId": "as1cs2c123asyi23bh213cc"
    }
}

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.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy