getContractUsageList
    • PDF

    getContractUsageList

    • PDF

    기사 요약

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

    계약 사용량 리스트를 조회합니다.

    요청

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

    메서드URI
    GET/cost/getContractUsageList

    요청 헤더

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

    요청 쿼리 파라미터

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

    필드타입필수 여부설명
    pageNoIntegerOptional페이지 번호
    pageSizeIntegerOptional페이지 크기
    • 1,000 이하(기본값: 1,000)
    isOrganizationBooleanOptionalOrganization 서비스 계정 통합 조회 여부
    • 마스터만 사용 가능
    • isOrganization, isPartner 모두 true이면 에러 응답
    isPartnerBooleanOptional파트너 계정 조회 여부
    • 파트너 대표만 사용 가능
    • isOrganization, isPartner 모두 true이면 에러 응답
    memberNoListList<String>Optional회원 번호 목록
    • 마스터 또는 파트너 대표만 사용 가능
    contractNoStringOptional계약 번호
    startMonthStringRequired조회 시작 월(yyyyMM)
    • 최대 3개월 조회 가능
    • <예시> 202401
    endMonthStringRequired조회 마지막 월(yyyyMM)
    • 최대 3개월 조회 가능
    • <예시> 202403
    contractTypeCodeStringOptional계약 유형 코드
    contractStatusCodeStringOptional계약 상태 코드
    • ALL (기본값) | NOML | NLEND
      • ALL: 모두
      • NOML: 정상
      • NLEND: 종료
    regionCodeStringOptional리전 코드
    responseFormatTypeStringOptional응답 결과의 형식
    • xml (기본값) | json

    요청 예시

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

    curl --location 'https://billingapi.apigw.ntruss.com/billing/v1/cost/getContractUsageList?startMonth=202402&endMonth=202404'
    --header 'x-ncp-apigw-timestamp: {Timestamp}' \
    --header 'x-ncp-iam-access-key: {Sub Account Access Key}' \
    --header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'
    

    응답

    응답 형식을 설명합니다.

    응답 바디

    응답 바디는 ContractList를 참조해 주십시오.

    응답 상태 코드

    네이버 클라우드 플랫폼에서 공통으로 사용하는 응답 상태 코드에 대한 자세한 내용은 Ncloud API 응답 상태 코드를 참조해 주십시오.

    응답 예시

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

    <?xml version="1.0" encoding="UTF-8"?>
    <getContractUsageListResponse>
        <requestId>e05dd3ef-****-****-****-bb973f080144</requestId>
        <returnCode>0</returnCode>
        <returnMessage>success</returnMessage>
        <totalRows>1</totalRows>
        <contractList>
            <contract>
                <memberNo>******</memberNo>
                <contractNo>9294191</contractNo>
                <conjunctionContractNo></conjunctionContractNo>
                <contractType>
                    <code>VSVR</code>
                    <codeName>Server (VPC)</codeName>
                </contractType>
                <contractStatus>
                    <code>NOML</code>
                    <codeName>Normal</codeName>
                </contractStatus>
                <contractStartDate>2022-05-17T14:57:54+0900</contractStartDate>
                <contractEndDate>2999-12-31T23:59:59+0900</contractEndDate>
                <instanceName>nas-linux</instanceName>
                <regionCode>KR</regionCode>
                <platformType>
                    <code>VPC</code>
                    <codeName>VPC</codeName>
                </platformType>
                <contractProductList>
                    <contractProduct>
                        <contractProductSequence>1</contractProductSequence>
                        <beforeContractProductSequence></beforeContractProductSequence>
                        <productCode>SVR.VSVR.HICPU.C002.M004.NET.SSD.B050.G002</productCode>
                        <priceNo>10525</priceNo>
                        <promiseNo></promiseNo>
                        <instanceNo>11025677</instanceNo>
                        <productItemKind>
                            <code>VSVR</code>
                            <codeName>Server (VPC)</codeName>
                        </productItemKind>
                        <productRatingType>
                            <code>VSVR</code>
                            <codeName>Server (VPC) Usage</codeName>
                        </productRatingType>
                        <serviceStatus>
                            <code>NOML</code>
                            <codeName>Normal</codeName>
                        </serviceStatus>
                        <serviceStartDate>2022-05-17T14:57:54+0900</serviceStartDate>
                        <serviceEndDate>2999-12-31T23:59:59+0900</serviceEndDate>
                        <productSize>0</productSize>
                        <productCount>0</productCount>
                        <usageList>
                            <usage>
                                <meteringType>
                                    <code>VSVR</code>
                                    <codeName>Server (VPC) Usage</codeName>
                                </meteringType>
                                <useMonth>202404</useMonth>
                                <usageQuantity>864000</usageQuantity>
                                <unit>
                                    <code>USAGE_SEC</code>
                                    <codeName>Usage time (per second)</codeName>
                                </unit>
                                <userUsageQuantity>240</userUsageQuantity>
                                <userUnit>
                                    <code>HOUR</code>
                                    <codeName>Hour(s)</codeName>
                                </userUnit>
                            </usage>
                        </usageList>
                    </contractProduct>
                </contractProductList>
            </contract>
        </contractList>
    </getContractUsageListResponse>
    

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

    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.