Get Key Activity Logs
- Print
- PDF
Get Key Activity Logs
- Print
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Available in Classic and VPC
Get the key usage history list.
Request
This section describes the request format. The method and URI are as follows:
Method | URI |
---|---|
GET | /keys/{keyTag}/activities |
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 query parameters
You can use the following query parameters with your request:
Field | Type | Required | Description |
---|---|---|---|
keyword | String | Optional | Filter with keyword |
timestampFrom | Long | Optional | Query start date and time (millisecond)
|
timestampTo | Long | Optional | Query end date and time (millisecond) timestamp format
|
pageNo | Integer | Optional | Request page number
|
pageSize | Integer | Optional | Page output count
|
Request example
The request example is as follows:
curl --location --request GET 'https://ocapi.ncloud.com/kms/v1/keys/a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6q7r8s9t0u1v2w3x4y5z6/activities' \
--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.activityLogList | Array | - | Key usage history list details |
data.pageSize | Integer | - | Number of page outputs |
data.currentPageNo | Integer | - | Current page number |
data.totalPageNo | Integer | - | Total page number |
data.totalCount | Integer | - | Number of response results |
activityLogList
The following describes activityLogList
.
Field | Type | Required | Description |
---|---|---|---|
timestamp | String | - | Request date and time (millisecond)
|
data | Object | - | Details by usage history |
data.KmsKey | Object | - | Key details |
data.KmsKey.keyTag | String | - | Tag of the key that was used |
data.KmsKey.keyName | String | - | Key name |
data.KmsKey.nrn | String | - | Key resource global identifier name (Ncloud resource name) |
data.requestor | Object | - | Request details |
data.requestor.requestType | String | - | Request type
|
data.requestor.id | String | - | Requestor account ID |
data.requestor.ip | String | - | Requestor IP address |
data.api | Object | - | API request details |
data.api.result | String | - | API request result
|
data.api.action | String | - | API request name |
data.api.type | String | - | API authentication method
|
message | String | - | Response content
|
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": {
"activityLogList": [
{
"timestamp": "2024-12-09T11:50:10.861+09:00",
"data": {
"kmsKey": {
"keyTag": "a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6q7r8s9t0u1v2w3x4y5z6",
"keyName": "{KEY_IDENTIFIER}",
"nrn": "nrn:PUB:KMS::xxxxxxx:Key/xxxx-xxxxx"
},
"requestor": {
"requestType": "CONSOLE",
"id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
"ip": "xxx.xxx.xxx.xxx"
},
"api": {
"result": "SUCCESS",
"action": "GetKeyInfo",
"type": "product-auth"
}
},
"message": "{\"result\":\"SUCCESS\",\"action\":\"GetKeyInfo\",\"keyTag\":\"a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6q7r8s9t0u1v2w3x4y5z6\"}"
}
],
"pageSize": 100,
"currentPageNo": 1,
"totalPageNo": 1,
"totalCount": 1
}
}
Was this article helpful?