Stage에 연결된 Usage Plan 조회
    • PDF

    Stage에 연결된 Usage Plan 조회

    • PDF

    기사 요약

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

    지정한 Stage에 연결된 Usage Plan의 상세 정보를 조회합니다.

    요청

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

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

    요청 헤더

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

    요청 경로 파라미터

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

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

    요청 쿼리 파라미터

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

    필드타입필수 여부설명
    offsetLongOptional응답 데이터의 시작 지점
    • 0~9,223,372,036,854,775,807
    • limit과 함께 페이지네이션 구현에 사용
    limitLongOptional응답 데이터의 최대 수
    • 1~9,223,372,036,854,775,807
    • offset과 함께 페이지네이션 구현에 사용
    usagePlanNameStringOptionalUsage Plan 이름
    • 0~45자

    요청 예시

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

    curl --location --request GET 'https://apigateway.apigw.gov-ntruss.com/api/v1/products/***ksk9***/apis/***51hs***/stages/***fh5o***/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}'
    

    응답

    응답 형식을 설명합니다.

    응답 구문

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

    {
        "total" : 5,
        "monthQuotaRequest" : 6,
        "dayQuotaRequest" : 0,
        "rateRps" : 1,
        "quotaCondition" : "quotaCondition",
        "content" : [ {
            "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 응답 상태 코드를 참조해 주십시오.

    응답 예시

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

    {
        "content": [
            {
                "tenantId": "***e230cebc1402ba89b148896951***",
                "usagePlanId": "***xogj***",
                "usagePlanName": "usageplan001",
                "domainCode": "GOV",
                "associatedStagesCount": 1
            }
        ],
        "total": 1
    }
    

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

    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.