getContractSummaryList

Prev Next

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

ユーザー契約要約リストを照会します。
契約サマリーはリージョンコード、契約区分コード、契約数で構成されています。

リクエスト

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

メソッド URI
GET /cost/getContractSummaryList

リクエストヘッダ

Cost and Usage APIで共通して使用されるヘッダの詳細は、Cost And Usageの共通ヘッダをご参照ください。

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

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

フィールド タイプ 必須の有無 説明
pageNo Integer Optional ページ番号
pageSize Integer Optional ページサイズ
  • 1,000以下(デフォルト: 1,000)
isOrganization Boolean Optional Organization下位アカウントの統合使用量を照会するかどうか
  • マスターのみ使用可能
  • isOrganization、isPartnerがいずれもtrueの場合、エラーを返す
    		•
    isPartner Boolean Optional パートナーアカウントの照会かどうか
    • パートナー代表のみ使用可能
    • isOrganization、isPartnerのいずれもtrueの場合、エラーを返す
    memberNoList List<String> Optional 会員番号リスト
    • マスターまたはパートナー代表のみ使用可能
    contractMonth String Required 照会対象の契約年月(yyyyMM)
    • <例> 202404
    contractTypeCode String Optional 契約タイプコード
    contractStatusCode String Optional 契約状態コード
    • ALL(デフォルト) | NOML | NLEND
      • ALL: すべて
      • NOML: 正常
      • NLEND: 終了
    regionCode String Optional リージョンコード
    • regionCodeはgetRegionListアクションを通じて取得可能
    responseFormatType String Optional レスポンス結果の形式
    • xml(デフォルト) | json

    リクエスト例

    リクエストのサンプルコードは次の通りです。

    curl --location 'https://billingapi.apigw.ntruss.com/billing/v1/cost/getContractSummaryList?contractMonth=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}'

    レスポンス

    レスポンス形式を説明します。

    レスポンスボディ

    レスポンスボディの詳細は、ContractSummaryListをご参照ください。

    レスポンスステータスコード

    NAVERクラウドプラットフォームでで共通して使用されるレスポンスステータスコードの詳細は、Ncloud APIのレスポンスステータスコードをご参照ください。

    レスポンス例

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

    <?xml version="1.0" encoding="UTF-8"?>
<getContractSummaryListResponse>
    <requestId>db96b2c0-****-****-****-939ab748350e</requestId>
    <returnCode>0</returnCode>
    <returnMessage>success</returnMessage>
    <totalRows>3</totalRows>
    <contractSummaryList>
        <contractSummary>
            <memberNo>2706412</memberNo>
            <regionCode>KR</regionCode>
            <contractCount>1</contractCount>
            <contractType>
                <code>ARCST</code>
                <codeName>Archive Storage</codeName>
            </contractType>
            <contractStatus>
                <code>ALL</code>
                <codeName>ALL</codeName>
            </contractStatus>
        </contractSummary>
        <contractSummary>
            <memberNo>2706412</memberNo>
            <regionCode>KR</regionCode>
            <contractCount>2</contractCount>
            <contractType>
                <code>CTNRR</code>
                <codeName>Container Registry</codeName>
            </contractType>
            <contractStatus>
                <code>ALL</code>
                <codeName>ALL</codeName>
            </contractStatus>
        </contractSummary>
        <contractSummary>
            <memberNo>2706412</memberNo>
            <regionCode>KR</regionCode>
            <contractCount>1</contractCount>
            <contractType>
                <code>OBJST</code>
                <codeName>Object Storage</codeName>
            </contractType>
            <contractStatus>
                <code>ALL</code>
                <codeName>ALL</codeName>
            </contractStatus>
        </contractSummary>
    </contractSummaryList>
</getContractSummaryListResponse>