getContractUsageListByDaily
    • PDF

    getContractUsageListByDaily

    • PDF

    記事の要約

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

    設定期間に基づいて日別サービス使用量を照会します。

    リクエスト

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

    メソッドURI
    GET、POST/cost/getContractUsageListByDaily

    リクエストヘッダ

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

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

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

    フィールドタイプ必須の有無説明
    pageNoIntegerOptionalページ番号
    pageSizeIntegerOptionalページサイズ
    • 1,000以下(デフォルト: 1,000)
    isOrganizationBooleanOptionalOrganizationサービスアカウントの統合照会かどうか
    • マスターのみ使用可能
    • isOrganizationisPartnerのいずれもtrueの場合、エラーを返す
    isPartnerBooleanOptionalパートナーアカウントの照会かどうか
    • パートナー代表のみ使用可能
    • isOrganizationisPartnerのいずれもtrueの場合、エラーを返す
    memberNoListList<String>Optional会員番号リスト
    • マスターまたはパートナー代表のみ使用可能
    contractNoStringOptional契約番号
    useStartDayStringRequired照会開始日(yyyyMMdd)
    • 最大3か月照会可能
    • <例> 20240101
    useEndDayStringRequired照会最終日(yyyyMMdd)
    • 最大3か月照会可能
    • <例> 20240331
    contractTypeCodeStringOptional契約タイプコード
    productItemKindCodeStringOptionalサービス品目種類コード
    regionCodeStringOptionalリージョンコード
    responseFormatTypeStringOptionalレスポンス結果の形式
    • xml(デフォルト) | json

    リクエスト例

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

    curl --location --request GET 'https://billingapi.apigw.ntruss.com/billing/v1/cost/getContractUsageListByDaily?useStartDay=20240101&useEndDay=20240131&responseFormatType=json' \
    --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}'
    

    レスポンス

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

    レスポンスボディ

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

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

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

    レスポンス例

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

    {
        "getContractUsageListByDailyResponse": {
            "totalRows": 47,
            "contractUsageListByDaily": [
                {
                    "account": {
                        "memberNo": "2760000"
                    },
                    "useDate": {
                        "useStartDate": "2024-01-09T00:00:00+0900",
                        "useEndDate": "2024-01-09T23:59:59+0900"
                    },
                    "contract": {
                        "contractNo": "15430000",
                        "conjunctionContractNo": "",
                        "contractType": {
                            "code": "SVR",
                            "codeName": "Server"
                        },
                        "contractStatus": {
                            "code": "NLEND",
                            "codeName": "Normal termination"
                        },
                        "contractStartDate": "2024-01-09T11:40:50+0900",
                        "contractEndDate": "2024-01-24T11:35:45+0900",
                        "instanceName": "s18cec180a45",
                        "regionCode": "KR",
                        "platformType": {}
                    },
                    "contractProduct": {
                        "contractProductSequence": "1",
                        "beforeContractProductSequence": "",
                        "productCode": "SPSVRSSD00000003",
                        "priceNo": "327",
                        "promiseNo": "",
                        "instanceNo": "22010000",
                        "productItemKind": {
                            "code": "SVR",
                            "codeName": "Server"
                        },
                        "productRatingType": {
                            "code": "SVR",
                            "codeName": "Server Usage"
                        },
                        "serviceStatus": {
                            "code": "END",
                            "codeName": "Termination"
                        },
                        "serviceStartDate": "2024-01-09T11:40:50+0900",
                        "serviceEndDate": "2024-01-24T11:35:45+0900",
                        "productSize": 0,
                        "productCount": 0
                    },
                    "usage": {
                        "meteringType": {
                            "code": "SVR",
                            "codeName": "Server Usage"
                        },
                        "usageQuantity": 44124,
                        "unit": {
                            "code": "USAGE_SEC",
                            "codeName": "Usage time (per second)"
                        },
                        "userUsageQuantity": 12.256667,
                        "userUnit": {
                            "code": "HOUR",
                            "codeName": "Hour(s)"
                        }
                    }
                },
    // (省略)
            ],
            "requestId": "000000a0-a570-46ad-a8f9-bdc25c000000",
            "returnCode": "0",
            "returnMessage": "success"
        }
    }
    

    この記事は役に立ちましたか?

    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.