使用DescribeTasks查詢任務狀態和進度 - Cloud Storage Gateway

調試

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

請求參數

名稱	類型	是否必選	樣本值	描述
Action	String	是	DescribeTasks	系統規定參數。取值：DescribeTasks。
TargetId	String	是	sync-0001xv757xl9sn548***	任務所屬對象ID。網關ID或者極速同步群組ID。
PageNumber	Integer	否	1	工作清單資訊的頁碼。起始值：1。預設值：1。
PageSize	Integer	否	10	分頁查詢時設定的每頁行數。最大值：50。預設值：10。
TaskId	String	否	t-0001xv7je357xl9n***	任務ID。如果為空白，則枚舉所有任務。

返回資料

名稱	類型	樣本值	描述
TotalCount	Integer	1	任務的總個數。
Tasks	Array of SimpleTask		任務資訊。
SimpleTask
StateCode	String	task.state.completed	任務狀態代碼。可能值： task.state.Initialized：初始化。 task.state.Running：運行中。 task.state.completed：已完成。 task.state.Failed：失敗。
Progress	Integer	100	任務進度百分比。
UpdatedTime	Long	1578367230	任務資訊最後修改時間戳記。單位為秒（s）。
MessageKey	String	xxx	任務出錯時候的代碼。
Name	String	task.name.operate_fast_sync.delete	任務名稱。
CreatedTime	Long	1578367229	任務建立時間戳記。單位為秒（s）。
TaskId	String	t-0001xv7je357xl9n***	任務ID。
RelatedResourceId	String	NFSnfstest	關聯的資源ID。
RequestId	String	8E9C6D43-4603-4F05-BE76-677A05EDFB7A	請求ID。
Message	String	successful	請求結果描述。
PageSize	Integer	10	工作清單資訊的每頁行數。
PageNumber	Integer	1	任務資訊的頁碼。
Code	String	200	狀態代碼。狀態代碼為200表示請求成功。
Success	Boolean	true	請求是否成功。

樣本

請求樣本

http(s)://[Endpoint]/?Action=DescribeTasks
&TargetId=sync-0001xv757xl9sn548***
&PageNumber=1
&PageSize=10
&TaskId=t-0001xv7je357xl9n***
&公用請求參數

正常返回樣本

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeTasksResponse>
    <TotalCount>1</TotalCount>
    <Tasks>
        <StateCode>task.state.completed</StateCode>
        <Progress>100</Progress>
        <UpdatedTime>1578367230</UpdatedTime>
        <MessageKey>xxx</MessageKey>
        <Name>task.name.operate_fast_sync.delete</Name>
        <CreatedTime>1578367229</CreatedTime>
        <TaskId>t-0001xv7je357xl9n***</TaskId>
        <RelatedResourceId>NFSnfstest</RelatedResourceId>
    </Tasks>
    <RequestId>8E9C6D43-4603-4F05-BE76-677A05EDFB7A</RequestId>
    <Message>successful</Message>
    <PageSize>10</PageSize>
    <PageNumber>1</PageNumber>
    <Code>200</Code>
    <Success>true</Success>
</DescribeTasksResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "TotalCount" : 1,
  "Tasks" : [ {
    "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
}

錯誤碼

HttpCode	錯誤碼	錯誤資訊	描述
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。

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