Start Rotation Job

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

시크릿 교체 작업을 시작합니다. 교체 작업 시작이 Secret Manager로 통보되며, 시크릿은 교체 진행 상태로 변경됩니다.

요청

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

메서드	URI
POST	/action/v1/secrets/{secretId}/jobs/{jobToken}/start

요청 헤더

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

요청 경로 파라미터

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

필드	타입	필수 여부	설명
`secretId`	String	Required	시크릿 아이디 Get Secret List 또는 Get Secret Logs 참조 트리거를 실행한 애플리케이션에 자동 주입되며, 환경 변수로 확인 가능 시크릿 교체 액션 예제 코드 참조
`jobToken`	String	Required	작업 토큰 Get Secret Logs 참조 트리거를 실행한 애플리케이션에 자동 주입되며, 환경 변수로 확인 가능 시크릿 교체 액션 예제 코드 참조

요청 예시

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

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

응답 상태 코드

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

응답 예시

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

{
    "code": "SUCCESS",
    "data": {
        "decryptedSecretChain": {
            "previous": "{\"abc\":\"cba\"}",
            "active": "{\"abc\":\"{cba\"}",
            "pending": "{\"abc\":\"{cba\"}"
        },
        "rotationTargets": [
            "abc"
        ]
    }
}