DescribeACLs - - 阿里雲

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters


Parameter	Type	Required	Example	Description
Action	String	Yes	DescribeACLs	The operation that you want to perform. Set the value to DescribeACLs.
RegionId	String	Yes	cn-shanghai	The ID of the region where the ACL is deployed.
AclIds	String	No	acl-xhwhyuo43l*******	The ID of the ACL. If you want to query multiple ACLs at the same time, separate the ACL IDs with commas (,). If you do not set this parameter, all ACLs in the specified region are queried.
Name	String	No	test	The name of the ACL. The name must be 2 to 100 characters in length, and can contain letters, digits, periods (.), underscores (_), and hyphens (-). It must start with a letter.
PageSize	Integer	No	10	The number of entries to return on each page. Maximum value: 50. Default value: 10.
PageNumber	Integer	No	1	The number of the page to return. Default value: 1.
AclType	String	No	acl-hardware	The type of the SAG instance associated with the ACL. Valid values: acl-hardware: SAG CPE instance acl-software: SAG app instance

Response parameters


Parameter	Type	Example	Description
TotalCount	Integer	1	The total number of entries returned.
PageSize	Integer	10	The number of entries returned per page.
RequestId	String	660F303F-C88E-4026-BC6A-FC24B78FD7EA	The ID of the request.
PageNumber	Integer	1	The page number of the returned page.
Acls	Array of Acl		A list of ACLs.
Acl
SagCount	String	0	The number of SAG instances associated with the ACL.
AclId	String	acl-xhwhyuo43l*******	The ID of the ACL.
Name	String	test	The name of the ACL.
ResourceGroupId	String	rg-acfm2iu4fnc****	The ID of the resource group to which the ACL belongs.
AclType	String	acl-hardware	The type of the SAG instance associated with the ACL. Valid values: acl-hardware: SAG CPE instance acl-software: SAG app instance

Examples

Sample requests

http(s)://[Endpoint]/?Action=DescribeACLs
&RegionId=cn-shanghai
&AclIds=acl-xhwhyuo43l*******
&Name=test
&PageSize=10
&PageNumber=1
&AclType=acl-hardware
&Common request parameters

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeACLsResponse>
    <TotalCount>1</TotalCount>
    <PageSize>10</PageSize>
    <RequestId>660F303F-C88E-4026-BC6A-FC24B78FD7EA</RequestId>
    <PageNumber>1</PageNumber>
    <Acls>
        <SagCount>0</SagCount>
        <AclId>acl-xhwhyuo43l*******</AclId>
        <Name>test</Name>
        <ResourceGroupId>rg-acfm2iu4fnc****</ResourceGroupId>
        <AclType>acl-hardware</AclType>
    </Acls>
</DescribeACLsResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "TotalCount" : 1,
  "PageSize" : 10,
  "RequestId" : "660F303F-C88E-4026-BC6A-FC24B78FD7EA",
  "PageNumber" : 1,
  "Acls" : [ {
    "SagCount" : "0",
    "AclId" : "acl-xhwhyuo43l*******",
    "Name" : "test",
    "ResourceGroupId" : "rg-acfm2iu4fnc****",
    "AclType" : "acl-hardware"
  } ]
}

Error codes


HttpCode	Error code	Error message	Description
403	Forbidden	User not authorized to operate on the specified resource.	The error message returned because you do not have the permissions to manage the specified resource.
403	MissingParameter	The input parameter is missing, please check your input.	The error message returned because one or more required parameters are empty. Check whether you have configured all required parameters.
403	InvalidParameter	The specified parameter is invalid.	The error message returned because a parameter is set to an invalid value.
403	InternalError	An internal server error occurred.	The error message returned because an internal server error occurred.

For a list of error codes, see Service error codes.