Usage Plan 생성
    • PDF

    Usage Plan 생성

    • PDF

    기사 요약

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

    사용자가 지정한 조건에 따라 Usage Plan을 생성합니다.

    요청

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

    메서드URI
    POST/usage-plans

    요청 헤더

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

    요청 구문

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

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

    요청 바디

    요청 바디에 대한 설명은 다음과 같습니다.

    필드타입필수 여부설명
    monthQuotaRequestLongConditional월별 요청 처리 한도(건/월)
    • 0~9,223,372,036,854,775,807
    • dayQuotaRequest 입력 시 필수
    dayQuotaRequestLongConditional일별 요청 처리 한도(건/일)
    • 1~9,223,372,036,854,775,807
    • monthQuotaRequest 입력 시 필수
    usagePlanDescriptionStringOptional생성할 Usage Plan 설명
    • 0~50자
    rateRpsLongOptional요청 처리량(건/초)
    • 1~2,147,483,647
    quotaConditionStringOptional사용량 제어 조건
    • 2xx | 3xx | 4xx | 5xx | others
    usagePlanNameStringRequired생성할 Usage Plan 이름
    • 0~45자

    요청 예시

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

    curl --location --request POST 'https://apigateway.apigw.gov-ntruss.com/api/v1/usage-plans' \
    --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": 10,
        "dayQuotaRequest": 5,
        "rateRps": 2,
        "quotaCondition": "2xx",
        "usagePlanDescription": "usage plan",
        "usagePlanName": "usageplan000"
    }'
    

    응답

    응답 형식을 설명합니다.

    응답 구문

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

    {
        "usagePlan" : {
            "domainCode" : "domainCode",
            "usagePlanId" : "usagePlanId",
            "modifier" : "modifier",
            "associatedStagesCount" : 0,
            "dayQuotaRequest" : 6,
            "permission" : "permission",
            "rateRps" : 5,
            "usagePlanName" : "usagePlanName",
            "monthQuotaRequest" : 1,
            "tenantId" : "tenantId",
            "disabled" : true,
            "usagePlanDescription" : "usagePlanDescription",
            "quotaCondition" : "quotaCondition",
            "actionName" : "actionName"
        }
    }
    

    응답 상태 코드

    API Gateway에서 공통으로 사용하는 응답 상태 코드에 대한 자세한 내용은 API Gateway 응답 상태 코드를 참조해 주십시오.

    응답 예시

    응답 예시는 다음과 같습니다.

    {
        "usagePlan": {
            "tenantId": "***e230cebc1402ba89b148896951***",
            "usagePlanId": "***wthl***",
            "rateRps": 2,
            "usagePlanName": "usageplan000",
            "usagePlanDescription": "usage plan",
            "dayQuotaRequest": 5,
            "quotaCondition" : "2xx",
            "monthQuotaRequest": 10,
            "domainCode": "GOV",
            "associatedStagesCount": 0
        }
    }
    

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

    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.