1. API Description
Domain name for API request: trocket.intl.tencentcloudapi.com.
This API is used to search the data migration task list. Filter parameter usage instructions are as follows:.
This API is used to search precisely according to task ID.
InstanceId. This API is used to precisely search based on instance ID.
This API is used to search by task Type.
A maximum of 20 requests can be initiated per second for this API.
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: DescribeMigrationTaskList. |
| Version | Yes | String | Common Params. The value used for this API: 2023-03-08. |
| Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. |
| Filters.N | No | Array of Filter | Query criteria list |
| Offset | No | Integer | Query start position |
| Limit | No | Integer | Query result limit count |
3. Output Parameters
| Parameter Name | Type | Description |
|---|---|---|
| TotalCount | Integer | Total query count |
| Tasks | Array of MigrationTaskItem | Migration Task List Note: This field may return null, indicating that no valid values 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 Retrieving the Data Migration Task List
Input Example
POST / HTTP/1.1
Host: trocket.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeMigrationTaskList
<Common request parameters>
{
"Filters": [],
"Offset": 0,
"Limit": 20
}Output Example
{
"Response": {
"RequestId": "bd8c6783-04a4-419f-bc51-9af603872490",
"TotalCount": 1,
"Tasks": [
{
"TaskId": "603872-7a11-c67",
"Type": 1,
"InstanceId": "rmq-47zbegoa",
"TopicNum": 4,
"GroupNum": 0,
"Status": 1,
"CreateTime": 1693219938000
}
]
}
}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
There is no error code related to the API business logic. For other error codes, please see Common Error Codes.
Feedback