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.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

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:
- For mandatory resource types, indicate with a prefix of * .
- If the permissions cannot be granted at the resource level, All Resources is 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	Associated operation
alb:CreateAScripts	create	*LoadBalancer `acs:alb:{#regionId}:{#accountId}:loadbalancer/{#loadbalancerId}`	none	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-70B3FF3898
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.
	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 parameters

Parameter	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-0F4B9A3E3C02
AScriptIds	array<object>	The AScript rule IDs.
AScriptId	object	The AScript rule ID.
AScriptId	string	The AScript rule ID.	as-xvq5igaa7uv6vr****

Examples

Sample success responses

JSONformat

{
  "JobId": "5c607642-535e-4e06-9d77-df53049b****",
  "RequestId": "BF0FE763-9603-558F-A55B-0F4B9A3E3C02",
  "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.

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2024-06-11	The Error code has changed	View Change Details
2024-06-11	The Error code has changed	View Change Details
2023-07-13	The Error code has changed	View Change Details