Available in Classic and VPC
Get IP ACL configuration information for a key.
Request
This section describes the request format. The method and URI are as follows:
Method | URI |
---|---|
GET | /keys/{keyTag}/acl |
Request headers
For information about the headers common to all Key Management Service APIs, see the account authentication method in Key Management Service request headers.
Request path parameters
You can use the following path parameters with your request:
Field | Type | Required | Description |
---|---|---|---|
keyTag |
String | Required | Key tag
|
Request example
The request example is as follows:
curl --location --request GET 'https://ocapi.ncloud.com/kms/v1/keys/a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6q7r8s9t0u1v2w3x4y5z6/acl' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'
Response
This section describes the response format.
Response body
The response body includes the following data:
Field | Type | Required | Description |
---|---|---|---|
code |
String | - | Success or Failure |
data |
Object | - | Response result |
data.keyTag |
String | - | Tag of the key that was queried |
data.isAclEnabled |
Boolean | - | Whether IP ACL is enabled
|
data.allowedIpList |
Array | - | Allowed IP address list
|
Response status codes
For response status codes common to all Key Management Service APIs, see Key Management Service response status codes.
Response example
The response example is as follows:
{
"code": "SUCCESS",
"data": {
"keyTag": "a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6q7r8s9t0u1v2w3x4y5z6",
"isAclEnabled": true,
"allowedIpList": [
"xxx.xxx.xxx.xxx"
]
}
}