All Products
Search
Document Center

Smart Access Gateway:DescribeACLs

Last Updated:Mar 03, 2024

Queries access control lists (ACLs) in a specified region.

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
smartag:DescribeACLsRead
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The ID of the region where the ACL is deployed.

cn-shanghai
AclIdsstringNo

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.
acl-xhwhyuo43l*******
NamestringNo

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.

test
PageSizeintegerNo

The number of entries to return on each page. Maximum value: 50. Default value: 10.

10
PageNumberintegerNo

The number of the page to return. Default value: 1.

1
AclTypestringNo

The type of the SAG instance associated with the ACL. Valid values:

  • acl-hardware: SAG CPE instance
  • acl-software: SAG app instance
acl-hardware

Response parameters

ParameterTypeDescriptionExample
object
TotalCountinteger

The total number of entries returned.

1
PageSizeinteger

The number of entries returned per page.

10
RequestIdstring

The ID of the request.

660F303F-C88E-4026-BC6A-FC24B78FD7EA
PageNumberinteger

The page number of the returned page.

1
Aclsobject []

A list of ACLs.

SagCountstring

The number of SAG instances associated with the ACL.

0
AclIdstring

The ID of the ACL.

acl-xhwhyuo43l*******
Namestring

The name of the ACL.

test
ResourceGroupIdstring

The ID of the resource group to which the ACL belongs.

rg-acfm2iu4fnc****
AclTypestring

The type of the SAG instance associated with the ACL. Valid values:

  • acl-hardware: SAG CPE instance
  • acl-software: SAG app instance
acl-hardware

Examples

Sample success responses

JSONformat

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

Error codes

HTTP status codeError codeError messageDescription
403ForbiddenUser not authorized to operate on the specified resource.You do not have permissions to manage the specified resource.
403MissingParameterThe input parameter is missing, please check your input.Missing parameters. Check whether all required parameters are set.
403InvalidParameterThe specified parameter is invalid.Invalid parameters.
403InternalErrorAn internal server error occurred.An internal server error occurred.

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

Change history

Change timeSummary of changesOperation
2022-09-06The Error code has changed. The request parameters of the API has changed. The response structure of the API has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 403
Input ParametersThe request parameters of the API has changed.
    Added Input Parameters: AclType
Output ParametersThe response structure of the API has changed.