リクエスト

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

メソッド	URI
GET	/keys/{keyTag}/last-use-info

リクエストヘッダ

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

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

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

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

リクエスト例

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

curl --location --request GET 'https://ocapi.ncloud.com/kms/v1/keys/a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6q7r8s9t0u1v2w3x4y5z6/last-use-info' \
--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.timestamp`	String	-	照会日時(ミリ秒) ISO 8601形式
`data.data`	Object	-	使用履歴の詳細情報
`data.data.KmsKey`	Object	-	キーの詳細情報
`data.data.KmsKey.keyTag`	String	-	使用したキーのタグ
`data.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.data.api`	Object	-	APIリクエストの詳細情報
`data.data.api.result`	String	-	APIリクエスト結果 `SUCCESS`: リクエスト成功
`data.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": {
        "timestamp": "2024-12-10T14:02:55.500+09:00",
        "data": {
            "kmsKey": {
                "keyTag": "a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6q7r8s9t0u1v2w3x4y5z6",
                "keyName": "{KEY_NAME}",
                "nrn": "nrn:PUB:KMS::xxxxxxx:Key/xxxx-xxxxx"
            },
            "requestor": {
                "requestType": "API",
                "id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
                "ip": "xxx.xxx.xxx.xxx"
            },
            "api": {
                "result": "SUCCESS",
                "action": "GetLastUseInfo",
                "type": "account-auth"
            }
        },
        "message": "{\"result\":\"SUCCESS\",\"action\":\"GetLastUseInfo\",\"keyTag\":\"a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6q7r8s9t0u1v2w3x4y5z6\"}"
    }
}

この記事は役に立ちましたか?

リクエスト
レスポンス