Stageの変更
- 印刷する
- PDF
Stageの変更
- 印刷する
- PDF
記事の要約
この要約は役に立ちましたか?
ご意見ありがとうございます
Classic/VPC環境で利用できます。
ユーザーが指定した条件に基づいて Stageの情報を変更します。リクエスト
リクエスト形式を説明します。リクエスト形式は次の通りです。
| メソッド | URI |
|---|---|
| PUT | /products/{product-id}/apis/{api-id}/stages/{stage-id} |
リクエストヘッダ
API Gatewayで共通して使用されるヘッダの詳細は、API Gatewayのリクエストヘッダをご参照ください。
リクエストパスパラメータ
パラメータの説明は次の通りです。
| フィールド | タイプ | 必須の有無 | 説明 |
|---|---|---|---|
product-id | String | Required | Stageが属する Product ID
|
api-id | String | Required | Stageが属する API ID
|
stage-id | String | Required | 変更対象の Stage ID
|
リクエスト構文
リクエスト構文は次の通りです。
{
"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
|
ipAclList | String | Conditional | IP ACLリスト
|
throttleRps | Integer | Optional | メソッド別1秒当たりのリクエスト数の限度
|
response | String | Required | 状態コードに対するレスポンス
|
isMaintenance | Boolean | Required | メンテナンス設定
|
ipAclCode | String | Conditional | IP ACLを許可するかどうか
|
endpointDomain | String | Required | エンドポイントドメイン |
statusCode | Integer | Required | 状態コード
|
enabledContentEncoding | Boolean | Optional | エンコード設定
|
minimumCompressionSize | Integer | Optional | データ転送時に圧縮するかどうか
|
リクエスト例
リクエストのサンプルコードは次の通りです。
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のレスポンスステータスコードをご参照ください。
レスポンス例
レスポンスのサンプルコードは次の通りです。
{
"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
}
}
この記事は役に立ちましたか?