All Products
Search

This Product

    Server Load Balancer:CreateAScripts

    Document Center

    Server Load Balancer:CreateAScripts

    Last Updated:Mar 01, 2024

    Creates AScript rules.

    Operation description

    Prerequisites

    • A standard or WAF-enabled Application Load Balancer (ALB) instance is created. For more information, see CreateLoadBalancer .
    • By default, the feature to create and manage AScript rules is unavailable. Log on to the Quota Center console. On the Privileges page, enter the quota ID slb_user_visible_gray_label/ascript and apply for the quota.

    Usage notes

    • CreateAScripts is 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 the task:

      • If an AScript rule is in the Creating state, the AScript rule is being created.
      • If an AScript rule is in the Available state, the AScript rule is created.

    • In the following table, the value of N is 1.

    Debugging

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

    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:
      • The required resource types are displayed in bold characters.
      • 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.
    OperationAccess levelResource typeCondition keyAssociated operation
    alb:CreateAScriptsWrite
    • LoadBalancer
      acs:alb:{#regionId}:{#accountId}:loadbalancer/{#loadbalancerId}
      none
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    ClientTokenstringNo

    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
    DryRunbooleanNo

    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
    ListenerIdstringYes

    The listener ID.

    		lsn-6hfq3zs0x04ibn****
    AScriptsobject []No

    The AScript rules.

    AScriptNamestringYes

    The name of the AScript rule.

    The name must be 2 to 128 characters in length and can contain letters, digits, periods (.), underscores (_), and hyphens (-). The name must start with a letter.

    		test
    EnabledbooleanNo

    Specifies whether to enable the AScript rule. Valid values:

    • true
    • false (default)
    		false
    ScriptContentstringYes

    The content of the AScript rule.

    		if and(match_re($uri, '^/1.txt$'), $arg_type) { rewrite(concat('/1.', $arg_type), 'break') }

    Response parameters

    ParameterTypeDescriptionExample
    object

    The AScript rules that are created.

    JobIdstring

    The asynchronous task ID.

    		5c607642-535e-4e06-9d77-df53049b****
    RequestIdstring

    The request ID.

    		BF0FE763-9603-558F-A55B-0F4B9A3E3C02
    AScriptIdsobject []

    The AScript rule IDs.

    AScriptIdstring

    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 codeError codeError messageDescription
    400IncorrectStatus.ListenerThe status of %s [%s] is incorrect.The status of %s [%s] is incorrect.
    400ResourceQuotaExceeded.AScriptsNumThe quota of %s is exceeded for resource %s, usage %s/%s.-
    400ResourceQuotaExceeded.AScriptsTotalLinesNumThe quota of %s is exceeded for resource %s, usage %s/%s.-
    400ResourceQuotaExceeded.AScriptLinesNumThe 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 timeSummary of changesOperation
    2023-07-13The Error code has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      delete Error Codes: 400