文档

GetTask - 查询任务

更新时间:

用户通过此接口查询指定任务详情。

接口说明

GET /api/v1/tasks/{taskId}。

调试

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

授权信息

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

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

请求语法

GET /api/v1/tasks/{taskId}

请求参数

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

任务 id。

task-433aead756057fff8189a7ce5****

返回参数

名称类型描述示例值
object

返回结构。

requestIdstring

请求 ID。

473469C7-AA6F-4DC5-B3DB-A3DC0DE3****
taskobject

任务信息。

taskIdstring

任务 ID。

task-433aead756057fff8189a7ce5****
productstring

产品 code。

ECS
resourceTypestring

资源类型。

Instance
regionIdstring

地域 ID。

cn-beijing
resourceIdstring

资源 ID。

i-8vbascjthm7kzhp3****
resourcePathstring

资源路径。相对资源 id,资源路径会包含完整的资源定位(父资源/子资源)。

Instance/i-8vbascjthm7kzhp3**** Instance/r-8vbf5abe31c9c4d4/Account/cctest
taskActionstring

任务操作类型(Create | Update | Delete)。

Create
statusstring

任务状态。

Pending 排队中

Running 进行中

Succeeded 成功完成

Failed 失败

Cancelling 取消中

Cancelled 已取消。

Succeeded
errorobject

任务错误信息。

codestring

错误码。

OperationFailure.OperationFailed
messagestring

错误信息

{ "requestId": "123****", "errorCode": "InvalidRamUser.NoPermission", "errorMsg": "Ram user is not authorized to perform the operation." }
createTimestring

任务创建时间

2022-10-09T00:46:03Z

示例

正常返回示例

JSON格式

{
  "requestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****",
  "task": {
    "taskId": "task-433aead756057fff8189a7ce5****",
    "product": "ECS",
    "resourceType": "Instance",
    "regionId": "cn-beijing",
    "resourceId": "i-8vbascjthm7kzhp3****\n",
    "resourcePath": "Instance/i-8vbascjthm7kzhp3****\nInstance/r-8vbf5abe31c9c4d4/Account/cctest",
    "taskAction": "Create",
    "status": "Succeeded",
    "error": {
      "code": "OperationFailure.OperationFailed",
      "message": "{\n     \"requestId\": \"123****\",\n     \"errorCode\": \"InvalidRamUser.NoPermission\",\n     \"errorMsg\": \"Ram user is not authorized to perform the operation.\"\n}"
    },
    "createTime": "2022-10-09T00:46:03Z"
  }
}

错误码

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

变更历史

变更时间变更内容概要操作
2023-07-04API 内部配置变更,不影响调用看变更集
变更项变更内容
API 内部配置变更,不影响调用