Smart Access Gateway:DescribeACLs - Smart Access Gateway - Alibaba Cloud - Smart Access Gateway

Calls DescribeACLs to query the information about access control instances in a specified region.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

smartag:DescribeACLs

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the access control instance.	cn-shanghai
AclIds	string	No	The access control instance ID. To query multiple access control instances simultaneously, separate multiple instance IDs with commas (,). If this parameter is not specified, information about all access control instances in the current region is queried.	acl-xhwhyuo43l*******
Name	string	No	The name of the access control instance. The name must be 2 to 100 characters in length and must start with an uppercase letter, lowercase letter, or Chinese character. The name can contain digits, underscores (_), periods (.), and hyphens (-).	test
PageSize	integer	No	The number of entries per page for a paginated query. Maximum value: 50. Default value: 10.	10
PageNumber	integer	No	The page number. Default value: 1.	1
AclType	string	No	The type of Smart Access Gateway (SAG) instance that the access control instance can be associated with. Valid values: acl-hardware: SAG hardware instance. acl-software: SAG app instance.	acl-hardware

Response elements

Element	Type	Description	Example
	object	The query result.
TotalCount	integer	The total number of entries.	1
PageSize	integer	The number of entries per page.	10
RequestId	string	The request ID.	660F303F-C88E-4026-BC6A-FC24B78FD7EA
PageNumber	integer	The page number.	1
Acls	object
Acl	array<object>	The list of access control instances.
	object	The information about the access control instance.
SagCount	string	The number of SAG instances associated with the ACL.	0
AclId	string	The ID of the ACL.	acl-xhwhyuo43l*******
Name	string	The name of the ACL.	test
ResourceGroupId	string	The ID of the resource group to which the ACL belongs.	rg-acfm2iu4fnc****
AclType	string	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

Success response

JSON format

{
  "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 code	Error code	Error message	Description
403	Forbidden	User not authorized to operate on the specified resource.	You do not have permissions to manage the specified resource.
403	MissingParameter	The input parameter is missing, please check your input.	Missing parameters. Check whether all required parameters are set.
403	InvalidParameter	The specified parameter is invalid.	Invalid parameters.
403	InternalError	An internal server error occurred.	An internal server error occurred.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.