DescribeMigrationTasks

Modo Foco

Tamanho da Fonte

Última atualização: 2026-03-24 17:02:27

1. API Description

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

This API is used to get the list of migration tasks.
To use this API, submit a ticket for us to add you to the allowlist.

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: DescribeMigrationTasks.
Version	Yes	String	Common Params. The value used for this API: 2019-07-19.
Region	Yes	String	Common Params. For more information, please see the list of regions supported by the product. This API only supports: ap-bangkok, ap-beijing, ap-chengdu, ap-chongqing, ap-guangzhou, ap-hongkong, ap-jakarta, ap-nanjing, ap-seoul, ap-shanghai, ap-shanghai-fsi, ap-shenzhen-fsi, ap-singapore, ap-tokyo, eu-frankfurt, na-ashburn, na-siliconvalley.
Offset	No	Integer	The pagination offset. Default value: 0.
Limit	No	Integer	Maximum number of entries per page. Default value: 20. Maximum value: 100.
Filters.N	No	Array of Filter	taskId Filters by [migration task id]. type: String required: no taskName does fuzzy search filtering by [migration task name]. type: String required: no the maximum number of Filters per request is 10, and the maximum number of Filter.Values is 100. .

3. Output Parameters

Parameter Name	Type	Description
TotalCount	Integer	Total number of migration tasks.
MigrationTasks	Array of MigrationTaskInfo	Migration task details
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 Obtaining the Migration Task List

To obtain the migration task list

Input Example

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

{
    "Limit": 20,
    "Offset": 0
}

Output Example

{
    "Response": {
        "MigrationTasks": [
            {
                "TaskName": "taskName",
                "TaskId": "cfsmigrate-29d43e98",
                "MigrationType": 0,
                "MigrationMode": 0,
                "BucketName": "bucket-1",
                "BucketRegion": "oss-cn-beijing",
                "BucketAddress": "https://test-1.oss-cn-beijing.aliyuncs.com",
                "BucketPath": "",
                "ListAddress": "",
                "FsName": "t1",
                "FileSystemId": "cfs-qz5c44o1",
                "FsPath": "/ahh",
                "CoverType": 0,
                "Status": 6,
                "FileTotalCount": 0,
                "FileMigratedCount": 0,
                "FileFailedCount": 0,
                "FileTotalSize": 0,
                "FileMigratedSize": 0,
                "FileFailedSize": 0,
                "FileTotalList": "",
                "FileCompletedList": "",
                "FileFailedList": "",
                "CreateTime": 1662023240000,
                "EndTime": 1662023548000,
                "Direction": 0
            }
        ],
        "TotalCount": 1,
        "RequestId": "c0f7c5d9-c8c4-401a-a6da-2106f3c6db76"
    }
}

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

Tencent Cloud CLI 3.0

6. Error Code

There is no error code related to the API business logic. For other error codes, please see Common Error Codes.

Ajuda e Suporte

Esta página foi útil?

Você também pode entrar em contato com a Equipe de vendas ou Enviar um tíquete em caso de ajuda.

comentários

tencent cloud

Cloud File Storage