API 게시

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

API를 게시 또는 게시 해제합니다.

요청

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

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

요청 헤더

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

요청 경로 파라미터

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

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

요청 구문

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

{
  "stages" : [ {
    "isPublished" : true,
    "stageId" : "stageId"
  } ]
}

요청 바디

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

필드	타입	필수 여부	설명
`stages[].isPublished`	Boolean	Required	게시 여부 선택 `true` \| `false` `true`: 게시 `false`: 게시 해제
`stages[].stageId`	String	Required	API 게시 또는 해제할 Stage ID

요청 예시

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

curl -X POST 'https://apigateway.apigw.gov-ntruss.com/api/v1/products/{product-id}/apis/{api-id}/publish' \
--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 '{
  "stages" : [ {
    "isPublished" : true,
    "stageId" : "*****7mhdv"
  } ]
}'

응답

응답 형식을 설명합니다.

응답 상태 코드

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