ListTasks - Service Catalog - Alibaba Cloud Documentation Center

Queries a list of tasks.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

servicecatalog:ListTasks

get

*ProvisionedProduct

acs:servicecatalog:{#regionId}:{#accountId}:provisionedproduct/{#ProvisionedProductId}

servicecatalog:UserLevel
servicecatalog:ApprovalActor

None

Request parameters

Parameter	Type	Required	Description	Example
SortBy	string	No	The field to sort by. Set the value to `CreateTime`, which specifies the time when the task was created.	CreateTime
SortOrder	string	No	The sorting order. Valid values: Asc: in ascending order. Desc: in descending order.	Desc
PageNumber	integer	No	The page number. The value must be a positive integer. Default value: 1.	1
PageSize	integer	No	The number of entries per page. Valid values: 1 to 100. Default value: 10.	10
ProvisionedProductId	string	Yes	The instance ID.	pp-bp1ddg1n2a****

Response elements

Parameter	Type	Description	Example
	object	The response parameters.
TaskDetails	array<object>	The list of tasks.
	object	The details of the task.
TaskId	string	The task ID.	task-bp1dmg242c****
TaskType	string	The type of the task. Valid values: `LaunchProduct`: launches the instance. `UpdateProvisionedProduct`: updates the instance. `TerminateProvisionedProduct`: terminates the instance.	LaunchProduct
PortfolioId	string	The portfolio ID.	port-bp1yt7582g****
ProductId	string	The product ID.	prod-bp18r7q127****
ProductName	string	The product name.	DEMO-ECS
ProductVersionId	string	The product version ID.	pv-bp15e79d26****
ProductVersionName	string	The product version name.	1.0
ProvisionedProductId	string	The instance ID.	pp-bp1ddg1n2a****
ProvisionedProductName	string	The instance name.	Test-ECS
Parameters	array<object>	The template parameters entered by the user.
	object
ParameterKey	string	The name of the parameter defined in the template.	instance_type
ParameterValue	string	The value of the template parameter entered by the user.	ecs.s6-c1m1.small
Outputs	array<object>	The output of the template.
	object
OutputKey	string	The output key defined in the template.	instance_id
OutputValue	string	The output value defined in the template.	i-xxxxxx
Description	string	The output description defined in the template.	The ECS instance ID.
Log	object	The output logs of the instance.
TerraformLogs	array<object>	The Terraform output logs.
	object
Command	string	The name of the Terraform command that is executed. Valid values: apply plan destroy version For more information about the commands, see Command.	apply
Stream	string	The output stream. Valid values: stdout: standard output. stderr: standard error output.	stdout
Content	string	The content returned for the command in the output stream.	Apply complete! Resources: 42 added, 0 changed, 0 destroyed.
Status	string	The status of the task. Valid values: Succeeded InProgress Failed	Succeeded
StatusMessage	string	The status message of the task. Note This parameter is returned only when the task fails.	Resource CREATE failed: terraform stack sc-146611588617**-pp-bp1ddg1n2a** failure...
CreateTime	string	The time when the task was created. The time is displayed in UTC and follows the ISO 8601 standard. The format is YYYY-MM-DDThh:mm:ssZ.	2022-05-23T09:46:27Z
UpdateTime	string	The time when the task was last updated. The time is displayed in UTC and follows the ISO 8601 standard. The format is YYYY-MM-DDThh:mm:ssZ.	2022-05-26T03:28:45Z
RequestId	string	The request ID.	0FEEF92D-4052-5202-87D0-3D8EC16F81BF
TotalCount	integer	The total number of entries.	2
PageNumber	integer	The page number.	1
PageSize	integer	The number of entries per page.	10

Examples

Success response

JSON format

{
  "TaskDetails": [
    {
      "TaskId": "task-bp1dmg242c****",
      "TaskType": "LaunchProduct",
      "PortfolioId": "port-bp1yt7582g****",
      "ProductId": "prod-bp18r7q127****",
      "ProductName": "DEMO-ECS",
      "ProductVersionId": "pv-bp15e79d26****",
      "ProductVersionName": "1.0",
      "ProvisionedProductId": "pp-bp1ddg1n2a****",
      "ProvisionedProductName": "Test-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-26T03:28:45Z"
    }
  ],
  "RequestId": "0FEEF92D-4052-5202-87D0-3D8EC16F81BF",
  "TotalCount": 2,
  "PageNumber": 1,
  "PageSize": 10
}

Error codes

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

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.