API 인증키 설정

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

Object Storage 서비스에 접근할 수 있도록 API 인증키를 설정합니다.

요청

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

메서드	URI
POST	/api/v2/snapshot/updateAPIAuthenticationKey/{serviceGroupInstanceNo} (수도권)
POST	/api/krs-v2/snapshot/updateAPIAuthenticationKey/{serviceGroupInstanceNo} (남부권)

요청 헤더

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

요청 경로 파라미터

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

필드	타입	필수 여부	설명
`serviceGroupInstanceNo`	Integer	Required	클러스터 인스턴스 번호 클러스터 목록 조회 참조

요청 바디

요청 바디에 대한 설명은 다음과 같습니다.

필드	타입	필수 여부	설명
`accessKeyId`	String	Required	네이버 클라우드 플랫폼에서 발급받은 Access Key 인증키 생성 참조
`secretKey`	String	Required	네이버 클라우드 플랫폼에서 발급받은 Secret Key 인증키 생성 참조

요청 예시

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

curl --location --request POST 'https://vpcsearchengine.apigw.gov-ntruss.com/api/v2/snapshot/updateAPIAuthenticationKey/1037*****' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--header 'Content-Type: application/json' \
--data '{
    "accessKeyId": "{Access Key}",
    "secretKey": "{Secret Key}"
}'

응답

응답 형식을 설명합니다.

응답 바디

응답 바디에 대한 설명은 다음과 같습니다.

필드	타입	필수 여부	설명
`code`	Integer	-	응답 코드
`message`	String	-	응답 메시지
`result`	Boolean	-	응답 결과 `true` \| `null` `true`: 성공 `null`: 실패
`requestId`	String	-	요청에 대한 아이디 UUID 형식

응답 상태 코드

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

응답 예시

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

{
    "code": 0,
    "message": "SUCCESS",
    "result": true,
    "requestId": "c1637182-****-****-****-f83000f29695"
}