Help Center> API Gateway> API Reference> Dedicated Gateway APIs (V1) (To Be Deprecated)> Access Control Policy Management> Object Model
View PDF

Object Model

To improve access security of a published API, you can control the access from certain IP addresses by configuring a blacklist or whitelist. This section describes the object model for blacklist/whitelist (access control policy) management, as shown in Object Model.

  • Operation Type indicates the operation that can be performed on a field.

    C: create; U: update; R: read

  • Mandatory indicates whether a field with the Operation Type of C is mandatory.
Table 1 Object model for access control policies

Parameter

Type

Description

Operation Type

Mandatory

id

String

Blacklist or whitelist ID

R

-

acl_name

String

Blacklist or whitelist name

CRU

Yes

entity_type

String

Object type, which can be:

  • IP
  • DOMAIN: tenant name

CRU

Yes

acl_type

String

Access control type, which can be:

  • PERMIT (whitelist)
  • DENY (blacklist)

CRU

Yes

acl_value

String

IP address or domain ID

CRU

Yes

project_id

String

ID of the tenant that creates the access control policy

-

-

update_time

Timestamp

Time when the access control policy was last updated