Queries the attributes of an access control list (ACL).

Debug

Use OpenAPI Explorer to perform debug operations and generate SDK code examples.

Request parameters

Parameter Type Required? Example value Description
AclId String Yes acl-ohlexqptfhy******

The ID of the ACL.

RegionId String Yes cn-hangzhou

The ID of the region.

Action String No DescribeACLAttribute

The name of this action.

Value: DescribeACLAttribute.

Direction String No test

The rule direction.

Valid values: in|out.

Order String No 1255444444

The order number.

PageNumber Integer No 2

The page number. Default value: 1.

PageSize Integer No 10

The number of rows per page for a paged query. Maximum value: 50. Default value: 10.

Response parameters

Parameter Type Example value Description
Acrs

The ACL rule.

└AclId String acl-xhwhyuo43l*******

The ID of the ACL.

└AcrId String acr-oicr94jwtpij*******

The ID of the ACL rule.

└Description String Access rule

The description of the ACL rule. It must be 1 to 512 characters in length.

└DestCidr String 0.0.0.0/0

The destination IP address. It is an IPv4 address range in the CIDR format.

Default value: 0.0.0.0/0.

└DestPortRange String 12

The range of the destination port. Valid value: 80/80.

└Direction String in

The direction of the ACL rule.

Valid values: in|out.

└GmtCreate Long 1553077933000

The long-format timestamp of the ACL rule. If two ACL rules have the same priority, the ACL rule with the smaller timestamp takes effect first.

└IpProtocol String TCP

The protocol used by the ACL rule. The value is case insensitive.

└Policy String drop

The policy used by the ACL rule. Default value: drop|accept.

└Priority Integer 2

The priority of the ACL rule.

Value range: 1 to 100. Default value: 1.

└SourceCidr String 0.0.0.0/0

The source address. It is an IPv4 address range in the CIDR format.

Default value: 0.0.0.0/0.

└SourcePortRange String 30

The range of the source port. Valid value: 80/80.

PageNumber Integer 12

The page number. Default value: 1

PageSize Integer 5

The number of rows on each page for a paged query.

RequestId String 5DC67C13-B0E4-45E0-A60C-D32D3B74AB19

The ID of the request.

TotalCount Integer 12

The number of queried entries.

Examples

Request example


http(s)://[Endpoint]/? AclId=acl-ohlexqptfhy******
&RegionId=cn-hangzhou
&<CommonParameters>

Response example

XML format

<DescribeACLAttribute>
  <PageNumber>1</PageNumber>
  <Acrs>
    <Acr>
      <IpProtocol>TCP</IpProtocol>
      <SourceCidr>192.168.3.0/24</SourceCidr>
      <SourcePortRange>1/65535</SourcePortRange>
      <AclId>acl-xhwhyuo43l0******</AclId>
      <AcrId>acr-oicr94jwtpi*******</AcrId>
      <Policy>accept</Policy>
      <DestPortRange>1/65535</DestPortRange>
      <DestCidr>10.0.0.1/32</DestCidr>
      <GmtCreate>1553077933000</GmtCreate>
      <Direction>out</Direction>
      <Priority>1</Priority>
    </Acr>
  </Acrs>
  <TotalCount>1</TotalCount>
  <PageSize>10</PageSize>
  <RequestId>5DC67C13-B0E4-45E0-A60C-D32D3B74AB19</RequestId>
</DescribeACLAttribute>

JSON format

{
	"PageNumber":1,
	"Acrs":{
		"Acr":[
			{
				"IpProtocol":"TCP",
				"SourceCidr":"192.168.3.0/24",
				"SourcePortRange":"1/65535",
				"AcrId":"acr-oicr94jwtpi******",
				"AclId":"acl-xhwhyuo43l0n******",
				"Policy":"accept",
				"DestPortRange":"1/65535",
				"DestCidr":"10.0.0.1/32",
				"GmtCreate":1553077933000,
				"Direction":"out",
				"Priority":1
			}
		]
	},
	"TotalCount":1,
	"PageSize":10,
	"RequestId":"5DC67C13-B0E4-45E0-A60C-D32D3B74AB19"
}

Errors

HTTP status code Error code Error message Description
403 Forbidden User not authorized to operate on the specified resource. You are not authorized to use the specified resource.
403 MissingParameter The input parameter is missing, please check your input. The required parameter is missing.
403 InvalidParameter The specified parameter is invalid. The specified parameter is invalid.
403 InvalidId.ACL The specified ACL ID is invalid. The specified ACL ID is invalid.
403 InternalError An internal server error occurred. An internal server error has occurred.

For a list of error codes, visit the API Error Center.