MENU
      Canary 활성화

        Canary 활성화


        기사 요약

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

        API 명세를 Stage에 배포하기 전에 운영 환경에서 테스트할 수 있는 Canary 기능을 활성화합니다.

        요청

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

        메서드URI
        POST/products/{product-id}/apis/{api-id}/stages/{stage-id}/canary

        요청 헤더

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

        요청 경로 파라미터

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

        필드타입필수 여부설명
        product-idStringRequiredAPI에 연결된 Product ID
        • 1~10자
        api-idStringRequiredProduct에 생성된 API ID
        • 1~10자
        stage-idStringRequiredAPI에 생성된 Stage ID
        • 1~10자

        요청 예시

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

        curl -X POST 'https://apigateway.apigw.ntruss.com/api/v1/products/{product-id}/apis/{api-id}/stages/{stage-id}/canary' \
        --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}'
        Curl

        응답

        응답 형식을 설명합니다.

        응답 구문

        구문은 다음과 같습니다.

        {
            "stageId": "stageId",
            "canaryCertificateId": "canaryCertificateId",
            "canaryDeploymentNo": 0,
            "canaryDistributionRate": 0.0,
            "canaryEndpointDomain": "canaryEndpointDomain",
            "canaryDeployedTime": "2024-05-08T06:29:48Z",
            "canaryDeploymentDescription": "canaryDeploymentDescription",
            "deployedStageDeploymentNo": 0,
            "useDistributionRate": true
        }
        JSON

        응답 상태 코드

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

        응답 예시

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

        {
            "stageId": "*****7mhdv",
            "canaryCertificateId": "",
            "canaryDeploymentNo": 251371,
            "canaryDistributionRate": 0.0,
            "canaryEndpointDomain": "NONE",
            "canaryDeployedTime": "2024-05-08T06:29:48Z",
            "canaryDeploymentDescription": "default canary desc",
            "deployedStageDeploymentNo": 251072,
            "useDistributionRate": true
        }
        JSON

        이 문서가 도움이 되었습니까?

        Changing your password will log you out immediately. Use the new password to log back in.
        First name must have atleast 2 characters. Numbers and special characters are not allowed.
        Last name must have atleast 1 characters. Numbers and special characters are not allowed.
        Enter a valid email
        Enter a valid password
        Your profile has been successfully updated.