tencent cloud



Last updated: 2023-07-04 17:30:01

1. API Description

Domain name for API request: cfs.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 No String Common Params. This parameter is not required for this API.
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

    Filter by migration task ID
    Type: String

    Required: No

  • taskName

    Fuzzy filter by migration task name
    Type: String

    Required: No

    Each request can have up to 10 Filters and 100 Filter.Values.
  • 3. Output Parameters

    Parameter Name Type Description
    TotalCount Integer Number of migration tasks
    MigrationTasks Array of MigrationTaskInfo Migration task details
    RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

    4. Example

    Example1 Getting the migration task list

    This example shows you how to get the migration task list.

    Input Example

    POST / HTTP/1.1
    Host: cfs.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": null,
                    "FileCompletedList": null,
                    "FileFailedList": null,
                    "CreateTime": 1662023240000,
                    "EndTime": 1662023548000
            "TotalCount": 2,
            "RequestId": "c0f7c5d9-c8c4-401a-a6da-2106f3c6db76"

    5. Developer Resources


    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

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

    Contact Us

    Contact our sales team or business advisors to help your business.

    Technical Support

    Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

    7x24 Phone Support