CreateAScripts - Server Load Balancer - Alibaba Cloud Documentation Center

Creates AScript rules.

Operation description

Prerequisites

A standard or WAF-enabled Application Load Balancer (ALB) instance is created. For more information, see CreateLoadBalancer.

Usage notes

CreateAScripts an asynchronous operation. After a request is sent, the system returns a request ID and runs the task in the background. You can call the ListAScripts operation to query the status of a script.

If the script is in the Creating state, the script is being created.
If the script is in the Available, the script is created.

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

create

*LoadBalancer

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

None

Request parameters

Parameter	Type	Required	Description	Example
ClientToken	string	No	The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters.	5A2CFF0E-5718-45B5-9D4D-70B******
DryRun	boolean	No	Specifies whether to perform only a dry run, without performing the actual request. Valid values: true: performs only a dry run. The system checks the request for potential issues, including missing parameter values, incorrect request syntax, and service limits. If the request fails the dry run, an error message is returned. If the request passes the dry run, the `DryRunOperation` error code is returned. false(default): performs a dry run and performs the actual request. If the request passes the dry run, a 2xx HTTP status code is returned and the operation is performed.	false
ListenerId	string	Yes	The listener ID.	lsn-6hfq3zs0x04ibn****
AScripts	array<object>	No	The information about the AScript rules.
	array<object>	No	The information about the AScript rule.
AScriptName	string	Yes	The name of the AScript rule. The length must be between 2 and 128 characters. This name must start with a letter and can contain letters, digits, periods (.), underscores (_), and hyphens (-).	test
Position	string	No	The position where the Ascript rule is evaluated. Valid values are: RequestHead (default): before inbound rules are evaluated RequestFoot: after inbound rules are evaluated ResponseHead: before outbound rules are evaluated	RequestFoot
Enabled	boolean	No	Enables the AScript rule. Valid values: true false (default)	false
ScriptContent	string	Yes	The content of the AScript rule.	if and(match_re($uri, '^/1.txt$'), $arg_type) { rewrite(concat('/1.', $arg_type), 'break') }
ExtAttributes	array<object>	No	The extended attribute of the AScript rule.
	object	No
AttributeKey	string	No	The key of the extended attribute. You can only set the key to EsDebug. This extended attribute adds a debug response header to record the execution of the AScript rule if the client request includes the _es_dbg parameter and its value matches the specified value of the extended attribute.	EsDebug
AttributeValue	string	No	The value of the extended attribute, which can contain a maximum of 128 characters, including letters and digits.	test123
ExtAttributeEnabled	boolean	No	Enables the extended attribute of the Ascript rule. Valid values: true false (default)	true

Response elements

Element	Type	Description	Example
	object	The AScript rules that are created.
JobId	string	The asynchronous task ID.	5c607642-535e-4e06-9d77-df53049b****
RequestId	string	The request ID.	BF0FE763-9603-558F-A55B-0F4******
AScriptIds	array<object>	The AScript rule IDs.
	object	The AScript rule ID.
AScriptId	string	The AScript rule ID.	as-xvq5igaa7uv6vr****

Examples

Success response

JSON format

{
  "JobId": "5c607642-535e-4e06-9d77-df53049b****",
  "RequestId": "BF0FE763-9603-558F-A55B-0F4******",
  "AScriptIds": [
    {
      "AScriptId": "as-xvq5igaa7uv6vr****"
    }
  ]
}

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.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.