All Products
Search
Document Center

Service Catalog:GetTask

Last Updated:Jul 25, 2025

Queries the information about a task.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • For mandatory resource types, indicate with a prefix of * .
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
servicecatalog:GetTaskget
*ProvisionedProduct
acs:servicecatalog:{#regionId}:{#accountId}:provisionedproduct/{#ProvisionedProductId}
  • servicecatalog:UserLevel
  • servicecatalog:ApprovalActor
none

Request parameters

ParameterTypeRequiredDescriptionExample
TaskIdstringYes

The ID of the task.

task-bp1dmg242c****

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

RequestIdstring

The ID of the request.

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

The details of the task.

TaskIdstring

The ID of the task.

task-bp1dmg242c****
TaskTypestring

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
PortfolioIdstring

The ID of the product portfolio.

port-bp1yt7582g****
ProductIdstring

The ID of the product.

prod-bp18r7q127****
ProductNamestring

The name of the product.

DEMO-Create an ECS instance
ProductVersionIdstring

The ID of the product version.

pv-bp15e79d26****
ProductVersionNamestring

The name of the product version.

1.0
ProvisionedProductIdstring

The ID of the product instance.

pp-bp1ddg1n2a****
ProvisionedProductNamestring

The name of the product instance.

DEMO-ECS instance
Parametersarray<object>

The parameters that are specified in the template.

Parameterobject
ParameterKeystring

The name of the input parameter for the template.

instance_type
ParameterValuestring

The value of the input parameter for the template.

ecs.s6-c1m1.small
Outputsarray<object>

The output parameters of the template.

Outputobject
OutputKeystring

The name of the output parameter for the template.

instance_id
OutputValuestring

The value of the output parameter for the template.

i-xxxxxx
Descriptionstring

The description of the output parameter for the template.

The ECS instance ID.
Logobject

The logs of the instance.

TerraformLogsarray<object>

The Terraform logs.

TerraformLogobject
Commandstring

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
Streamstring

The output stream. Valid values:

  • stdout: a standard output stream
  • stderr: a standard error stream
stdout
Contentstring

The content of the output stream that is returned after the command is run.

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

The state of the task. Valid values:

  • Succeeded: The task was successful.
  • InProgress: The task was in progress.
  • Failed: The task failed.
Succeeded
StatusMessagestring

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...
CreateTimestring

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
UpdateTimestring

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
TaskTagsarray<object>

The custom tags.

TaskTagobject
Keystring

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
Valuestring

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,
    "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 codeError codeError message
500InternalErrorA system error occurred.

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