Document Database Service

Query the Task List Information

2025-07-24 09:20:54
API Introduction

Call the describeTaskInfo API to query the task list information.

API Restrictions

None

URI
GET /v1/eventManageOpenApi/describeTaskInfo

Path Parameter

None

Query Parameter

Parameter

Required or Not

Parameter Type

Description

Example

limit

No

Integer

Return number, must be a positive integer. If left blank, default to returning 10 entries

2

Request Parameters

Request Header Parameter

None

Request Body Parameter

None

Response Parameter

Parameter

Required or Not

Parameter Type

Description

Example

Lower-level Object

statusCode

Yes

Integer

Response Code

Value range: 800 indicates success, 900 indicates failure

800


message

Yes

String

Response information

The XXX is queried successfully


returnObj

Yes

Object[]

Return object array


returnObj

Table returnObj

Parameter

Required or Not

Parameter Type

Description

Example

Lower-level Object

createTime

Yes

Date

Time of task execution

1645773196000


response

Yes

String

Result of task execution

Successful


operateType

Yes

Byte

Task type, 0 -> Others 1 -> Reset Password 2 -> Restart 3 -> Backup 4 -> Restore 5 -> Modify Backup Policy 6 -> Modify Parameter 7 -> Reset Parameter 8 -> Delete Backup 10 -> Convert SSL 11 -> Modify Port

3


prodInstId

Yes

String

Instance ID, if left blank, which indicates that the instance is destroyed

60d420bffb394397b4303be871a481e3


Sample Request

Request Header

None

Request parameter query

/v1/eventManageOpenApi/describeTaskInfo?limit=2
Response Example
{
    "statusCode": 800,
    "message": "the task list information is queried successfully",
    "returnObj": [
        {
            "createTime": 1645773196000,
            "response": "success",
            "operateType": 0,
            "prodInstId": "---"
        },
        {
            "createTime": 1663918589000,
            "response": "success",
            "operateType": 3,
            "prodInstId": "60d420bffb394397b4303be871a481e3"
        }
    ]
}
Status Code

Status Code

Description

800

Indicate that the request succeeded

900

Indicates that the request failed

Error Codes

None


20GTvK_7811I