Default Usage Plan 설정
    • PDF

    Default Usage Plan 설정

    • PDF

    기사 요약

    Classic/VPC 환경에서 이용 가능합니다.

    지정한 Stage의 Default Usage Plan을 설정합니다.

    요청

    요청 형식을 설명합니다. 요청 형식은 다음과 같습니다.

    메서드URI
    PUT/products/{product-id}/apis/{api-id}/stages/{stage-id}/usage-plan

    요청 헤더

    API Gateway에서 공통으로 사용하는 헤더에 대한 자세한 내용은 API Gateway 요청 헤더를 참조해 주십시오.

    요청 경로 파라미터

    파라미터에 대한 설명은 다음과 같습니다.

    필드타입필수 여부설명
    product-idStringRequiredStage가 속한 Product ID
    api-idStringRequiredStage가 속한 API ID
    stage-idStringRequiredDefault Usage Plan을 설정할 Stage ID

    요청 구문

    요청 구문은 다음과 같습니다.

    {
        "monthQuotaRequest" : 1,
        "dayQuotaRequest" : 6,
        "rateRps" : 0,
        "quotaCondition" : "quotaCondition"
    }
    

    요청 바디

    파라미터에 대한 설명은 다음과 같습니다.

    필드타입필수 여부설명
    monthQuotaRequestLongConditional월별 요청 처리 한도(건/월)
    • 0~9,007,199,254,740,991
    • dayQuotaRequest 입력 시 필수
    dayQuotaRequestLongConditional일별 요청 처리 한도(건/일)
    • 0~9,007,199,254,740,991
    • monthQuotaRequest 입력 시 필수
    rateRpsLongOptional요청 처리량(건/초)
    • 1~2,147,483,647
    quotaConditionStringOptional사용량 제어 조건
    • 2xx | 3xx | 4xx | 5xx | others

    요청 예시

    요청 예시는 다음과 같습니다.

    curl --location --request PUT 'https://apigateway.apigw.gov-ntruss.com/api/v1/products/***ksk9***/apis/***51hs***/stages/***fh5o***/usage-plan' \
    --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 '{
        "monthQuotaRequest" : 1,
        "dayQuotaRequest" : 6,
        "quotaCondition": "2xx",
        "rateRps" : 1
    }'
    

    응답

    응답 형식을 설명합니다.

    응답 구문

    응답 구문은 다음과 같습니다.

    {
        "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": "***fh5o***",
            "apiId": "***51hs***",
            "stageName": "stage000",
            "endpointDomain": "https://test***.test.com",
            "rateRps": 1,
            "dayQuotaRequest": 6,
            "monthQuotaRequest": 1,
            "deployedStageDeploymentNo": 250***,
            "regTime": "2024-05-07T23:48:47Z",
            "isMaintenance": false,
            "enabledContentEncoding": false
        }
    }
    

    이 문서가 도움이 되었습니까?

    What's Next
    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.