Get Secret Stage Value

Prev Next

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

시크릿 스테이지의 시크릿 값을 조회합니다. REVOKE(삭제 요청) 상태인 시크릿의 값은 조회할 수 없습니다.

요청

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

메서드 URI
GET /api/v1/secrets/{secretId}/{secret-value-stage}

요청 헤더

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

요청 경로 파라미터

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

필드 타입 필수 여부 설명
secretId String Required 시크릿 아이디
secret-value-stage String Required 시크릿 스테이지
  • previous | active | pending
    • previous: PREVIOUS 스테이지(ACTIVE 스테이지 기준으로 이전에 사용했던 시크릿)
    • active: ACTIVE 스테이지(현재 정상적으로 사용 중인 활성 시크릿)
    • pending: PENDING 스테이지(교체가 새로 시작되어 교체 완료 대기 중인 시크릿)

요청 예시

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

curl --location --request GET 'https://secretmanager.apigw.ntruss.com/api/v1/secrets/{secretId}/active' \
--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.decryptedSecretValue Object - 복호화된 시크릿 값 정보
data.decryptedSecretValue.value String - 복호화된 시크릿 값
data.decryptedSecretValue.valueStage String - 시크릿 스테이지
  • PREVIOUS | ACTIVE | PENDING
    • PREVIOUS: PREVIOUS 스테이지(ACTIVE 스테이지 기준으로 이전에 사용했던 시크릿)
    • ACTIVE: ACTIVE 스테이지(현재 정상적으로 사용 중인 활성 시크릿)
    • PENDING: PENDING 스테이지(교체가 새로 시작되어 교체 완료 대기 중인 시크릿)
data.rotationTargets Array - 교체 대상 시크릿 값 목록

응답 상태 코드

Secret Manager API에서 공통으로 사용하는 응답 상태 코드에 대한 정보는 Secret Manager 응답 상태 코드를 참조해 주십시오.

응답 예시

응답 예시는 다음과 같습니다.

{
    "code": "SUCCESS",
    "data": {
        "decryptedSecretValue": {
            "value": "{\"abc\":\"cba\"}",
            "valueStage": "ACTIVE"
        },
        "rotationTargets": [
            "abc"
        ]
    }
}