Use ListAsynJobs to query asynchronous tasks - Server Load Balancer - Alibaba Cloud - Server Load Balancer: Central de Documentação do Alibaba Cloud

Queries asynchronous tasks in a region.

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

alb:ListAsynJobs

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
JobIds	array	No	The asynchronous task IDs.
	string	No	The asynchronous task ID.	bp1bpn0kn9****
ResourceType	string	No	The type of the associated resource. Valid values: loadbalancer: an Application Load Balancer (ALB) instance listener: a listener rule: a forwarding rule acl: an access control list (ACL) securitypolicy: a security policy servergroup: a server group	acl
ResourceIds	array	No	The resource IDs.
	string	No	The resource ID.	alb-o8mszt95oamfjy****
ApiName	string	No	The name of the operation.	CreateLoadBalancer
BeginTime	integer	No	The start time of the task. This value is a UNIX timestamp in milliseconds.	2021-06-03T17:22Z
EndTime	integer	No	The end time of the task. This value is a UNIX timestamp in milliseconds.	2021-06-04T17:22Z
NextToken	string	No	The pagination token that is used in the next request to retrieve a new page of results. You do not need to specify this parameter for the first request. For subsequent requests, set this parameter to the NextToken value returned in the previous response.	FFmyTO70tTpLG6I3FmYAXGKPd****
MaxResults	integer	No	The number of entries per page. Valid values: 1 to 100. Default value: 20.	20

Response elements

Element	Type	Description	Example
	object	The tasks.
Jobs	array<object>	The tasks.
	object	The task.
ApiName	string	The name of the operation.	CreateLoadBalancer
CreateTime	integer	The time when the task was created. This value is a UNIX timestamp in milliseconds.	2134663231234
ErrorCode	string	The error code returned when Status is Failed.	506
ErrorMessage	string	The error message returned when Status is Failed.	AllocateEipAddress Failed
Id	string	The task ID.	365F4154-92F6-4AE4-92F8-7FF34B5****
ModifyTime	integer	The time when the task ended. This value is a UNIX timestamp in milliseconds.	2144663233315
OperateType	string	The type of the operation. Valid values: Create Update Delete	Create
ResourceId	string	The associated resource ID.	alb-o8mszt95oamfjy****
ResourceType	string	The type of the associated resource. Valid values: loadbalancer: an ALB instance listener: a listener rule: a forwarding rule acl: an ACL securitypolicy: a security policy servergroup: a server group	acl
Status	string	The status of the task. Valid values: Succeeded Failed Processing	Succeeded
MaxResults	integer	The number of entries per page.	10
NextToken	string	The pagination token. If a value is returned, use it as the NextToken value in the next request to retrieve more results. If NextToken is empty, no next page exists. If a value is returned for NextToken, the value indicates the start point of the next query.	FFmyTO70tTpLG6I3FmYAXGKPd****
RequestId	string	The request ID.	365F4154-92F6-4AE4-92F8-7FF34B540710
TotalCount	integer	The total number of entries returned.	1000

Examples

Success response

JSON format

{
  "Jobs": [
    {
      "ApiName": "CreateLoadBalancer",
      "CreateTime": 2134663231234,
      "ErrorCode": "506",
      "ErrorMessage": "AllocateEipAddress Failed",
      "Id": "365F4154-92F6-4AE4-92F8-7FF34B5****",
      "ModifyTime": 2144663233315,
      "OperateType": "Create",
      "ResourceId": "alb-o8mszt95oamfjy****",
      "ResourceType": "acl",
      "Status": "Succeeded"
    }
  ],
  "MaxResults": 10,
  "NextToken": "FFmyTO70tTpLG6I3FmYAXGKPd****",
  "RequestId": "365F4154-92F6-4AE4-92F8-7FF34B540710",
  "TotalCount": 1000
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.