Release Notes
Announcements
Domain name for API request: cfs.intl.tencentcloudapi.com.
This API is used to create a migration task.
A maximum of 20 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: CreateMigrationTask. |
| 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. |
| TaskName | Yes | String | Migration task name |
| MigrationType | Yes | Integer | Migration method flags, default is 0. 0: bucket migration; 1: inventory migration. |
| MigrationMode | Yes | Integer | Migration mode. Default value: 0 (full migration). |
| SrcSecretId | Yes | String | SecretId of the data source account. |
| SrcSecretKey | Yes | String | SecretKey of the data source account. |
| FileSystemId | Yes | String | File system instance ID, which can be obtained by querying the file system through the DescribeCfsFileSystems api. |
| FsPath | Yes | String | File system path |
| CoverType | Yes | Integer | Overwrite policy for files with the same name. Valid values: 0 (retain the file with the latest modified time), 1 (overwrite); and 2 (not overwrite). Default value: 0. |
| SrcService | Yes | String | Data source service providers. COS: tencent cloud COS, OSS: alibaba cloud OSS, OBS: huawei cloud OBS. |
| BucketName | No | String | Data source bucket name. specifies the bucket name for migration. either BucketName or BucketAddress is required for bucket migration. this parameter is not required for inventory migration. |
| BucketRegion | No | String | Data source bucket region |
| BucketAddress | No | String | Source bucket address. specifies the bucket address of the data source. for bucket migration, either BucketName or BucketAddress is required. this parameter is not required for inventory migration. |
| ListAddress | No | String | List address. This parameter is required if MigrationType is set to 1 (list). |
| FsName | No | String | Target file system name |
| BucketPath | No | String | Source bucket path, defaults to /. |
| Direction | No | Integer | Migration direction. valid values: 0 (cos migration to file system), 1 (file system migration to cos). default is 0. |
| Parameter Name | Type | Description |
|---|---|---|
| TaskId | String | Migration task ID. |
| 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. |
Used to create a data migration task
POST / HTTP/1.1
Host: cfs.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateMigrationTask
<Common request parameters>
{
"BucketRegion": "ap-nanjing",
"SrcService": "COS",
"CoverType": 1,
"SrcSecretKey": "*****************************",
"BucketPath": "cos/",
"MigrationMode": 0,
"FileSystemId": "cfs-8dd58fd7",
"BucketName": "test-1-1256238147",
"FsPath": "/test/",
"MigrationType": 0,
"TaskName": "migrate1",
"SrcSecretId": "**************************************************",
"FsName": "oldfs"
}
{
"Response": {
"TaskId": "cfsmigrate-dfe9b1f2",
"RequestId": "91cd4a08-a105-4c59-b229-82f0fs7363b8"
}
}
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 |
|---|---|
| FailedOperation | Operation failed. |
| InternalError | Internal error. |
| InvalidParameterValue | The parameter value is incorrect. |
| ResourceInUse | The resource is in use. |
フィードバック