Queries tasks.
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:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level,
All Resourcesis 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.
| Operation | Access level | Resource type | Condition key | Association operation |
|---|---|---|---|---|
| servicecatalog:ListTasks | List |
|
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| SortBy | string | No | The field that is used to sort the queried data. Set the value to CreateTime, which specifies the time when the task was created. | CreateTime |
| SortOrder | string | No | The order in which you want to sort the queried data. Valid values:
| Desc |
| PageNumber | integer | No | The number of the page to return. Pages start from page 1. Default value: 1. | 1 |
| PageSize | integer | No | The number of entries to return on each page. Valid values: 1 to 100. Default value: 10. | 10 |
| ProvisionedProductId | string | Yes | The ID of the product instance. | pp-bp1ddg1n2a**** |
Response parameters
Examples
Sample success responses
JSONformat
{
"TaskDetails": [
{
"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-26T03:28:45Z"
}
],
"RequestId": "0FEEF92D-4052-5202-87D0-3D8EC16F81BF",
"TotalCount": 2,
"PageNumber": 1,
"PageSize": 10
}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.