API 배포

Prev Next

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

생성한 API를 배포합니다.

요청

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

메서드 URI
POST /products/{product-id}/apis/{api-id}/deploy

요청 헤더

API Gateway에서 공통으로 사용하는 헤더에 대한 자세한 내용은 API Gateway 요청 헤더를 참조해 주십시오.

요청 경로 파라미터

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

필드 타입 필수 여부 설명
product-id String Required API에 연결된 Product ID
api-id String Required Product에 생성된 API ID

요청 구문

요청 구문은 다음과 같습니다.

{
  "deploymentDescription" : "deploymentDescription",
  "stageId" : "stageId"
}

요청 바디

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

필드 타입 필수 여부 설명
deploymentDescription String Optional API 배포에 대한 설명
  • 0~300자
stageId String Required 배포할 API에 생성된 Stage ID
  • 1~10자

요청 예시

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

curl -X POST 'https://apigateway.apigw.gov-ntruss.com/api/v1/products/{product-id}/apis/{api-id}/deploy' \
--header 'Content-Type: application/json' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'
--data '{
  "deploymentDescription" : "deployment Description",
  "stageId" : "*****7mhdv"
}

응답

응답 형식을 설명합니다.

응답 상태 코드

API Gateway에서 공통으로 사용하는 응답 상태 코드에 대한 자세한 내용은 API Gateway 응답 상태 코드를 참조해 주십시오.