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

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

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 AScript rule.
AScriptName	string	Yes	The name of the AScript rule. The name must be 2 to 128 character in length, and can contain letters, digits, periods (.), underscores (_), and hyphens (-). It must start with a letter.	test
Enabled	boolean	No	Specifies whether to enable 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 attributes.
	object	No
AttributeKey	string	No	The attribute name. Set the value to EsDebug, which specifies that if requests carry the _es_dbg parameter and the value is the specified key, the debugging header is enabled to output the execution result.	EsDebug
AttributeValue	string	No	The attribute value, which must be 1 to 128 characters in length, and can contain letters or digits.	test123
ExtAttributeEnabled	boolean	No	Specifies whether to enable the extended attributes 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.
	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	Description
400	IncorrectStatus.Listener	The status of %s [%s] is incorrect.	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