---
title: "Canary 활성화"
slug: "apigateway-canarytest-enablecanary"
tags: ["API Gateway", "Canary Test"]
updated: 2026-04-23T08:55:54Z
published: 2026-04-23T09:02:24Z
canonical: "api.ncloud-docs.com/apigateway-canarytest-enablecanary"
---

> ## Documentation Index
> Fetch the complete documentation index at: https://api.ncloud-docs.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Canary 활성화

<p class="platform-info type-classic-vpc">Classic/VPC 환경에서 이용 가능합니다.</p>

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

## 요청<a name="요청"></a>
요청 형식을 설명합니다. 요청 형식은 다음과 같습니다.
| 메서드 | URI |
| :--- | :--- |
| POST | /api/v1/products/{product-id}/apis/{api-id}/stages/{stage-id}/canary |

### 요청 헤더<a name="요청헤더"></a>
API Gateway에서 공통으로 사용하는 헤더에 대한 정보는 [API Gateway 요청 헤더](/docs/ai-application-service-apigateway#요청헤더)를 참조해 주십시오.

### 요청 경로 파라미터 <a name="요청경로파라미터"></a>
요청 경로 파라미터에 대한 설명은 다음과 같습니다.
| 필드 | 타입 | 필수 여부 | 설명 |
| :--- | :--- | :--- | :--- |
| `product-id` | String | Required | API에 연결된 Product ID<ul><li>1~10자</li></ul> |
| `api-id` | String | Required | Product에 생성된 API ID<ul><li>1~10자</li></ul> |
| `stage-id` | String | Required | API에 생성된 Stage ID<ul><li>1~10자</li></ul> |

### 요청 예시<a name="요청예시"></a>
요청 예시는 다음과 같습니다.
```shell
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}'
```    
    
## 응답<a name="응답"></a>
응답 형식을 설명합니다.

### 응답 구문<a name="응답구문"></a>
응답 구문은 다음과 같습니다.
```json
{
    "stageId": "stageId",
    "canaryCertificateId": "canaryCertificateId",
    "canaryDeploymentNo": 0,
    "canaryDistributionRate": 0.0,
    "canaryEndpointDomain": "canaryEndpointDomain",
    "canaryDeployedTime": "2024-05-08T06:29:48Z",
    "canaryDeploymentDescription": "canaryDeploymentDescription",
    "deployedStageDeploymentNo": 0,
    "useDistributionRate": true
}
```

### 응답 상태 코드 <a name="응답상태코드"></a>
API Gateway에서 공통으로 사용하는 응답 상태 코드에 대한 정보는 [API Gateway 응답 상태 코드](/docs/ai-application-service-apigateway#응답상태코드)를 참조해 주십시오.

### 응답 예시<a name="응답예시"></a>
응답 예시는 다음과 같습니다. 

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