リクエスト

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

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

リクエストヘッダ

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	会員番号リストマスターまたはパートナー代表のみ使用可能
`contractNo`	String	Optional	契約番号
`useStartDay`	String	Required	照会開始日(yyyyMMdd) 最大3か月照会可能 <例> 20240101
`useEndDay`	String	Required	照会最終日(yyyyMMdd) 最大3か月照会可能 <例> 20240331
`contractTypeCode`	String	Optional	契約タイプコード
`productItemKindCode`	String	Optional	サービス品目種類コード
`regionCode`	String	Optional	リージョンコード getRegionListアクションを通じて確認
`responseFormatType`	String	Optional	レスポンス結果の形式 `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"
    }
}

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

リクエスト
レスポンス

タグ

Cost And Usage