查询指定任务对应的信息。包括任务的进度和任务名称等。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| hcs-sgw:DescribeTasks | get | *全部资源 * |
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| TargetId | string | 是 | 任务所属对象 ID。网关 ID 或者极速同步组 ID。 | sync-0001xv757xl9sn548*** |
| PageNumber | integer | 否 | 任务列表信息的页码。
| 1 |
| PageSize | integer | 否 | 分页查询时设置的每页行数。
| 10 |
| TaskId | string | 否 | 任务 ID。如果为空，则枚举所有任务。 | t-0001xv7je357xl9n*** |
返回参数
示例
正常返回示例
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。 |
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|
暂无变更历史