Queries the details of dataflow tasks.
Operation description
Only CPFS V2.2.0 and later and CPFS for Lingjun V2.4.0 and later support this operation. You can view the version information on the file system details page in the console.
Debugging
Authorization information
The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:
- Operation: the value that you can use in the Action element to specify the operation on a resource.
- Access level: the access level of each operation. The levels are read, write, and list.
- Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- For mandatory resource types, indicate with a prefix of * .
- If the permissions cannot be granted at the resource level,
All Resourcesis used in the Resource type column of the operation.
- Condition Key: the condition key that is defined by the cloud service.
- Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
| Operation | Access level | Resource type | Condition key | Associated operation |
|---|---|---|---|---|
| nas:DescribeDataFlowTasks | get | *DataFlow acs:nas:{#regionId}:{#accountId}:filesystem/{#filesystemId} |
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| FileSystemId | string | Yes | The ID of the file system.
| cpfs-099394bd928c**** |
| Filters | array<object> | No | The details about filters. | |
| object | No | |||
| Key | string | No | The filter name. Valid value:
| DataFlowIds |
| Value | string | No | The value of the filter. This parameter does not support wildcards.
| dfid-12345678 |
| NextToken | string | No | The pagination token that is used in the next request to retrieve a new page of results. You do not need to specify this parameter for the first request. You must specify the token that is obtained from the previous query as the value of NextToken. | TGlzdFJlc291cmNlU****mVzJjE1MTI2NjY4NzY5MTAzOTEmMiZORnI4NDhVeEtrUT0= |
| MaxResults | long | No | The number of results for each query. Valid values: 10 to 100. Default value: 20. | 20 |
| WithReports | boolean | No | Whether to query report information.
Note
| True |
Response parameters
Examples
Sample success responses
JSONformat
{
"RequestId": "2D69A58F-345C-4FDE-88E4-BF518948****",
"NextToken": "TGlzdFJlc291cmNlU****mVzJjE1MTI2NjY4NzY5MTAzOTEmMiZORnI4NDhVeEtrUT0=",
"TaskInfo": {
"Task": [
{
"FilesystemId": "cpfs-099394bd928c****",
"DataFlowId": "dfid-194433a5be3****",
"TaskId": "taskId-12345678",
"SourceStorage": "oss://bucket1",
"FileSystemPath": "/a/b/c/",
"Originator": "User",
"TaskAction": "Import",
"DataType": "Metadata",
"Progress": 240,
"Status": "Executing",
"ReportPath": "/path_in_cpfs/reportfile.cvs",
"CreateTime": "2021-08-04 18:27:35",
"StartTime": "2021-08-04 18:27:35",
"EndTime": "2021-08-04 18:27:35",
"FsPath": "/aa/",
"ConflictPolicy": "KEEP_LATEST",
"Directory": "/path_in_cpfs/",
"DstDirectory": "/path_in_cpfs/\n",
"ErrorMsg": {
"ErrorKey": "PATH_NOT_ACCESSIBLE",
"ErrorDetail": "lstat /cpfs/370lx1ev9ss27o****/test/abcdfnotfound: no such file or directory"
},
"ProgressStats": {
"FilesTotal": 3,
"FilesDone": 3,
"ActualFiles": 3,
"BytesTotal": 131092971520,
"BytesDone": 131092971520,
"ActualBytes": 131092971520,
"RemainTime": 437,
"AverageSpeed": 342279299
},
"Reports": {
"Report": [
{
"Name": "TotalFilesReport",
"Path": "https://a-hbr-temp-cn-hangzhou-staging.oss-cn-hangzhou.aliyuncs.com/temp/report/162319438359****/job-000bb6fwqficjbxk****/job-000bb6fwqficjbxk****_failed.zip?Expires=1721201422&OSSAccessKeyId=LTA****************&Signature=Fp%2BvauORTIVxooXY2tec6z0T%2Bp4%3D"
}
]
},
"Includes": [
"/test/",
"/test1/"
],
"TransferFileListPath": "/path_in_cpfs/\n"
}
]
}
}Error codes
| HTTP status code | Error code | Error message | Description |
|---|---|---|---|
| 400 | IllegalCharacters | The parameter contains illegal characters. | The parameter contains illegal characters. |
| 400 | MissingFileSystemId | FileSystemId is mandatory for this action. | - |
| 400 | InvalidFilesystemVersion.NotSupport | This Api does not support this fileSystem version. | This Api does not support this fileSystem version. |
| 403 | OperationDenied.DataFlowNotSupported | The operation is not supported. | - |
| 404 | InvalidParameter.InvalidNextToken | The specified NextToken is invaild. | - |
| 404 | InvalidFileSystem.NotFound | The specified file system does not exist. | The specified file system does not exist. |
| 404 | InvalidDataFlow.NotFound | The specified data flow does not exist. | - |
| 404 | InvalidParameter.InvalidMaxResults | The specified MaxResults is invalid. | - |
| 404 | InvalidFilterParam | The specified Filter.N.Key is invalid. | - |
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|---|---|
| 2024-09-09 | The Error code has changed. The response structure of the API has changed | View Change Details |
| 2024-02-29 | The Error code has changed. The response structure of the API has changed | View Change Details |