文档

GetTask - 查询任务信息

更新时间:
一键部署

查询任务信息。

调试

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

授权信息

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

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

请求参数

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

任务 ID。

task-bp1dmg242c****

返回参数

名称类型描述示例值
object

返回参数。

RequestIdstring

请求 ID。

0FEEF92D-4052-5202-87D0-3D8EC16F81BF
TaskDetailobject

任务详情。

TaskIdstring

任务 ID。

task-bp1dmg242c****
TaskTypestring

任务类型。取值:

  • LaunchProduct:启动产品。
  • UpdateProvisionedProduct:更新实例。
  • TerminateProvisionedProduct:终止实例。
LaunchProduct
PortfolioIdstring

产品组合 ID。

port-bp1yt7582g****
ProductIdstring

产品 ID。

prod-bp18r7q127****
ProductNamestring

产品名称。

DEMO-创建ECS
ProductVersionIdstring

产品版本 ID。

pv-bp15e79d26****
ProductVersionNamestring

产品版本名称。

1.0
ProvisionedProductIdstring

实例 ID。

pp-bp1ddg1n2a****
ProvisionedProductNamestring

实例名称。

DEMO-ECS实例
Parametersobject []

用户输入的模板参数。

ParameterKeystring

模板中定义的参数名称。

instance_type
ParameterValuestring

用户输入的模板参数值。

ecs.s6-c1m1.small
Outputsobject []

模板的输出值。

OutputKeystring

模板中定义的输出值名称。

instance_id
OutputValuestring

模板中定义的输出值的内容。

i-xxxxxx
Descriptionstring

模板中定义的输出值的描述。

The ECS instance ID.
Logobject

实例相关输出日志。

TerraformLogsobject []

Terraform 输出日志。

Commandstring

执行的 Terraform 命令名称。取值:

  • apply
  • plan
  • destroy
  • version

关于命令含义的更多信息,请参见 Command

apply
Streamstring

输出流。取值:

  • stdout:标准输出。
  • stderr:标准错误输出。
stdout
Contentstring

当前命令在当前输出流中输出的内容。

Apply complete! Resources: 42 added, 0 changed, 0 destroyed.
Statusstring

任务状态。取值:

  • Succeeded:成功。
  • InProgress:运行中。
  • Failed:失败。
Succeeded
StatusMessagestring

任务状态信息。

说明 仅在任务状态为 Failed 时,返回该参数。
Resource CREATE failed: terraform stack sc-146611588617****-pp-bp1ddg1n2a**** failure...
CreateTimestring

任务创建时间。

按照 ISO8601 标准表示,使用 UTC 时间,格式:YYYY-MM-DDThh:mm:ssZ。

2022-05-23T09:46:27Z
UpdateTimestring

任务最后更新时间。

按照 ISO8601 标准表示,使用 UTC 时间,格式:YYYY-MM-DDThh:mm:ssZ。

2022-05-23T09:47:29Z
TaskTagsobject []

自定义标签。

Keystring

自定义标签键。

最多支持 128 个字符,不能以aliyunacs:开头,不能包含http://或者https://

k1
Valuestring

自定义标签值。

最多支持 128 个字符,不能以acs:开头,不能包含http://或者https://

v1

示例

正常返回示例

JSON格式

{
  "RequestId": "0FEEF92D-4052-5202-87D0-3D8EC16F81BF",
  "TaskDetail": {
    "TaskId": "task-bp1dmg242c****",
    "TaskType": "LaunchProduct",
    "PortfolioId": "port-bp1yt7582g****",
    "ProductId": "prod-bp18r7q127****",
    "ProductName": "DEMO-创建ECS",
    "ProductVersionId": "pv-bp15e79d26****",
    "ProductVersionName": "1.0",
    "ProvisionedProductId": "pp-bp1ddg1n2a****",
    "ProvisionedProductName": "DEMO-ECS实例",
    "Parameters": [
      {
        "ParameterKey": "instance_type",
        "ParameterValue": "ecs.s6-c1m1.small"
      }
    ],
    "Outputs": [
      {
        "OutputKey": "instance_id",
        "OutputValue": "i-xxxxxx",
        "Description": "The ECS instance ID."
      }
    ],
    "Log": {
      "TerraformLogs": [
        {
          "Command": "apply",
          "Stream": "stdout",
          "Content": "Apply complete! Resources: 42 added, 0 changed, 0 destroyed."
        }
      ]
    },
    "Status": "Succeeded",
    "StatusMessage": "Resource CREATE failed: terraform stack sc-146611588617****-pp-bp1ddg1n2a**** failure...",
    "CreateTime": "2022-05-23T09:46:27Z",
    "UpdateTime": "2022-05-23T09:47:29Z",
    "TaskTags": [
      {
        "Key": "k1",
        "Value": "v1"
      }
    ]
  }
}

错误码

HTTP status code错误码错误信息描述
500InternalErrorA system error occurred.内部错误。

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