Get Secret Detail

Prev Next

VPC 환경에서 이용 가능합니다.

시크릿 상세 정보를 조회합니다.

요청

요청 형식을 설명합니다. 요청 형식은 다음과 같습니다.

메서드 URI
GET /api/v1/secrets/{secretId}

요청 헤더

Secret Manager API에서 공통으로 사용하는 헤더에 대한 정보는 Secret Manager 요청 헤더를 참조해 주십시오.

요청 경로 파라미터

요청 경로 파라미터에 대한 설명은 다음과 같습니다.

필드 타입 필수 여부 설명
secretId String Required 시크릿 아이디

요청 예시

요청 예시는 다음과 같습니다.

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 - 트리거 아이디
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 키 이름
data.protectionKey.kmsBoundaryType String - KMS 리전 격리 타입
  • GLOBAL | ISOLATED
    • GLOBAL: 전역
    • ISOLATED: 격리

응답 상태 코드

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-***",
            "kmsBoundaryType": "GLOBAL"
        }
    }
}