调用DescribeTasks查询指定任务对应的信息_云存储网关(CSG)-阿里云帮助中心

调试

您可以在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。

访问错误中心查看更多错误码。