Help Center/ Identity and Access Management/ API Reference/ API/ Security Settings/ Modifying the ACL for API Access
Updated on 2024-11-18 GMT+08:00
View PDF
Share

Modifying the ACL for API Access

Function

This API is provided for the administrator to modify the ACL for API access. The change will be applied for all IAM users and federated users (SP initiated) of the account.

The API can be called using both the global endpoint and region-specific endpoints. For IAM endpoints, see Regions and Endpoints.

Debugging

You can debug this API in API Explorer.

URI

PUT /v3.0/OS-SECURITYPOLICY/domains/{domain_id}/api-acl-policy

Table 1 URI parameters

Parameter

Mandatory

Type

Description

domain_id

Yes

String

Account ID. For details about how to obtain the account ID, see Obtaining Account, IAM User, Group, Project, Region, and Agency Information.

Request Parameters

Table 2 Parameters in the request header

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Access token issued to a user to bear its identity and permissions.

For details about the permissions required by the token, see Actions.
Table 3 Parameter in the request body

Parameter

Mandatory

Type

Description

api_acl_policy

Yes

object

ACL for API access.
Table 4 api_acl_policy

Parameter

Mandatory

Type

Description

allow_address_netmasks

No

Array of objects

IP address CIDR blocks from which API access is allowed.

Specify either allow_address_netmasks or allow_ip_ranges.

allow_ip_ranges

No

Array of objects

IP address ranges from which API access is allowed.

Specify either allow_address_netmasks or allow_ip_ranges.
Table 5 allow_address_netmasks

Parameter

Mandatory

Type

Description

address_netmask

Yes

String

IP address CIDR block, for example, 192.168.0.1/24.

description

No

String

Description of an IP address CIDR block.
Table 6 allow_ip_ranges

Parameter

Mandatory

Type

Description

description

No

String

Description of an IP address range.

ip_range

Yes

String

IP address range, for example, 0.0.0.0-255.255.255.255.

Response Parameters

Table 7 Parameters in the response body

Parameter

Type

Description

api_acl_policy

object

ACL for API access.
Table 8 api_acl_policy

Parameter

Type

Description

allow_address_netmasks

objects

IP address CIDR blocks from which API access is allowed. This parameter is only returned when an IP address range or CIDR block from which API access is allowed is specified.

allow_ip_ranges

objects

IP address ranges from which API access is allowed. This parameter is only returned when an IP address range from which API access is allowed is specified.
Table 9 allow_address_netmasks

Parameter

Type

Description

address_netmask

String

IP address CIDR block, for example, 192.168.0.1/24.

description

String

Description of an IP address CIDR block.
Table 10 allow_ip_ranges

Parameter

Type

Description

description

String

Description of an IP address range.

ip_range

String

IP address range, for example, 0.0.0.0-255.255.255.255.

Example Request

Request for modifying the API access policy to only allow API access from IP address range 0.0.0.0-255.255.255.255

PUT https://iam.myhuaweicloud.com/v3.0/OS-SECURITYPOLICY/domains/{domain_id}/api-acl-policy 
{
 "api_acl_policy": {
  "allow_ip_ranges": [
   {
    "description": "2",
    "ip_range": "0.0.0.0-255.255.255.255"
   }
  ]
 }
}

Example Response

Status code: 200

The request is successful.

{
 "api_acl_policy": {
  "allow_ip_ranges": [
   {
    "ip_range": "0.0.0.0-255.255.255.255",
    "description": "2"
   }
  ]
 }
}

Status code: 400

The request body is abnormal.

  • Example 1
{ 
   "error_msg" : "'%(key)s' is a required property.", 
   "error_code" : "IAM.0072" 
 }
  • Example 2
{ 
   "error_msg" : "Invalid input for field '%(key)s'. The value is '%(value)s'.", 
   "error_code" : "IAM.0073" 
 }

Status code: 500

The system is abnormal.

{ 
  "error_msg" : "An unexpected error prevented the server from fulfilling your request.", 
  "error_code" : "IAM.0006" 
}

Status Codes

Status Code

Description

200

The request is successful.

400

The request body is abnormal.

401

Authentication failed.

403

Access denied.

500

The system is abnormal.

Error Codes

For details, see Error Codes.

Parent topic: Security Settings