---
title: "Stageの変更"
slug: "apigateway-stage-putstage"
updated: 2026-09-17T09:57:26Z
published: 2026-09-17T09:57:26Z
canonical: "api.ncloud-docs.com/apigateway-stage-putstage"
---

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

# Stageの変更

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

ユーザーが指定した条件に基づいて Stageの情報を変更します。

## リクエスト

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

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

### リクエストヘッダ

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 | Stageが属する Product ID - 0~10文字 - [Productリストの照会](/docs/ja/apigateway-product-getproductlist)を参照 |
| `api-id` | String | Required | Stageが属する API ID - 0~10文字 - [APIの照会](/docs/ja/apigateway-api-apis)を参照 |
| `stage-id` | String | Required | 変更対象の Stage ID - 0~10文字 - [Stageリストの照会](/docs/ja/apigateway-stage-getstagelist)を参照 |

### リクエスト構文

リクエスト構文は次の通りです。

```
{
    "cacheTtlSec" : 0,
    "ipAclList" : "ipAclList",
    "throttleRps" : 6,
    "response" : "response",
    "isMaintenance" : true,
    "ipAclCode" : "ALLOWED",
    "endpointDomain" : "endpointDomain",
    "statusCode" : 1,
    "enabledContentEncoding": true,
    "minimumCompressionSize": 0
}
```

### リクエストボディ

リクエストボディの説明は次の通りです。

| フィールド | タイプ | 必須の有無 | 説明 |
| --- | --- | --- | --- |
| `cacheTtlSec` | Long | Optional | APIキャッシュ TTL - 1~3,600秒 |
| `ipAclList` | String | Conditional | IP ACLリスト - `ipAclCode`入力時、必須 |
| `throttleRps` | Integer | Optional | メソッド別1秒当たりのリクエスト数の限度 - 1~2,147,483,647 |
| `response` | String | Required | 状態コードに対するレスポンス - 0~1,500文字 |
| `isMaintenance` | Boolean | Required | メンテナンス設定 - `true` \| `false` - `true`: 設定 - `false`: 設定しない |
| `ipAclCode` | String | Conditional | IP ACLを許可するかどうか - `ALLOWED` \| `REJECTED` - `ALLOWED`: 許可 - `REJECTED`: 拒否 - `ipAclList`入力時、必須 |
| `endpointDomain` | String | Required | エンドポイントドメイン |
| `statusCode` | Integer | Required | 状態コード - 100~599 |
| `enabledContentEncoding` | Boolean | Optional | エンコード設定 - `true` \| `false`(デフォルト) - `true`: 設定 - `false`: 設定しない |
| `minimumCompressionSize` | Integer | Optional | データ転送時に圧縮するかどうか - 圧縮を有効化するには、負の数ではなく整数を入力 - 0~10,485,760 - このフィールドに入力しないと、圧縮は無効化 |

### リクエスト例

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

```
curl --location --request PUT 'https://apigateway.apigw.ntruss.com/api/v1/products/***ksk9***/apis/***51hs***/stages/***gshi***' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--header 'Content-Type: application/json' \
--data '{
    "cacheTtlSec": 1,
    "endpointDomain" : "http://sdfs.***",
    "isMaintenance": true,
    "response": "response",
    "statusCode": "200"
}'
```

## レスポンス

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

### レスポンス構文

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

```
{
    "stage" : {
        "canaryDeployedTime" : "2000-01-23T04:56:07.000+00:00",
        "modifier" : "modifier",
        "canaryEndpointDomain" : "canaryEndpointDomain",
        "canaryThrottleRps" : 5,
        "cacheTtlSec" : 0,
        "stageName" : "stageName",
        "throttleRps" : 4,
        "monthQuotaRequest" : 9,
        "canaryCacheTtlSec" : 6,
        "canaryDistributionRate" : 5.962134,
        "apiId" : "apiId",
        "stageId" : "stageId",
        "deployedStageDeploymentNo" : 7,
        "useDistributionRate" : true,
        "canaryDeploymentDescription" : "canaryDeploymentDescription",
        "dayQuotaRequest" : 2,
        "isMaintenance" : true,
        "rateRps" : 3,
        "endpointDomain" : "endpointDomain",
        "ipAclList" : "ipAclList",
        "canaryDeploymentNo" : 1,
        "regTime" : "2000-01-23T04:56:07.000+00:00",
        "response" : "response",
        "canaryConditions" : [ {
            "parameterName" : "parameterName",
            "parameterCode" : "REQUEST_HEADER",
            "parameterValue" : "parameterValue"
        } ],
        "tenantId" : "tenantId",
        "ipAclCode" : "ALLOWED",
        "statusCode" : 2,
        "enabledContentEncoding": true,
        "minimumCompressionSize": 0
    }
}
```

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

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)をご参照ください。

### レスポンス例

レスポンスのサンプルコードは次の通りです。

```
{
    "stage": {
        "tenantId": "***e230cebc1402ba89b148896951***",
        "modifier": "***d3020-5bb7-11ec-bfb8-246e96591***",
        "stageId": "***gshi***",
        "apiId": "***51hs***",
        "stageName": "stage000",
        "endpointDomain": "http://sdfs.****",
        "rateRps": 10,
        "dayQuotaRequest": 6,
        "monthQuotaRequest": 15,
        "deployedStageDeploymentNo": 253***,
        "regTime": "2024-05-10T01:59:17Z",
        "isMaintenance": true,
        "statusCode": 200,
        "response": "response",
        "enabledContentEncoding": false
    }
}
```