Help Center/ API Gateway/ API Reference/ Dedicated Gateway APIs (V2)/ Credential Management/ Configuring Access Control Settings for an App
Updated on 2024-11-07 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Configuring Access Control Settings for an App

Function

This API is used to configure access control settings for a credential.

Calling Method

For details, see Calling APIs.

URI

PUT /v2/{project_id}/apigw/instances/{instance_id}/apps/{app_id}/app-acl

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID. For details about how to obtain it, see Obtaining a Project ID.

instance_id

Yes

String

Gateway ID, which can be obtained from the gateway information on the APIG console.

app_id

Yes

String

App ID.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is a token.
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

app_acl_type

Yes

String

Type:

  • PERMIT (whitelist)

  • DENY (blacklist)

app_acl_values

Yes

Array of strings

Access control values. The values can be IP addresses, IP address ranges, or CIDR blocks. Use hyphens (-) to separate IP address segments.

Response Parameters

Status code: 201

Table 4 Response body parameters

Parameter

Type

Description

app_id

String

App ID.

app_acl_type

String

Type:

  • PERMIT (whitelist)

  • DENY (blacklist)

app_acl_values

Array of strings

Access control values. The values can be IP addresses, IP address ranges, or CIDR blocks. Use hyphens (-) to separate IP address segments.

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Status code: 401

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Status code: 403

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Status code: 404

Table 8 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Status code: 500

Table 9 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Example Requests

{
  "app_acl_type" : "PERMIT",
  "app_acl_values" : [ "192.168.0.1", "192.168.0.5-192.168.0.10", "192.168.0.100/28" ]
}

Example Responses

Status code: 201

Ok

{
  "app_id" : "9ed8b7fe84224de681e7d7a5587e76dc",
  "app_acl_type" : "PERMIT",
  "app_acl_values" : [ "192.168.0.1", "192.168.0.5-192.168.0.10", "192.168.0.100/28" ]
}

Status code: 400

Bad Request

{
  "error_code" : "APIG.2012",
  "error_msg" : "Invalid parameter value,parameterName:app_id. Please refer to the support documentation"
}

Status code: 401

Unauthorized

{
  "error_code" : "APIG.1002",
  "error_msg" : "Incorrect token or token resolution failed"
}

Status code: 403

Forbidden

{
  "error_code" : "APIG.1005",
  "error_msg" : "No permissions to request this method"
}

Status code: 404

Not Found

{
  "error_code" : "APIG.3004",
  "error_msg" : "App 9ed8b7fe84224de681e7d7a5587e76dc does not exist"
}

Status code: 500

Internal Server Error

{
  "error_code" : "APIG.9999",
  "error_msg" : "System error"
}

Status Codes

Status Code

Description

201

Ok

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

Error Codes

See Error Codes.

Parent topic: Credential Management