调用GetTask查询任务信息_服务目录(Service Catalog)-阿里云帮助中心

查询任务信息。

调试

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

授权信息

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

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

操作	访问级别	资源类型	条件关键字	关联操作
servicecatalog:GetTask	Read	ProvisionedProduct acs:servicecatalog:{#regionId}:{#accountId}:provisionedproduct/{#ProvisionedProductId}	servicecatalog:UserLevel servicecatalog:ApprovalActor	无

请求参数

名称	类型	必填	描述	示例值
TaskId	string	是	任务 ID。	task-bp1dmg242c****

返回参数

名称	类型	描述	示例值
	object	返回参数。
RequestId	string	请求 ID。	0FEEF92D-4052-5202-87D0-3D8EC16F81BF
TaskDetail	object	任务详情。
TaskId	string	任务 ID。	task-bp1dmg242c****
TaskType	string	任务类型。取值： LaunchProduct：启动产品。 UpdateProvisionedProduct：更新实例。 TerminateProvisionedProduct：终止实例。	LaunchProduct
PortfolioId	string	产品组合 ID。	port-bp1yt7582g****
ProductId	string	产品 ID。	prod-bp18r7q127****
ProductName	string	产品名称。	DEMO-创建ECS
ProductVersionId	string	产品版本 ID。	pv-bp15e79d26****
ProductVersionName	string	产品版本名称。	1.0
ProvisionedProductId	string	实例 ID。	pp-bp1ddg1n2a****
ProvisionedProductName	string	实例名称。	DEMO-ECS实例
Parameters	object []	用户输入的模板参数。
ParameterKey	string	模板中定义的参数名称。	instance_type
ParameterValue	string	用户输入的模板参数值。	ecs.s6-c1m1.small
Outputs	object []	模板的输出值。
OutputKey	string	模板中定义的输出值名称。	instance_id
OutputValue	string	模板中定义的输出值的内容。	i-xxxxxx
Description	string	模板中定义的输出值的描述。	The ECS instance ID.
Log	object	实例相关输出日志。
TerraformLogs	object []	Terraform 输出日志。
Command	string	执行的 Terraform 命令名称。取值： apply plan destroy version 关于命令含义的更多信息，请参见 Command 。	apply
Stream	string	输出流。取值： stdout：标准输出。 stderr：标准错误输出。	stdout
Content	string	当前命令在当前输出流中输出的内容。	Apply complete! Resources: 42 added, 0 changed, 0 destroyed.
Status	string	任务状态。取值： Succeeded：成功。 InProgress：运行中。 Failed：失败。	Succeeded
StatusMessage	string	任务状态信息。说明仅在任务状态为 Failed 时，返回该参数。	Resource CREATE failed: terraform stack sc-146611588617**-pp-bp1ddg1n2a** failure...
CreateTime	string	任务创建时间。按照 ISO8601 标准表示，使用 UTC 时间，格式：YYYY-MM-DDThh:mm:ssZ。	2022-05-23T09:46:27Z
UpdateTime	string	任务最后更新时间。按照 ISO8601 标准表示，使用 UTC 时间，格式：YYYY-MM-DDThh:mm:ssZ。	2022-05-23T09:47:29Z
TaskTags	object []	自定义标签。
Key	string	自定义标签键。最多支持 128 个字符，不能以`aliyun`和`acs:`开头，不能包含`http://`或者`https://`。	k1
Value	string	自定义标签值。最多支持 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	错误码	错误信息	描述
500	InternalError	A system error occurred.	内部错误。

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