全部產品
Search

搜尋本產品

    Cloud Parallel File Storage：DescribeDataFlowTasks - 查詢資料流動工作清單

    文件中心

    Cloud Parallel File Storage：DescribeDataFlowTasks - 查詢資料流動工作清單

    更新時間：May 11, 2026

    查詢資料流動任務詳細資料。

    介面說明

    僅 CPFS 2.2.0 及以上版本、CPFS 智算版 2.4.0 及以上版本支援查詢資料流動任務。您可以在控制台檔案系統詳情頁面查看版本資訊。

    調試

    您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

    調試

    授權資訊

    下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

    • 操作：是指具體的許可權點。

    • 存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。

    • 資源類型：是指操作中支援授權的資源類型。具體說明如下：

      • 對於必選的資源類型，用前面加 * 表示。

      • 對於不支援資源級授權的操作，用全部資源表示。

    • 條件關鍵字：是指雲產品自身定義的條件關鍵字。

    • 關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    nas:DescribeDataFlowTasks

    get

    *DataFlow

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

    		 無 無

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    FileSystemId

    string

    是

    檔案系統 ID。

    • CPFS 通用版：必須以cpfs-開頭，例如 cpfs-099394bd928c****。

    • CPFS 智算版：必須以bmcpfs-開頭，例如 bmcpfs-290w65p03ok64ya**** 。

    bmcpfs-290w65p03ok64ya****

    Filters

    array<object>

    否

    篩選鍵的資訊合集。

    object

    否

    Key

    string

    否

    篩選鍵的名稱。

    取值：

    • DataFlowIds: 根據資料流動 ID 篩選。

    • TaskIds：根據資料流動任務的 ID 篩選。

    • Originator：根據資料流動任務的發起者篩選。

    • TaskActions：根據資料流動任務的類型篩選。

    • DataTypes：根據資料流動任務的資料類型篩選。

    • Status：根據資料流動狀態篩選。

    • CreateTimeBegin：篩選指定時間後建立的資料流動任務。

    • CreateTimeEnd：篩選指定時間前建立的資料流動任務。

    • StartTimeBegin：篩選指定時間後啟動的資料流動任務。

    • StartTimeEnd：篩選指定時間前啟動的資料流動任務。

    • EndTimeBegin：篩選指定時間後結束的資料流動任務。

    • EndTimeEnd：篩選指定時間前結束的資料流動任務。

    DataFlowIds
    Value

    string

    否

    篩選鍵的值。該參數不支援萬用字元。

    • Key 取值為 DataFlowIds 時，Value 取值為資料流動 ID 或資料流動 ID 的一部分。可以是一個或一組 DataFlowId，資料流動 ID 最多可設定 10 個。例如，df-194433a5be31****或df-194433a512a2****,df-234533a5be31****。

    • 當 Key 取值為 TaskId 時，Value 取值為資料流動任務 ID 或資料流動任務 ID 的部分。可以是一個或一組資料流動任務 ID，資料流動任務 ID 最多可設定 10 個。例如，task-38aa8e890f45****或task-38aa8e890f45****,task-29ae8e890f45****。

    • 當 Key 取值為 TaskActions 時，Value 取值為資料流動的任務類型，包括 Import，Export、Evict、Inventory、StreamImport 和 StreamExport。支援組合查詢。目前 CPFS 智算版只支援 Import、Export、StreamImport 和 StreamExport。StreamImport 和 StreamExport 僅 CPFS 智算版 2.6.0 版本及以上版本支援。

    • 當 Key 取值為 DataTypes 時，Value 取值為資料流動任務的資料類型，包括 MetaAndData、Metadata 和 Data。支援組合查詢。

    • 當 Key 取值為 Originator 時，Value 取值為資料流動任務的發起者，包括 User，System。

    • 當 Key 取值為 Status 時，Value 取值為資料流動任務的狀態，包括 Pending、Executing、Failed、Completed、Canceling 和 Canceled。支援組合查詢。

    • 當 Key 取值為 CreateTimeBegin 時，Value 取值為資料流動任務建立時間最小值。格式為yyyy-MM-ddThh:mmZ。

    • 當 Key 取值為 CreateTimeEnd 時，Value 取值為資料流動任務建立時間最大值。格式為yyyy-MM-ddThh:mmZ。

    • 當 Key 取值為 StartTimeBegin 時，Value 取值為資料流動任務啟動時間最小值。格式為yyyy-MM-ddThh:mmZ。

    • 當 Key 取值為 StartTimeEnd 時，Value 取值為資料流動任務啟動時間最大值。格式為yyyy-MM-ddThh:mmZ。

    • 當 Key 取值為 EndTimeBegin 時，Value 取值為資料流動任務結束時間最小值。格式為yyyy-MM-ddThh:mmZ。

    • 當 Key 取值為 EndTimeEnd 時，Value 取值為資料流動任務結束時間最大值。格式為yyyy-MM-ddThh:mmZ。

    df-194433a5be31****
    NextToken

    string

    否

    當請求的返回結果被截斷時，您可以使用 NextToken 再次發起請求，擷取從當前截斷位置之後的內容。

    TGlzdFJlc291cmNlU****mVzJjE1MTI2NjY4NzY5MTAzOTEmMiZORnI4NDhVeEtrUT0=
    MaxResults

    integer

    否

    每次查詢結果的個數。

    取值範圍：10~100。

    預設值：20。

    20
    WithReports

    boolean

    否

    是否查詢報表資訊。

    • True（預設值）：查詢報表。

    • False：不查詢報表。

    說明

    • 設定為 False 可以加快查詢速度。

    • 僅支援 CPFS 智算版。

    True

    返回參數

    名稱

    類型

    描述

    樣本值

    object

    RequestId

    string

    請求 ID。

    2D69A58F-345C-4FDE-88E4-BF518948****
    NextToken

    string

    當請求的返回結果被截斷時，您可以使用 NextToken 再次發起請求，擷取從當前截斷位置之後的內容。

    TGlzdFJlc291cmNlU****mVzJjE1MTI2NjY4NzY5MTAzOTEmMiZORnI4NDhVeEtrUT0=
    TaskInfo

    object

    Task

    array<object>

    資料流動任務的資訊集合。

    array<object>

    FilesystemId

    string

    檔案系統 ID。

    bmcpfs-290w65p03ok64ya****
    DataFlowId

    string

    資料流動 ID。

    df-194433a5be31****
    TaskId

    string

    資料流動任務 ID。

    task-38aa8e890f45****
    SourceStorage

    string

    源端儲存的訪問地址。格式：<storage type>://[<account id>:]<path>。

    其中：

    • storage type：目前只支援 oss。

    • account id：源端儲存所屬帳號的 UID。

    • path：OSS 的 Bucket 名稱。限制如下。

      • 僅支援小寫字母、數字和短劃線（-）且必須以小寫字母或者數字開頭和結尾。

      • 最長為 128 個字元。

      • 使用 UTF-8 編碼。

    說明

    • OSS Bucket 必須為在該地區已存在的 Bucket。

    • 僅 CPFS 智算版 2.6.0 及以上版本支援 account id 參數。

    oss://178321033379****:bucket-01
    FileSystemPath

    string

    Fileset 在 CPFS 檔案系統中的路徑。

    限制：

    • 長度為 2~1024 個英文或中文字元。

    • 使用 UTF-8 編碼。

    • 必須以/開頭和結尾。

    • 該目錄必須是 CPFS 上的 Fileset 目錄。

    說明

    僅 CPFS 支援該參數。

    /a/b/c/
    Originator

    string

    資料流動任務的發起者。 包括：

    • User：使用者是該任務的發起者。

    • System：該任務是自動更新任務，是 CPFS 根據自動更新間隔時間自動發起的任務。

    說明

    僅 CPFS 支援該參數。

    User
    TaskAction

    string

    資料流動任務類型。包括：

    • Import：從源端儲存將指定的資料匯入至 CPFS。

    • Export：將 CPFS 上指定的資料匯出至源端儲存。

    • StreamImport：從源端儲存將指定的資料流式任務匯入至 CPFS。

    • StreamExport：將 CPFS 上指定的資料流式任務匯出至源端儲存。

    • Evict：釋放 CPFS 上檔案的資料區塊，釋放後檔案在 CPFS 上只保留中繼資料，您仍能查詢該檔案，但檔案資料區塊已清除，不佔用 CPFS 上的儲存容量。當訪問該檔案資料時，將再從源端儲存按需載入。

    • Inventory：擷取 CPFS 上資料流動管理的檔案清單，可提供檔案在資料流動中的緩衝狀態。

    說明

    StreamImport 和 StreamExport 僅 CPFS 智算版 2.6.0 版本及以上版本支援。

    Import
    DataType

    string

    資料流動任務操作的資料類型。包括：

    • Metadata：檔案的中繼資料，包括檔案的 timestamp, ownership, permission 等屬性資訊。選擇 Metadata，只會匯入檔案的中繼資料，使用者只能看到該檔案，但訪問該檔案資料時，資料從源端儲存按需載入。

    • Data：檔案的資料區塊。

    • MetaAndData：檔案的中繼資料和資料區塊。

    說明

    CPFS 智算版僅支援 MetaAndData 類型。

    MetaAndData

    Progress

    integer

    資料流動任務的進度。當前資料流動任務已經執行的運算元量。

    50
    Status

    string

    資料流動任務的狀態。包括：

    • Pending: 資料流動任務已建立，在排隊中未開始執行。

    • Executing：資料流動任務在執行中。

    • Failed：資料流動任務執行失敗，可以通過查看資料流動任務報告，查看失敗原因。

    • Completed：資料流動任務執行結束，可以通過查看資料流動任務報告，查看所有檔案已正確傳輸。

    • Canceled：資料流動任務被取消並且沒有完成。

    • Canceling：資料流動任務正在被取消。

    Failed
    ReportPath deprecated

    string

    資料流動任務報告在 CPFS 檔案系統中儲存的路徑。

    • CPFS 的任務報告會產生在該 CPFS 的.dataflow_report目錄中。

    • CPFS 智算版會返回一個 oss 下載連結，可以通過連結下載任務報告。

    /path_in_cpfs/reportfile.cvs
    CreateTime

    string

    任務建立時間。

    2021-08-04 18:27:35
    StartTime

    string

    任務開始執行時間。

    2021-08-04 18:27:35
    EndTime

    string

    任務結束時間。

    2021-08-04 18:27:35
    FsPath

    string

    智能目錄路徑。

    /aa/
    ConflictPolicy

    string

    同名檔案衝突策略。

    • SKIP_THE_FILE：跳過同名檔案。

    • KEEP_LATEST：比較更新時間，保留最新版本。

    • OVERWRITE_EXISTING：強制覆蓋同名檔案。

    KEEP_LATEST
    Directory

    string

    資料流動任務執行的目錄。

    /path_in_cpfs/
    DstDirectory

    string

    資料流動任務映射目標目錄。

    /path_in_cpfs/

    ErrorMsg

    string

    任務異常原因。

    說明

    當該欄位未返回或者返回為空白時，表示沒有錯誤資訊。

    {"ErrorKey":"PATH_NOT_ACCESSIBLE","ErrorDetail":"lstat /cpfs/370lx1ev9ss27o****/test/abcdfnotfound: no such file or directory"}
    ProgressStats

    object

    資料流動任務進度資訊。

    FilesTotal

    integer

    源端掃描到檔案數。

    3
    FilesDone

    integer

    已完成資料流動檔案數（包括跳過）。

    3
    ActualFiles

    integer

    實際流動檔案數。

    3
    BytesTotal

    integer

    源端掃描到資料量。單位：位元組。

    131092971520
    BytesDone

    integer

    已完成資料流動資料量（包括跳過資料）。單位：位元組。

    131092971520
    ActualBytes

    integer

    實際流動資料量。單位：位元組。

    131092971520
    RemainTime

    integer

    預計剩餘完成時間。單位：秒。

    437
    AverageSpeed

    integer

    平均流動速度。單位：Byte/s。

    342279299
    Reports

    object

    Report

    array<object>

    報告列表。

    說明

    • 流式任務不支援報告。

    • 當 WithReport=True 時，該參數會返回 CPFS 智算版報告資料。

    • 僅 CPFS 智算版支援 WithReport 參數。

    object

    Name

    string

    報告名稱。

    • CPFS：

      TotalFilesReport：任務報告。

    • CPFS 智算版：

      • FailedFilesReport：失敗的檔案報告。

      • SkippedFilesReport：跳過的檔案報告。

      • SuccessFilesReport：成功檔案報告。

    TotalFilesReport
    Path

    string

    報告連結。

    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

    過濾 directory 下目錄，傳輸過濾目錄內包含的檔案夾內容。

    說明

    僅 CPFS 智算版支援該功能。

    ["/test/","/test1/"]

    TransferFileListPath

    string

    指定 oss 目錄，根據 oss 目錄中的 csv 檔案的內容同步資料。

    說明

    僅 CPFS 智算版支援該功能。

    /path_in_cpfs/

    樣本

    正常返回樣本

    JSON格式

    {
  "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"
      }
    ]
  }
}

    錯誤碼

    HTTP status code

    錯誤碼

    錯誤資訊

    描述
    400 IllegalCharacters The parameter contains illegal characters. 參數非法。
    400 MissingFileSystemId FileSystemId is mandatory for this action. 未指定FileSystemId參數。
    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. 指定的MaxResults非法。
    404 InvalidFilterParam The specified Filter.N.Key is invalid. 指定的Filter.N.Key參數非法。

    訪問錯誤中心查看更多錯誤碼。

    變更歷史

    更多資訊，參考變更詳情。