文档

DescribeTaskAttribute - 查询异步任务的详细信息

更新时间:

调用DescribeTaskAttribute查询异步任务的详细信息。目前,可以查询的异步任务有导入镜像(ImportImage)、导出镜像(ExportImage)及变更云盘类型(ModifyDiskSpec)。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
ecs:DescribeTaskAttributeRead
  • 全部资源
    *

请求参数

名称类型必填描述示例值
RegionIdstring

地域 ID。您可以调用 DescribeRegions 查看最新的阿里云地域列表。

cn-hangzhou
TaskIdstring

任务 ID。您可以调用 DescribeTasks 查看任务 ID。

t-ce946ntx4wr****

返回参数

名称类型描述示例值
object
CreationTimestring

任务创建时间。

2015-11-23T02:13Z
SupportCancelstring

是否可以取消任务( CancelTask )。取值范围:

  • true:可以取消
  • false:无法取消
true
TotalCountinteger

任务总数。

1
SuccessCountinteger

成功任务数。

1
RegionIdstring

地域 ID。

cn-hangzhou
TaskActionstring

任务操作的接口名称。

ExportImage
FailedCountinteger

失败任务数。

0
RequestIdstring

请求 ID。

473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
TaskStatusstring

任务状态。

Finished
TaskProcessstring

任务进程。

100%
FinishedTimestring

任务完成时间。

2015-11-23T02:19Z
TaskIdstring

任务 ID。

t-ce946ntx4wr****
OperationProgressSetobject []

返回任务包含的信息,其中包括每一个子任务的状态和相关信息。

ErrorMsgstring

错误信息。

The specified RegionId parameter is invalid.
ErrorCodestring

错误代码。

ParameterInvalid
OperationStatusstring

操作状态。

Success
RelatedItemSetobject []

资源信息类型。

Namestring

相关项名称。

OSSObject
Valuestring

相关项值。

MYOSSPRE_m-23f8tcp***_t-23ym6mv***.vhd

示例

正常返回示例

JSON格式

{
  "CreationTime": "2015-11-23T02:13Z",
  "SupportCancel": "true",
  "TotalCount": 1,
  "SuccessCount": 1,
  "RegionId": "cn-hangzhou",
  "TaskAction": "ExportImage",
  "FailedCount": 0,
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "TaskStatus": "Finished",
  "TaskProcess": "100%",
  "FinishedTime": "2015-11-23T02:19Z",
  "TaskId": "t-ce946ntx4wr****",
  "OperationProgressSet": {
    "OperationProgress": [
      {
        "ErrorMsg": "The specified RegionId parameter is invalid.",
        "ErrorCode": "ParameterInvalid",
        "OperationStatus": "Success",
        "RelatedItemSet": {
          "RelatedItem": [
            {
              "Name": "OSSObject",
              "Value": "MYOSSPRE_m-23f8tcp***_t-23ym6mv***.vhd"
            }
          ]
        }
      }
    ]
  }
}

JSON格式

{
  "CreationTime": "2015-11-23T02:13Z",
  "SupportCancel": "true",
  "TotalCount": 1,
  "SuccessCount": 1,
  "RegionId": "cn-hangzhou",
  "TaskAction": "ExportImage",
  "FailedCount": 0,
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "TaskStatus": "Finished",
  "TaskProcess": "100%",
  "FinishedTime": "2015-11-23T02:19Z",
  "TaskId": "t-ce946ntx4wr****",
  "OperationProgressSet": {
    "OperationProgress": [
      {
        "ErrorMsg": "The specified RegionId parameter is invalid.",
        "ErrorCode": "ParameterInvalid",
        "OperationStatus": "Success",
        "RelatedItemSet": {
          "RelatedItem": [
            {
              "Name": "OSSObject",
              "Value": "MYOSSPRE_m-23f8tcp***_t-23ym6mv***.vhd"
            }
          ]
        }
      }
    ]
  }
}

错误码

HTTP status code错误码错误信息描述
400InvalidRegionId.NotFoundThe specified RegionId does not exist.指定的地域 ID 不存在。
400MissingParameterAn input parameter "RegionId" that is mandatory for processing the request is not supplied.-
400MissingParameterAn input parameter "TaskId" that is mandatory for processing the request is not supplied.-
400InvalidTaskId.NotFoundThe specified "TaskId" is not found.-

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

  • 本页导读 (1)