GetTask - Service Catalog - Alibaba Cloud Documentation Center

Queries the information about a task.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
TaskId	string	Yes	The ID of the task.	task-bp1dmg242c****

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
RequestId	string	The ID of the request.	0FEEF92D-4052-5202-87D0-3D8EC16F81BF
TaskDetail	object	The details of the task.
TaskId	string	The ID of the task.	task-bp1dmg242c****
TaskType	string	The type of the task. Valid values: LaunchProduct: a task that launches the product. UpdateProvisionedProduct: a task that updates the information about the product instance. TerminateProvisionedProduct: a task that terminates the product instance.	LaunchProduct
PortfolioId	string	The ID of the product portfolio.	port-bp1yt7582g****
ProductId	string	The ID of the product.	prod-bp18r7q127****
ProductName	string	The name of the product.	DEMO-Create an ECS instance
ProductVersionId	string	The ID of the product version.	pv-bp15e79d26****
ProductVersionName	string	The name of the product version.	1.0
ProvisionedProductId	string	The ID of the product instance.	pp-bp1ddg1n2a****
ProvisionedProductName	string	The name of the product instance.	DEMO-ECS instance
Parameters	object []	The parameters that are specified in the template.
ParameterKey	string	The name of the input parameter for the template.	instance_type
ParameterValue	string	The value of the input parameter for the template.	ecs.s6-c1m1.small
Outputs	object []	The output parameters of the template.
OutputKey	string	The name of the output parameter for the template.	instance_id
OutputValue	string	The value of the output parameter for the template.	i-xxxxxx
Description	string	The description of the output parameter for the template.	The ECS instance ID.
Log	object	The logs of the instance.
TerraformLogs	object []	The Terraform logs.
Command	string	The name of the Terraform command that is run. Valid values: apply plan destroy version For more information about Terraform commands, see Basic CLI Features.	apply
Stream	string	The output stream. Valid values: stdout: a standard output stream stderr: a standard error stream	stdout
Content	string	The content of the output stream that is returned after the command is run.	Apply complete! Resources: 42 added, 0 changed, 0 destroyed.
Status	string	The state of the task. Valid values: Succeeded: The task was successful. InProgress: The task was in progress. Failed: The task failed.	Succeeded
StatusMessage	string	The message that is returned for the status of the task. Note This parameter is returned only when Failed is returned for the Status parameter.	Resource CREATE failed: terraform stack sc-146611588617**-pp-bp1ddg1n2a** failure...
CreateTime	string	The time when the task was created. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.	2022-05-23T09:46:27Z
UpdateTime	string	The time when the task was last modified. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.	2022-05-23T09:47:29Z
TaskTags	object []	The custom tags.
Key	string	The custom tag key. The tag key can be up to 128 characters in length and cannot contain `http://` or `https://`. The tag key cannot start with `acs:` or `aliyun`.	k1
Value	string	The custom tag value. The value must be 1 to 128 characters in length. It cannot start with `acs:` and cannot contain `http://` or `https://`.	v1

Examples

Sample success responses

JSONformat

{
  "RequestId": "0FEEF92D-4052-5202-87D0-3D8EC16F81BF",
  "TaskDetail": {
    "TaskId": "task-bp1dmg242c****",
    "TaskType": "LaunchProduct",
    "PortfolioId": "port-bp1yt7582g****",
    "ProductId": "prod-bp18r7q127****",
    "ProductName": "DEMO-Create an ECS instance\n",
    "ProductVersionId": "pv-bp15e79d26****",
    "ProductVersionName": "1.0",
    "ProvisionedProductId": "pp-bp1ddg1n2a****",
    "ProvisionedProductName": "DEMO-ECS instance\n",
    "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"
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message
500	InternalError	A system error occurred.

For a list of error codes, visit the Service error codes.