Stageの変更
    • PDF

    Stageの変更

    • PDF

    記事の要約

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

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

    リクエスト

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

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

    リクエストヘッダ

    API Gatewayで共通して使用されるヘッダの詳細は、API Gatewayのリクエストヘッダをご参照ください。

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

    パラメータの説明は次の通りです。

    フィールドタイプ必須の有無説明
    product-idStringRequiredStageが属する Product ID
    api-idStringRequiredStageが属する API ID
    stage-idStringRequired変更対象の Stage ID

    リクエスト構文

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

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

    リクエストボディ

    パラメータの説明は次の通りです。

    フィールドタイプ必須の有無説明
    cacheTtlSecLongOptionalAPIキャッシュ TTL
    • 1~3,600秒
    ipAclListStringConditionalIP ACLリスト
    • ipAclCode入力時、必須
    throttleRpsIntegerOptionalメソッド別1秒当たりのリクエスト数の限度
    • 1~2,147,483,647
    responseStringRequired状態コードに対するレスポンス
    • 0~1,500文字
    isMaintenanceBooleanRequiredメンテナンス設定
    • true | false
      • true: 設定
      • false: 設定しない
    ipAclCodeStringConditionalIP ACLを許可するかどうか
    • ALLOWED | REJECTED
      • ALLOWED: 許可
      • REJECTED: 拒否
    • ipAclList入力時、必須
    endpointDomainStringRequiredエンドポイントドメイン
    statusCodeIntegerRequired状態コード
    • 100~599
    enabledContentEncodingBooleanOptionalエンコード設定
    • true | false(デフォルト)
      • true: 設定
      • false: 設定しない
    minimumCompressionSizeIntegerOptionalデータ転送時に圧縮するかどうか
    • 圧縮を有効化するには、負の数ではなく整数を入力
      • 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のレスポンスステータスコードをご参照ください。

    レスポンス例

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

    {
        "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
        }
    }
    

    この記事は役に立ちましたか?

    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.