Domain name for API request: cdb.intl.tencentcloudapi.com.
This API (DescribeTasks) is used to query the list of tasks for a TencentDB instance.
A maximum of 100 requests can be initiated per second for this API.
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: DescribeTasks. |
| Version | Yes | String | Common Params. The value used for this API: 2017-03-20. |
| Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. |
| InstanceId | No | String | Instance ID in the format of cdb-c1nl9rpv. It is the same as the instance ID displayed on the TencentDB Console page. You can use the instance list querying API to query the ID, whose value is the InstanceId value in output parameters. |
| AsyncRequestId | No | String | ID of an async task request, i.e., AsyncRequestId returned by relevant TencentDB operations. |
| TaskTypes.N | No | Array of Integer | Task type. If no value is passed in, all task types will be queried. Valid values: 1 - rolling back a database; 2 - performing an SQL operation; 3 - importing data; 5 - setting a parameter; 6 - initializing a TencentDB instance; 7 - restarting a TencentDB instance; 8 - enabling GTID of a TencentDB instance; 9 - upgrading a read-only instance; 10 - rolling back databases in batches; 11 - upgrading a primary instance; 12 - deleting a TencentDB table; 13 - promoting a disaster recovery instance. |
| TaskStatus.N | No | Array of Integer | Task status. If no value is passed in, all task statuses will be queried. Valid values: -1 - undefined; 0 - initializing; 1 - running; 2 - succeeded; 3 - failed; 4 - terminated; 5 - deleted; 6 - paused. |
| StartTimeBegin | No | String | Start time of the first task in the format of yyyy-MM-dd HH:mm:ss, such as 2017-12-31 10:40:01. It is used for queries by time range. |
| StartTimeEnd | No | String | End time of the last task in the format of yyyy-MM-dd HH:mm:ss, such as 2017-12-31 10:40:01. It is used for queries by time range. |
| Offset | No | Integer | Record offset. Default value: 0. |
| Limit | No | Integer | Number of results to be returned for a single request. Default value: 20. Maximum value: 100. |
| Parameter Name | Type | Description |
|---|---|---|
| TotalCount | Integer | Number of eligible instances. |
| Items | Array of TaskDetail | Information of an instance task. |
| 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. |
Query the task list of a cloud database instance
POST / HTTP/1.1
Host: cdb.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeTasks
<Common request parameters>
{}
{
"Response": {
"TotalCount": 5,
"Items": [
{
"Code": 9013,
"Message": "[Operate CDB Fail][Upgrade Service Fail!] reason: ERR#-999: lock_inst.cgi: specific instance IDs do not exist in the instance records"
"JobId": 79,
"AsyncRequestId": "9d21004b-3aa1896a-eeddca4b-a68f106d",
"TaskAttachInfo": [],
"Progress": 10,
"StartTime": "2019-10-09 20:03:39",
"EndTime": "2019-10-09 20:39:34",
"InstanceIds": [
"cdb-qlfpnobr"
],
"TaskType": "OPEN GTID",
"TaskStatus": "FAILED"
},
{
"Code": 0,
"Message": "The parameters are set successfully."
"JobId": 70,
"AsyncRequestId": "1d564380-2e391736-f28fa246-43cea3aa",
"TaskAttachInfo": [],
"Progress": 100,
"StartTime": "2018-07-06 22:03:05",
"EndTime": "2018-07-06 22:03:28",
"InstanceIds": [
"cdb-6kd9h71i"
],
"TaskType": "MODIFY PARAM",
"TaskStatus": "SUCCEED"
},
{
"Code": 0,
"Message": "Initialize instance successfully"
"JobId": 69,
"AsyncRequestId": "ea39295d-420a0b4e-a98298c7-8751e1ad",
"TaskAttachInfo": [],
"Progress": 100,
"StartTime": "2018-07-06 22:01:42",
"EndTime": "2018-07-06 22:02:26",
"InstanceIds": [
"cdb-6kd9h71i"
],
"TaskType": "INITIAL",
"TaskStatus": "SUCCEED"
},
{
"Code": 0,
"Message": "Instance upgrade task completed"
"JobId": 68,
"AsyncRequestId": "780b2e32-79cb0f4c-ec7854c5-44ff5372",
"TaskAttachInfo": [
{
"AttachKey": "FastUpgradeStatus",
"AttachValue": "1"
}
],
"Progress": 100,
"StartTime": "2018-07-05 23:53:48",
"EndTime": "2018-07-06 22:05:10",
"InstanceIds": [
"cdb-6kd9h71i"
],
"TaskType": "UPGRADE MASTER",
"TaskStatus": "SUCCEED"
},
{
"Code": -1,
"Message": "Setting parameter failure"
"JobId": 66,
"AsyncRequestId": "780b2e32-79cb0f4c-ec7854c5-44ff5371",
"TaskAttachInfo": [],
"Progress": 0,
"StartTime": "2018-07-05 23:30:36",
"EndTime": "2018-07-05 23:30:37",
"InstanceIds": [
"cdb-o02fxj9g"
],
"TaskType": "MODIFY PARAM",
"TaskStatus": "FAILED"
}
],
"RequestId": "9a4b22f5-0f93-4a72-ba05-1eb6cdf37a1e"
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
| Error Code | Description |
|---|---|
| CdbError | Backend or process error. |
| InternalError.CdbError | System error. |
| InternalError.DatabaseAccessError | Internal database error. |
| InternalError.DesError | Internal system error. |
| InternalError.FtpError | File transfer exception |
| InternalError.UndefinedError | Unknown error |
| InternalError.UnknownError | Unknown error |
| InvalidParameter | Parameter error. |
| InvalidParameter.InstanceNotFound | The instance does not exist. |
| InvalidParameterValue.DataConvertError | Data conversion failed. |
| OperationDenied | Operation denied. |
| OperationDenied.UserHasNoStrategy | This account is not authorized to access the requested resource. |
| OperationDenied.WrongStatus | The backend task status is invalid. |
文档反馈