---
title: "SDKのエクスポート"
slug: "apigateway-canarytest-export"
updated: 2026-09-17T09:57:24Z
published: 2026-09-17T09:57:24Z
canonical: "api.ncloud-docs.com/apigateway-canarytest-export"
---

> ## 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.

# SDKのエクスポート

Classic/VPC環境で利用できます。

Canaryにデプロイされた APIを Swagger JSON 2.0、Open API JSON 3.0、Java SDK形式でエクスポートします。

## リクエスト

リクエスト形式を説明します。リクエスト形式は次の通りです。

| メソッド | URI |
| --- | --- |
| GET | /api/v1/products/{product-id}/apis/{api-id}/stages/{stage-id}/canary/export |

### リクエストヘッダ

API Gatewayで共通して使用されるヘッダの詳細は、[API Gatewayのリクエストヘッダ](/docs/ja/ai-application-service-apigateway#%EC%9A%94%EC%B2%AD%ED%97%A4%EB%8D%94)をご参照ください。

### リクエストパスパラメータ

リクエストパスパラメータの説明は次の通りです。

| フィールド | タイプ | 必須の有無 | 説明 |
| --- | --- | --- | --- |
| `product-id` | String | Required | APIと関連付けられた Product ID - 1~10文字 |
| `api-id` | String | Required | Productに作成された API ID - 1~10文字 |
| `stage-id` | String | Required | APIに作成された Stage ID - 1~10文字 |

### リクエストクエリパラメータ

リクエストクエリパラメータの説明は次の通りです。

| フィールド | タイプ | 必須の有無 | 説明 |
| --- | --- | --- | --- |
| `platform` | String | Optional | ダウンロードする Platformファイル形式 - `SWAGGER_JSON`(デフォルト) \| `OPENAPI3_JSON` \| `JAVA_SDK` - `SWAGGER_JSON`: Swagger JSON 2.0形式 - `OPENAPI3_JSON`: Open API JSON 3.0形式 - `JAVA_SDK`: Java SDK形式 |
| `packageName` | String | Optional | エクスポート対象の Package名 |
| `groupId` | String | Optional | JAVA SDK形式でエクスポートする場合、Javaの Group IDを指定 |
| `artifactId` | String | Optional | JAVA SDK形式でエクスポートする場合、Javaの Artifact IDを指定 |
| `artifactVersion` | String | Optional | JAVA SDK形式でエクスポートする場合、Javaの Artifact Versionを指定 |
| `license` | String | Optional | JAVA SDK形式でエクスポートする場合、Javaの Licenseを指定 |
| `version` | String | Optional | JAVA SDK形式でエクスポートする場合、Javaの Versionを指定 |

### リクエスト例

リクエストのサンプルコードは次の通りです。

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

## レスポンス

レスポンス形式を説明します。

### レスポンス構文

レスポンス構文は次の通りです。

```
"Download File"
```

### レスポンスステータスコード

API Gatewayで共通して使用されるレスポンスステータスコードの詳細は、[API Gatewayのレスポンスステータスコード](/docs/ja/ai-application-service-apigateway#%EC%9D%91%EB%8B%B5%EC%83%81%ED%83%9C%EC%BD%94%EB%93%9C)をご参照ください。