Get Key Activity Logs

Prev Next

Classic/VPC環境で利用できます。

キー使用履歴リストを照会します。

リクエスト

リクエスト形式を説明します。リクエスト形式は次の通りです。

メソッド URI
GET /keys/{keyTag}/activities

リクエストヘッダ

Key Management Service APIで共通して使用されるヘッダの詳細は、Key Management Serviceのリクエストヘッダでアカウント認証方式をご参照ください。

リクエストパスパラメータ

リクエストパスパラメータの説明は次の通りです。

フィールド タイプ 必須の有無 説明
keyTag String Required キータグ
  • キー名から派生したキーの固有 ID
  • Get Key Listを通じて確認
  • REST APIで暗号化または復号化をリクエストする際に使用
  • キータグは機密情報として扱われない

リクエストクエリパラメータ

リクエストクエリパラメータの説明は次の通りです。

フィールド タイプ 必須の有無 説明
keyword String Optional キーワードでフィルタリング
timestampFrom Long Optional 照会開始日時(ミリ秒)
  • 現在時刻から1日を引いた値(デフォルト)
  • Unix Timestamp形式
timestampTo Long Optional 照会終了日時(ミリ秒)
  • 現在時刻(デフォルト)
  • Unix Timestamp形式
pageNo Integer Optional リクエストページ番号
  • 1(デフォルト)
pageSize Integer Optional ページの出力数
  • 1~200 (デフォルト: 100)

リクエスト例

リクエストのサンプルコードは次の通りです。

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

レスポンス

レスポンス形式を説明します。

レスポンスボディ

レスポンスボディの説明は次の通りです。

フィールド タイプ 必須の有無 説明
code String - 成功したかどうか
data Object - レスポンス結果
data.activityLogList Array - キー使用履歴リストの詳細情報
data.pageSize Integer - ページ表示数
data.currentPageNo Integer - 現在のページ番号
data.totalPageNo Integer - 総ページ番号
data.totalCount Integer - レスポンス結果数

activityLogList

activityLogListの説明は次の通りです。

フィールド タイプ 必須の有無 説明
timestamp String - リクエスト日時(ミリ秒)
  • ISO 8601形式
data Object - 使用履歴別詳細情報
data.KmsKey Object - キーの詳細情報
data.KmsKey.keyTag String - 使用したキーのタグ
data.KmsKey.keyName String - キー名
data.KmsKey.nrn String - キーリソースのグローバル一意識別子名(Ncloudリソース名)
data.requestor Object - リクエストの詳細情報
data.requestor.requestType String - リクエストタイプ
  • CONSOLE | API | SYSTEM
    • CONSOLE: コンソールからリクエスト
    • API: APIでリクエスト
    • SYSTEM: 自動ローテーションと削除スケジュールによる処理
data.requestor.id String - リクエスタのアカウント ID
data.requestor.ip String - リクエスタの IPアドレス
data.api Object - APIリクエストの詳細情報
data.api.result String - APIリクエスト結果
  • SUCCESS: リクエスト成功
data.api.action String - APIリクエスト名
data.api.type String - API認証方式
  • account-auth | product-auth
    • account-auth: アカウント認証方式
    • product-auth: トークン認証方式
  • data.requestor.requestTypeがAPIの場合にのみ表示
message String - レスポンスの内容
  • レスポンスが成功したか失敗したかを表示

レスポンスステータスコード

Key Management Service APIで共通して使用されるレスポンスステータスコードの詳細は、Key Management Serviceのレスポンスステータスコードをご参照ください。

レスポンス例

レスポンスのサンプルコードは次の通りです。

{
    "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
    }
}