All Products
Search
Document Center

Global Accelerator:CreateAcl

Last Updated:Jun 01, 2023

Creates an access control list (ACL).

Operation Description

CreateAcl is an asynchronous operation. After you send a request, the system returns a request ID, but the operation is still being performed in the system background. You can call the GetAcl or ListAcls operation to query the state of an ACL.

  • If the ACL is in the init state, the ACL is being created. In this case, you can only perform only query operations.
  • If the ACL is in the active state, the ACL is created.

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
ga:CreateAclWrite
  • Ga
    acs:ga:{#regionId}:{#accountId}:acl/*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The ID of the region where the Global Accelerator (GA) instance is deployed. Set the value to cn-hangzhou.

cn-hangzhou
AclNamestringNo

The name of the ACL. 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-acl
AddressIPVersionstringYes

The IP version of the ACL. Valid values:

  • IPv4
  • IPv6
IPv4
AclEntriesobject []No

The ACL entries.

EntrystringNo

The IP address(192.168.XX.XX) or CIDR(10.0.XX.XX/24) block that you want to add to the ACL.

You can add up to 20 entries in each request.

10.0.XX.XX/24
EntryDescriptionstringNo

The description of the entry that you want to add to the ACL.

You can add the descriptions of up to 20 entries in each request.

The description must be 1 to 256 characters in length, and can contain letters, digits, hyphens (-), forward slashes (/), periods (.), and underscores (_).

test-entry
ClientTokenstringNo

The client token that is used to ensure the idempotence of the request.

You can use the client to generate the value, but you must make sure that it is unique among different requests. The client token can contain only ASCII characters.

NoteIf you do not set this parameter, ClientToken is set to the value of RequestId. The value of RequestId may be different for each API request.
5A2CFF0E-5718-45B5-9D4D-70B3FF3898
DryRunbooleanNo

Specifies whether to only precheck the request. Default value: false. Valid values:

  • true: prechecks the request without performing the operation. The system checks the required parameters, request syntax, and limits. If the request fails the precheck, an error message is returned. If the request passes the precheck, the DryRunOperation error code is returned.
  • false: sends the request. If the request passes the precheck, a 2xx HTTP status code is returned and the operation is performed.
false
ResourceGroupIdstringNo

The ID of the resource group.

rg-acfmwj7wvng3jbi

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

CEF72CEB-54B6-4AE8-B225-F876FF7BA984
AclIdstring

The ID of the ACL.

nacl-hp34s2h0xx1ht4nwo****

Examples

Sample success responses

JSONformat

{
  "RequestId": "CEF72CEB-54B6-4AE8-B225-F876FF7BA984",
  "AclId": "nacl-hp34s2h0xx1ht4nwo****"
}

Error codes

HTTP status codeError codeError messageDescription
400IsExist.AclEntriesIsExistacl entries %s is existThe ACL entry %s already exists.
400QuotaExceeded.AclEntriesThe number of acl entries exceeds the limitThe number of entries in the ACL exceeds the upper limit.

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

Change history

Change timeSummary of changesOperation
2023-04-20The error codes of the API operation change.
Change itemChange content
Error CodesThe error codes of the API operation change.
    delete Error Codes: 400
2023-03-31The error codes of the API operation change.,The input parameters of the API operation change.
Change itemChange content
Error CodesThe error codes of the API operation change.
    delete Error Codes: 400
Input ParametersThe input parameters of the API operation change.
    Added Input Parameters: Tag
2021-04-27Add Operation