All Products
Search
Document Center

API Gateway:DescribeAccessControlListAttribute

Last Updated:Mar 06, 2025

This feature provides instance-level access control for dedicated instances. Queries the details of an access control policy.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

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:
    • For mandatory resource types, indicate with a prefix of * .
    • 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
apigateway:DescribeAccessControlListAttributeget
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
AclIdstringYes

The ID of the access control policy.

acl-3nsohdozz0ru8fi5onwz1

Response parameters

ParameterTypeDescriptionExample
object
AclIdstring

The ID of the access control policy.

acl-uf6fpfdg3b5muska7uqem
RequestIdstring

The ID of the request.

CEF72CEB-54B6-4AE8-B225-F876FF7BZ015
AclNamestring

The name of the access control policy.

testAcl
AclEntrysarray<object>

The information about the access control policy.

AclEntryobject

The information about the access control policy.

AclEntryIpstring

The ACL entry.

192.168.1.0/24
AclEntryCommentstring

The entry description.

default
AddressIPVersionstring

The IP protocol version. Valid values: ipv4 and ipv6.

ipv4

Examples

Sample success responses

JSONformat

{
  "AclId": "acl-uf6fpfdg3b5muska7uqem",
  "RequestId": "CEF72CEB-54B6-4AE8-B225-F876FF7BZ015",
  "AclName": "testAcl",
  "AclEntrys": {
    "AclEntry": [
      {
        "AclEntryIp": "192.168.1.0/24",
        "AclEntryComment": "default"
      }
    ]
  },
  "AddressIPVersion": "ipv4"
}

Error codes

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

Change history

Change timeSummary of changesOperation
2024-05-08The response structure of the API has changedView Change Details
2024-03-29The response structure of the API has changedView Change Details
2022-06-24Add OperationView Change Details