Get Secret Detail

Prev Next

VPC環境で利用できます。

シークレットの詳細情報を照会します。

リクエスト

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

メソッド URI
GET /api/v1/secrets/{secretId}

リクエストヘッダ

Secret Manager APIで共通して使用されるヘッダの詳細は、Secret Managerのリクエストヘッダをご参照ください。

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

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

フィールド タイプ 必須の有無 説明
secretId String Required シークレット ID

リクエスト例

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

curl --location --request GET 'https://secretmanager.apigw.ntruss.com/api/v1/secrets/{secretId}' \
--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.secretId String - Secret ID
data.secretName String - シークレット名
data.secretStatus String - シークレットの状態
  • ENABLE | DISABLE | REVOKE | ROTATING | DESTROYED
    • ENABLE: 利用可能
    • DISABLE: 一時停止
    • REVOKE: 削除予定
    • ROTATING: ローテーション中
    • DESTROYED: 最終削除
data.secretType String - シークレットタイプ
  • BASIC (有効値)
data.memo String - シークレットの説明
data.region String - 地域コード
data.expectedDestroyDate Integer - シークレット廃棄予定日時(ミリ秒)
  • Unix Timestamp形式
  • シークレットが削除予定の場合、表示
data.updateDate Integer - シークレット更新日時(ミリ秒)
  • Unix Timestamp形式
data.registerDate Integer - シークレット作成日時(ミリ秒)
  • Unix Timestamp形式
data.autoRotationYN String - 自動ローテーションするか
  • Y | N
    • Y: 自動ローテーション
    • N: 自動ローテーションしない
data.autoRotationPeriod Integer - シークレット自動ローテーション周期(日)
  • autoRotationYNがYの場合、表示
data.nextRotationDate Integer - 次のローテーション予定日時(ミリ秒)
  • Unix Timestamp形式
  • autoRotationYNがYの場合、表示
data.rotationPhase String - 現在のローテーション段階
  • NONE | ROTATING | ROTATION_FAILED
    • NONE: ローテーションの実行履歴なしまたはローテーション終了(正常)
    • ROTATING: ローテーション中
    • ROTATION_FAILED: ローテーション失敗
data.trigger Object - トリガー情報
data.trigger.id String - トリガー ID
data.trigger.name String - トリガー名
data.trigger.url String - トリガー URL
data.protectionKey Object - 保護キー情報
data.protectionKey.type String - 保護キータイプ
  • DEFAULT | USER_MANAGED_KEY
    • DEFAULT: デフォルトのキー
    • USER_MANAGED_KEY: ユーザー管理キー
data.protectionKey.kmsKeyTag String - KMSキータグ
data.protectionKey.kmsKeyName String - KMSキー名

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

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

レスポンス例

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

{
    "code": "SUCCESS",
    "data": {
        "secretId": "*****687685109842348f7358629bca2a6b2491e8c2352718e7d312b183*****",
        "secretName": "test-***",
        "secretStatus": "ENABLE",
        "secretType": "BASIC",
        "memo": "Secret Manager Description",
        "region": "KR",
        "updateDate": 1753159021411,
        "registerDate": 1753065580243,
        "autoRotationYN": "Y",
        "autoRotationPeriod": 90,
        "nextRotationDate": 1760842800000,
        "rotationPhase": "NONE",
        "trigger": {
            "id": "*****",
            "name": "test",
            "url": "https://console.ncloud.com/vpcCloudFunctions/trigger/detail/test"
        },
        "protectionKey": {
            "type": "USER_MANAGED_KEY",
            "kmsKeyTag": "*****a8e99ef1ba49b9c190a0cb4f6fb20cff86dd3a3017fd6ee05aea8b*****",
            "kmsKeyName": "test-***"
        }
    }
}