Automate AScript Rule Updates via UpdateAScripts API - Application Load Balancer - Alibaba Cloud - Server Load Balancer

Updates one or more AScripts.

Operation description

UpdateAScripts is an asynchronous operation. After you send a request, the system returns a request ID and performs the update in the background. You can call the ListAScripts operation to query the update status of the AScripts:

A status of Configuring indicates that the AScript is being updated.
A status of Available indicates that the AScript is updated.

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:UpdateAScripts

update

*LoadBalancer

acs:alb:{#regionId}:{#accountId}:loadbalancer/{#LoadBalancerId}

None

Request parameters

Parameter	Type	Required	Description	Example
ClientToken	string	No	The client token used to ensure the idempotence of the request. You can generate a value on your client to ensure it is unique across requests. The client token can contain only ASCII characters. Note If you do not specify this parameter, the system uses the request's RequestId as the ClientToken. Each API request has a different RequestId.	b1f642ac-5558-4a36-b7d9-cf53******
DryRun	boolean	No	Specifies whether to perform a dry run. Valid values: true: performs a dry run to check the request without modifying the AScript resources. The system checks the request for potential issues, including missing required parameters, incorrect formatting, and service limits. If the request fails the dry run, an error is returned. If the request passes the dry run, the system returns the `DryRunOperation` error code. false (default): sends a normal request. If the request passes the check, the system returns a 2xx HTTP status code and performs the operation.	false
AScripts	array<object>	No	The AScripts to update.
	array<object>	No	The information about the AScript.
AScriptName	string	No	The name of the AScript. The name must be 2 to 128 characters in length. It must start with a letter, a Chinese character, or a digit, and can contain letters, Chinese characters, digits, periods (.), underscores (_), hyphens (-), and spaces.	Group1
Enabled	boolean	No	Specifies whether to enable the AScript. Valid values: true: The AScript is enabled. false (default): The AScript is disabled.	true
ScriptContent	string	No	The content of the AScript.	if and(match_re($uri, '^/1.txt$'), $arg_type) { rewrite(concat('/1.', $arg_type), 'break') }
ExtAttributes	array<object>	No	The extended attributes.
	object	No
AttributeKey	string	Yes	The key of the extended attribute. The only valid value is EsDebug. If a request contains the _es_dbg parameter and its value matches the secret key configured here, the system enables debug response headers that output the rule execution logs.	EsDebug
AttributeValue	string	Yes	The attribute value. The value must be 1 to 128 characters long and can contain only letters and digits. The value is case-sensitive.	test123
AScriptId	string	Yes	The ID of the AScript.	as-mhqxcanmivn4g5****
ExtAttributeEnabled	boolean	No	Specifies whether to enable the extended attributes of the AScript. Valid values: true: The extended attributes are enabled. false (default): The extended attributes are disabled.	true

Response elements

Element	Type	Description	Example
	object	The response parameters.
JobId	string	The asynchronous task ID.	2e82b5f4-1ba9-4d20-89c8-1082ebaa****
RequestId	string	The request ID.	ACA19FE1-C09E-53C7-8FDA-560******

Examples

Success response

JSON format

{
  "JobId": "2e82b5f4-1ba9-4d20-89c8-1082ebaa****",
  "RequestId": "ACA19FE1-C09E-53C7-8FDA-560******"
}

Error codes

HTTP status code	Error code	Error message
400	IncorrectStatus.Listener	The status of %s [%s] is incorrect.
400	ResourceQuotaExceeded.AScriptsNum	The quota of %s is exceeded for resource %s, usage %s/%s.
400	ResourceQuotaExceeded.AScriptsTotalLinesNum	The quota of %s is exceeded for resource %s, usage %s/%s.
400	ResourceQuotaExceeded.AScriptLinesNum	The quota of %s is exceeded for resource %s, usage %s/%s.
404	ResourceNotFound.Ascript	The specified resource of %s is not found.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.