MENU
      Get Key Activity Logs

        Get Key Activity Logs


        Article summary

        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:

        MethodURI
        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:

        FieldTypeRequiredDescription
        keyTagStringRequiredKey tag
        • Unique identifier for the key derived from the key name
        • Check through Get key list
        • Use to request encryption or decryption with REST APIs
        • Key tags are not treated as confidential information

        Request query parameters

        You can use the following query parameters with your request:

        FieldTypeRequiredDescription
        keywordStringOptionalFilter with keyword
        timestampFromLongOptionalQuery start date and time (millisecond)
        • Current time minus one day (default)
        • Unix timestamp format
        timestampToLongOptionalQuery end date and time (millisecond) timestamp format
        • Current time (default)
        • Unix timestamp format
        pageNoIntegerOptionalRequest page number
        • 1 (default)
        pageSizeIntegerOptionalPage output count
        • 1-200 (default: 100)

        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}'
        Shell

        Response

        This section describes the response format.

        Response body

        The response body includes the following data:

        FieldTypeRequiredDescription
        codeString-Success or Failure
        dataObject-Response result
        data.activityLogListArray-Key usage history list details
        data.pageSizeInteger-Number of page outputs
        data.currentPageNoInteger-Current page number
        data.totalPageNoInteger-Total page number
        data.totalCountInteger-Number of response results

        activityLogList

        The following describes activityLogList.

        FieldTypeRequiredDescription
        timestampString-Request date and time (millisecond)
        • ISO 8601 format
        dataObject-Details by usage history
        data.KmsKeyObject-Key details
        data.KmsKey.keyTagString-Tag of the key that was used
        data.KmsKey.keyNameString-Key name
        data.KmsKey.nrnString-Key resource global identifier name (Ncloud resource name)
        data.requestorObject-Request details
        data.requestor.requestTypeString-Request type
        • CONSOLE | API | SYSTEM
          • CONSOLE: Request from console
          • API: Request with API
          • SYSTEM: Processing by automatic rotation and deletion scheduling
        data.requestor.idString-Requestor account ID
        data.requestor.ipString-Requestor IP address
        data.apiObject-API request details
        data.api.resultString-API request result
        • SUCCESS: request successful
        data.api.actionString-API request name
        data.api.typeString-API authentication method
        • account-auth | product-auth
          • account-auth: account authentication method
          • product-auth: token authentication method
        • Display only if data.requestor.requestType is API
        messageString-Response content
        • Display success/failure of the response

        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
            }
        }
        JSON

        Was this article helpful?

        Changing your password will log you out immediately. Use the new password to log back in.
        First name must have atleast 2 characters. Numbers and special characters are not allowed.
        Last name must have atleast 1 characters. Numbers and special characters are not allowed.
        Enter a valid email
        Enter a valid password
        Your profile has been successfully updated.