DescribeDataFlowTasks - Cloud Parallel File Storage - Alibaba Cloud Documentation Center

Mengkueri detail tugas alur kerja data.

Deskripsi operasi

Hanya CPFS 2.2.0 dan versi lebih baru, serta CPFS for AI computing edition 2.4.0 dan versi lebih baru yang mendukung pengkuerian Tugas alur kerja data. Anda dapat Tampilan informasi versi pada halaman detail sistem file di Konsol.

Coba sekarang

Coba API ini di OpenAPI Explorer tanpa perlu penandatanganan manual. Panggilan yang berhasil akan secara otomatis menghasilkan contoh kode SDK sesuai dengan parameter Anda. Unduh kode tersebut dengan kredensial bawaan yang aman untuk penggunaan lokal.

Test

RAM authorization

Tabel berikut menjelaskan otorisasi yang diperlukan untuk memanggil API ini. Anda dapat menentukannya dalam kebijakan Resource Access Management (RAM). Kolom pada tabel dijelaskan sebagai berikut:

Action: Aksi yang dapat digunakan dalam elemen Action pada pernyataan kebijakan izin RAM untuk memberikan izin guna melakukan operasi tersebut.
API: API yang dapat Anda panggil untuk melakukan aksi tersebut.
Access level: Tingkat akses yang telah ditentukan untuk setiap API. Nilai yang valid: create, list, get, update, dan delete.
Resource type: Jenis resource yang mendukung otorisasi untuk melakukan aksi tersebut. Ini menunjukkan apakah aksi tersebut mendukung izin tingkat resource. Resource yang ditentukan harus kompatibel dengan aksi tersebut. Jika tidak, kebijakan tersebut tidak akan berlaku.
- Untuk API dengan izin tingkat resource, jenis resource yang diperlukan ditandai dengan tanda bintang (*). Tentukan Nama Sumber Daya Alibaba Cloud (ARN) yang sesuai dalam elemen Resource pada kebijakan.
- Untuk API tanpa izin tingkat resource, ditampilkan sebagai All Resources. Gunakan tanda bintang (*) dalam elemen Resource pada kebijakan.
Condition key: Kunci kondisi yang didefinisikan oleh layanan. Kunci ini memungkinkan kontrol granular, berlaku baik hanya untuk aksi maupun untuk aksi yang terkait dengan resource tertentu. Selain kunci kondisi spesifik layanan, Alibaba Cloud menyediakan serangkaian common condition keys yang berlaku di semua layanan yang didukung RAM.
Dependent action: Aksi dependen yang diperlukan untuk menjalankan aksi tersebut. Untuk menyelesaikan aksi tersebut, pengguna RAM atau role RAM harus memiliki izin untuk melakukan semua aksi dependen.

Action

Access level

Resource type

Condition key

Dependent action

nas:DescribeDataFlowTasks

get

*DataFlow

acs:nas:{#regionId}:{#accountId}:filesystem/{#filesystemId}

None

Parameter permintaan

Parameter	Type	Required	Description	Example
FileSystemId	string	Yes	ID sistem file. Edisi standar CPFS: harus diawali dengan `cpfs-`, misalnya cpfs-099394bd928c**. CPFS for AI computing edition: harus diawali dengan `bmcpfs-`, misalnya bmcpfs-290w65p03ok64ya** .	bmcpfs-290w65p03ok64ya****
Filters	array<object>	No	Kumpulan informasi kunci filter.
	object	No
Key	string	No	Nama kunci filter. Nilai valid: DataFlowIds: memfilter berdasarkan ID alur kerja data. TaskIds: memfilter berdasarkan ID tugas alur kerja data. Originator: memfilter berdasarkan penginisiasi tugas alur kerja data. TaskActions: memfilter berdasarkan tipe tugas alur kerja data. DataTypes: memfilter berdasarkan tipe data tugas alur kerja data. Status: memfilter berdasarkan status alur kerja data. CreateTimeBegin: memfilter tugas alur kerja data yang dibuat pengatur waktu yang ditentukan. CreateTimeEnd: memfilter tugas alur kerja data yang dibuat sebelum waktu yang ditentukan. StartTimeBegin: memfilter tugas alur kerja data yang dimulai pengatur waktu yang ditentukan. StartTimeEnd: memfilter tugas alur kerja data yang dimulai sebelum waktu yang ditentukan. EndTimeBegin: memfilter tugas alur kerja data yang berakhir pengatur waktu yang ditentukan. EndTimeEnd: memfilter tugas alur kerja data yang berakhir sebelum waktu yang ditentukan.	DataFlowIds
Value	string	No	Nilai kunci filter. Parameter ini tidak mendukung karakter wildcard. Jika Key adalah DataFlowIds, Value adalah ID alur kerja data atau sebagian dari ID alur kerja data. Dapat berupa satu atau sekelompok DataFlowIds, dengan maksimum 10 ID alur kerja data. Misalnya, `df-194433a5be31**` atau `df-194433a512a2,df-234533a5be31`. Jika Key adalah TaskId, Value adalah ID tugas alur kerja data atau sebagian dari ID tugas alur kerja data. Dapat berupa satu atau sekelompok ID tugas alur kerja data, dengan maksimum 10 ID tugas alur kerja data. Misalnya, `task-38aa8e890f45` atau `task-38aa8e890f45,task-29ae8e890f45`. Jika Key adalah TaskActions, Value adalah tipe tugas alur kerja data, termasuk Import, Export, Evict, Inventory, StreamImport, dan StreamExport**. Kueri gabungan didukung. Saat ini, CPFS for AI computing edition hanya mendukung Import, Export, StreamImport, dan StreamExport. StreamImport dan StreamExport hanya didukung oleh CPFS for AI computing edition 2.6.0 dan versi lebih baru. Jika Key adalah DataTypes, Value adalah tipe data tugas alur kerja data, termasuk MetaAndData, Metadata, dan Data. Kueri gabungan didukung. Jika Key adalah Originator, Value adalah penginisiasi tugas alur kerja data, termasuk User dan System. Jika Key adalah Status, Value adalah status tugas alur kerja data, termasuk Pending, Executing, Failed, Completed, Canceling, dan Canceled. Kueri gabungan didukung. Jika Key adalah CreateTimeBegin, Value pengatur waktu pembuatan minimum tugas alur kerja data. Formatnya adalah `yyyy-MM-ddThh:mmZ`. Jika Key adalah CreateTimeEnd, Value pengatur waktu pembuatan maksimum tugas alur kerja data. Formatnya adalah `yyyy-MM-ddThh:mmZ`. Jika Key adalah StartTimeBegin, Value pengatur waktu mulai minimum tugas alur kerja data. Formatnya adalah `yyyy-MM-ddThh:mmZ`. Jika Key adalah StartTimeEnd, Value pengatur waktu mulai maksimum tugas alur kerja data. Formatnya adalah `yyyy-MM-ddThh:mmZ`. Jika Key adalah EndTimeBegin, Value pengatur waktu berakhir minimum tugas alur kerja data. Formatnya adalah `yyyy-MM-ddThh:mmZ`. Jika Key adalah EndTimeEnd, Value pengatur waktu berakhir maksimum tugas alur kerja data. Formatnya adalah `yyyy-MM-ddThh:mmZ`.	df-194433a5be31****
NextToken	string	No	Ketika hasil yang dikembalikan terpotong, Anda dapat menggunakan NextToken untuk membuat permintaan lain guna memperoleh konten setelah posisi pemotongan saat ini.	TGlzdFJlc291cmNlU****mVzJjE1MTI2NjY4NzY5MTAzOTEmMiZORnI4NDhVeEtrUT0=
MaxResults	integer	No	Jumlah hasil per kueri. Nilai valid: 10 hingga 100. Nilai default: 20.	20
WithReports	boolean	No	Apakah akan mengkueri informasi laporan. True (default): mengkueri laporan. False: tidak mengkueri laporan. Catatan Mengaturnya ke False dapat mempercepat kueri. Hanya didukung oleh CPFS for AI computing edition.	True

Elemen respons

Element	Type	Description	Example
	object
RequestId	string	ID permintaan.	2D69A58F-345C-4FDE-88E4-BF518948****
NextToken	string	Ketika hasil yang dikembalikan terpotong, Anda dapat menggunakan NextToken untuk membuat permintaan lain guna memperoleh konten setelah posisi pemotongan saat ini.	TGlzdFJlc291cmNlU****mVzJjE1MTI2NjY4NzY5MTAzOTEmMiZORnI4NDhVeEtrUT0=
TaskInfo	object
Task	array<object>	Kumpulan informasi Tugas alur kerja data.
	array<object>
FilesystemId	string	The ID of the file system.	bmcpfs-290w65p03ok64ya****
DataFlowId	string	The ID of the dataflow.	df-194433a5be31****
TaskId	string	The ID of the dataflow task.	task-38aa8e890f45****
SourceStorage	string	The access path of the source storage. Format: `<storage type>://[<account id>:]<path>`. Among them: storage type: Only Object Storage Service (OSS) is supported. account id: the UID of the account of the source storage. path: the name of the OSS bucket. Limits: The name can contain only lowercase letters, digits, and hyphens (-). The name must start and end with a lowercase letter or digit. The name can be up to 128 characters in length. The name must be encoded in UTF-8. Catatan The OSS bucket must be an existing bucket in the region. Only CPFS for Lingjun V2.6.0 and later support the account id parameter.	oss://178321033379****:bucket-01
FileSystemPath	string	The directory of the fileset in the CPFS file system. Limits: The directory must be 2 to 1024 characters in length. The directory must be encoded in UTF-8. The directory must start and end with a forward slash (/). The directory must be a fileset directory in the CPFS file system. Catatan Only CPFS supports this parameter.	/a/b/c/
Originator	string	The initiator of the dataflow task. The following information is displayed: User: The task is initiated by a user. System: The task is automatically initiated by CPFS based on the automatic update interval. Catatan Only CPFS supports this parameter.	User
TaskAction	string	The type of the dataflow task. The following information is displayed: Import: imports data stored in the source storage to a CPFS file system. Export: exports specified data from a CPFS file system to the source storage. StreamImport: imports the specified data from the source storage to a CPFS file system in streaming mode. StreamExport: exports specified data from a CPFS file system to the source storage in streaming mode. Evict: releases the data blocks of a file in a CPFS file system. After the eviction, only the metadata of the file is retained in the CPFS file system. You can still query the file. However, the data blocks of the file are cleared and do not occupy the storage space in the CPFS file system. When you access the file data, the file is loaded from the source storage as required. Inventory: obtains the inventory list managed by a dataflow from the CPFS file system, providing the cache status of inventories in the dataflow. Catatan Only CPFS for Lingjun V2.6.0 and later support StreamImport and StreamExport.	Import
DataType	string	The type of data on which operations are performed by the dataflow task. The following information is displayed: Metadata: the metadata of a file, including the timestamp, ownership, and permission information of the file. If you select Metadata, only the metadata of the file is imported. You can only query the file. When you access the file data, the file is loaded from the source storage as required. Data: the data blocks of the file. MetaAndData: the metadata and data blocks of the file. Catatan CPFS for Lingjun supports only the MetaAndData type.	MetaAndData
Progress	integer	The progress of the dataflow task. The number of operations that have been performed by the dataflow task.	50
Status	string	The status of the dataflow task. The following information is displayed: Pending: The dataflow task has been created and has not started. Executing: The dataflow task is being executed. Failed: The dataflow task failed to be executed. You can view the cause of the failure in the dataflow task report. Completed: The dataflow task is completed. You can check that all the files have been correctly transferred in the dataflow task report. Canceled: The dataflow task is canceled and is not completed. Canceling: The dataflow task is being canceled.	Failed
ReportPath `deprecated`	string	The save path of dataflow task reports in the CPFS file system. The task reports for a CPFS file system are generated in the `.dataflow_report` directory of the CPFS file system. CPFS for Lingjun returns an OSS download link for you to download the task reports.	/path_in_cpfs/reportfile.cvs
CreateTime	string	The time when the task was created.	2021-08-04 18:27:35
StartTime	string	The start time of the task.	2021-08-04 18:27:35
EndTime	string	The end time of the task.	2021-08-04 18:27:35
FsPath	string	The path of the smart directory.	/aa/
ConflictPolicy	string	The conflict policy for files with the same name. Valid values: SKIP_THE_FILE: skips files with the same name. KEEP_LATEST: compares the update time and keeps the latest version. OVERWRITE_EXISTING: forcibly overwrites the existing file.	KEEP_LATEST
Directory	string	The directory in which the dataflow task is executed.	/path_in_cpfs/
DstDirectory	string	The directory mapped to the dataflow task.	/path_in_cpfs/
ErrorMsg	string	The cause of the task exception. Catatan If this parameter is not returned or the return value is empty, no error occurs.	{"ErrorKey":"PATH_NOT_ACCESSIBLE","ErrorDetail":"lstat /cpfs/370lx1ev9ss27o****/test/abcdfnotfound: no such file or directory"}
ProgressStats	object	The progress of the dataflow task.
FilesTotal	integer	The number of files scanned on the source.	3
FilesDone	integer	The number of files (including skipped files) for which the dataflow task is complete.	3
ActualFiles	integer	The actual number of files for which the dataflow task is complete.	3
BytesTotal	integer	The amount of data scanned on the source. Unit: bytes.	131092971520
BytesDone	integer	The amount of data (including skipped data) for which the dataflow task is complete. Unit: bytes.	131092971520
ActualBytes	integer	The actual amount of data for which the dataflow task is complete. Unit: bytes.	131092971520
RemainTime	integer	The estimated remaining execution time. Unit: seconds.	437
AverageSpeed	integer	The average flow velocity. Unit: bytes/s.	342279299
Reports	object
Report	array<object>	The reports. Catatan Streaming tasks do not support reports. If the WithReport parameter is set to True, the CPFS for Lingjun report data is returned. Only CPFS for Lingjun supports the WithReport parameter.
	object
Name	string	The name of the report. CPFS: TotalFilesReport: task reports. CPFS for Lingjun: FailedFilesReport: failed file reports. SkippedFilesReport: skipped file reports. SuccessFilesReport: successful file reports.	TotalFilesReport
Path	string	The report URL.	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	string	Filters subdirectories and transfers their contents. Catatan Only CPFS for Lingjun supports this operation.	["/test/","/test1/"]
TransferFileListPath	string	Specify the OSS directory and synchronize data based on the content of the CSV file in the OSS directory. Catatan Only CPFS for Lingjun supports this operation.	/path_in_cpfs/

Contoh

Respons sukses

JSONformat

{
  "RequestId": "2D69A58F-345C-4FDE-88E4-BF518948****",
  "NextToken": "TGlzdFJlc291cmNlU****mVzJjE1MTI2NjY4NzY5MTAzOTEmMiZORnI4NDhVeEtrUT0=",
  "TaskInfo": {
    "Task": [
      {
        "FilesystemId": "bmcpfs-290w65p03ok64ya****",
        "DataFlowId": "df-194433a5be31****",
        "TaskId": "task-38aa8e890f45****",
        "SourceStorage": "oss://178321033379****:bucket-01",
        "FileSystemPath": "/a/b/c/",
        "Originator": "User",
        "TaskAction": "Import",
        "DataType": "MetaAndData ",
        "Progress": 50,
        "Status": "Failed",
        "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/\"]\n",
        "TransferFileListPath": "/path_in_cpfs/\n"
      }
    ]
  }
}

Kode kesalahan

HTTP status code	Error code	Error message
400	IllegalCharacters	The parameter contains illegal characters.
400	MissingFileSystemId	FileSystemId is mandatory for this action.
400	InvalidFilesystemVersion.NotSupport	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.
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.

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.