全部產品
Search

搜尋本產品

    Cloud Storage Gateway：DescribeTasks - 查詢任務資訊

    文件中心

    Cloud Storage Gateway：DescribeTasks - 查詢任務資訊

    更新時間：Dec 18, 2025

    查詢指定任務對應的資訊。包括任務的進度和任務名稱等。

    調試

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

    調試

    授權資訊

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

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

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

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

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

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

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

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

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    hcs-sgw:DescribeTasks

    get

    *全部資源

    *

    		 無 無

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    TargetId

    string

    是

    任務所屬物件識別碼。網關 ID 或者極速同步群組 ID。

    sync-0001xv757xl9sn548***
    PageNumber

    integer

    否

    工作清單資訊的頁碼。

    • 起始值：1。

    • 預設值：1。

    1
    PageSize

    integer

    否

    分頁查詢時設定的每頁行數。

    • 最大值：50。

    • 預設值：10。

    10
    TaskId

    string

    否

    任務 ID。如果為空白，則枚舉所有任務。

    t-0001xv7je357xl9n***

    返回參數

    名稱

    類型

    描述

    樣本值

    object

    TotalCount

    integer

    任務的總個數。

    1
    Tasks

    object

    SimpleTask

    array<object>

    任務資訊。

    object

    StateCode

    string

    任務狀態代碼。可能值：

    • task.state.Initialized：初始化。

    • task.state.Running：運行中。

    • task.state.completed：已完成。

    • task.state.Failed：失敗。

    task.state.completed
    Progress

    integer

    任務進度百分比。

    100
    UpdatedTime

    integer

    任務資訊最後修改時間戳記。單位為秒（s）。

    1578367230
    MessageKey

    string

    任務出錯時候的代碼。

    xxx
    Name

    string

    任務名稱。

    task.name.operate_fast_sync.delete
    CreatedTime

    integer

    任務建立時間戳記。單位為秒（s）。

    1578367229
    TaskId

    string

    任務 ID。

    t-0001xv7je357xl9n***
    RelatedResourceId

    string

    關聯的資源 ID。

    NFSnfstest
    RequestId

    string

    請求 ID。

    8E9C6D43-4603-4F05-BE76-677A05EDFB7A
    Message

    string

    請求結果描述。

    successful
    PageSize

    integer

    工作清單資訊的每頁行數。

    10
    PageNumber

    integer

    任務資訊的頁碼。

    1
    Code

    string

    狀態代碼。狀態代碼為 200 表示請求成功。

    200
    Success

    boolean

    請求是否成功。

    true

    樣本

    正常返回樣本

    JSON格式

    {
  "TotalCount": 1,
  "Tasks": {
    "SimpleTask": [
      {
        "StateCode": "task.state.completed",
        "Progress": 100,
        "UpdatedTime": 1578367230,
        "MessageKey": "xxx",
        "Name": "task.name.operate_fast_sync.delete",
        "CreatedTime": 1578367229,
        "TaskId": "t-0001xv7je357xl9n***",
        "RelatedResourceId": "NFSnfstest"
      }
    ]
  },
  "RequestId": "8E9C6D43-4603-4F05-BE76-677A05EDFB7A",
  "Message": "successful",
  "PageSize": 10,
  "PageNumber": 1,
  "Code": "200",
  "Success": true
}

    錯誤碼

    HTTP status code

    錯誤碼

    錯誤資訊

    描述
    400 EmptyTargetId You must enter a valid ID for the target gateway. 目標網關ID不可為空。
    400 BadPageSize The specified number of pages is invalid. The number ranges from 1 to 50. 無效的頁數，取值範圍：1~50。
    400 BadPageNumber The specified page number is invalid. The page number must be greater than 0. 無效的頁碼，不能小於0。

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

    變更歷史

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