Obtaining the Interim Billing Information#
指定した期間と条件に合致する、各月のある日時時点での暫定課金情報を取得します。
APIエンドポイント#
| リージョン | APIエンドポイント |
|---|---|
| 西日本リージョン3の場合 | https://billing.gls.cloud.global.fujitsu.com |
| 東日本リージョン3の場合 | https://billing.gls.cloud.global.fujitsu.com |
HTTPメソッドとURI#
GET
/v1/charges/transition/YYYY/MM
取得する請求対象月は、URIの「YYYY」には4桁の西暦、「MM」には2桁の月で指定します。2015年3月分の情報を検索対象とする場合には、「/v1/charges/transition/2015/03」をURIとしてください。
課金の開始時刻はその月の月初の0時、課金の締め時刻はcollected_atで戻される日時の終日です。
（例：collected_at が2017-05-15T00:00:00.000の場合は、2017年5月1日0時から2017年5月15日24時までの使用量です）
HTTPステータスコード#
正常時：200
エラー時：400, 401, 404, 415, 500
リクエストパラメータの説明#
| 名前 | In | Type | デフォルト値 /必須指定 |
Description |
|---|---|---|---|---|
| X-Auth-Token | header | string | 必須 | 認証のトークン |
| start_date | query | string | 必須 | 集計時刻"collected_at"を対象とした検索範囲の開始日時を指定します。 (ISO8601フォーマット: YYYY-MM-DD'T'HH:MM:SS.sss) 📒注: 課金集計の開始時刻ではなく課金の締め時刻を範囲指定するためのパラメータです。start_dateとend_dateの範囲に入るcollected_atに該当する課金情報が戻されます。 collected_atは集計日の0時で表現されるため、指定したい時刻の24時間前の日時を設定してください。 |
| end_date | query | string | 必須 | 集計時刻"collected_at"を対象とした検索範囲の終了日時を指定します。 (ISO8601フォーマット: YYYY-MM-DD'T'HH:MM:SS.sss) 📒注: 課金集計の終了時刻ではなく課金の締め時刻を範囲指定するためのパラメータです。start_dateとend_dateの範囲に入るcollected_atに該当する課金情報が戻されます。 collected_atは集計日の0時で表現されるため、指定したい時刻の24時間前の日時を設定してください。 |
| domain_id | query | string | 任意 | 絞込条件にドメインIDを指定します。省略時には認証トークンから得られるドメインIDが使用されます。 |
| project_id | query | string | 任意 | 絞込条件にプロジェクトIDを指定します。指定時には、指定されたプロジェクトのみで集計された課金情報を返却します。この場合のレスポンス情報の、sub_divは"P"です。 省略するとプロジェクト毎の個別ではなく、domain_idで指定された（domain_id省略時は認証トークンから得られる）ドメインの全プロジェクトを合計して集計された課金情報を返却します。この場合のレスポンス情報の、sub_divは"D"です。 なお、集計範囲が、ドメイン全体か, 指定されたプロジェクトなのかは、domain_idの指定にかかわらず、本パラメータの指定に依存します。 |
| product_id | query | string | 任意 | 絞込条件に商品IDを指定します。 |
| service_id | query | string | 任意 | 絞込条件にサービスIDを指定します。 |
| region_id | query | string | 任意 | 絞込条件にリソースが配備されているリージョンのIDを指定します。 |
レスポンスボディ（正常系）の説明#
| 名前 | Type | Description |
|---|---|---|
| Content-Type | string | 「application/json」が表示されます。 |
| last_modified | string | 本データの最終更新時刻(UTC) ISO-8601の下記形式です。 YYYY-MM-DD'T'HH:mm:ss.sss タイムゾーンは指定しません。 |
| billing_month | string | 請求の対象となる月 "YYYY-MM"形式です。 |
| collected_at | string | 本データの集計時刻 本データは、billing_monthで指定される月の1日00:00から本要素で指定されている日時までの使用量に基づいて計算されていることを示します。 |
| sub_div | string | 請求の集計区分 区分に応じて、以下の文字列が返却されます。 ドメイン毎： "D" プロジェクト毎： "P" |
| domain_id | string | 請求対象となるドメインのID |
| project_id | string | 請求対象となるプロジェクトのID |
| line_seq | number | 明細上の行番号 |
| detail_div | string | 明細上の記載区分 区分に応じて、以下の文字列が返却されます。 定額： 01 一時： 02 従量： 03 割引： 04 小計： 05 調整： 07 合計： 08 コメント： 99 |
| reseller_id | string | 契約しているリセラーのID |
| product_id | string | 請求対象となった商品のID |
| region_id | string | 請求対象となったリージョンのID |
| service_provider_id | string | 商品のサービスプロバイダのID |
| product_name | array | 言語毎の商品名が入ったArray リストの各要素はobject型で、以下のメンバーを持ちます。 "lang"(String)： 言語コード(ISO639-1) "value"(String)： 商品名 |
| comment | array | 言語毎の備考情報が入ったArray リストの各要素はobject型で、以下のメンバーを持ちます。 "lang"(String)： 言語コード(ISO639-1) "value"(String)： 備考 |
| usage | number | 請求対象となった使用量 |
| unit_price | number | 商品の単価 |
| unit_name | array | 言語毎の使用量の単位が入ったArray リストの各要素はobject型で、以下のメンバーを持ちます。 "lang"(String)： > 言語コード(ISO639-1) "value"(String)： > 単位を表す文字列 |
| charge | number | 課金額 |
| currency_code | string | 課金額の通貨コード(ISO4217) |
リクエスト例#
GET /v1/charges/transition/2018/05?start_date=2018-05-02T00:00:00.000&end_date=2018-05-06T00:00:00.000®ion_id=de-1 & service_id=compute& product_id=VMXXXX -H 'X-Auth-Token:511ec1290.....' -H 'Content-Type:application/json' -H 'Accept:application/json'
レスポンス例#
HTTP/1.1 200 OK Content-Type： application/json ... [ { "last_modified": "2018-05-03T06:06:34.600", "billing_month": "2018-05", "sub_div": "D", "collected_at": "2018-05-02T00:00:00.000", "domain_id": "59856ae83b.....", "project_id": "", "line_seq": 134, "detail_div": "03", "reseller_id": "jp.fujitsu.com", "product_id": "VMXXXX", "region_id": "de-1", "service_provider_id": "fcx.fujitsu.com", "service_id": "compute", "product_name": [ { "lang": "ja", "value": "仮想サーバ S-1タイプ" }, { "lang": "en", "value": "Virtual Server S-1 type" } ], "comment": [ { "lang": "ja", "value": "" } ], "usage": 352, "unit_price": 7.88, "unit_name": [ { "lang": "ja", "value": "台数・時間" }, { "lang": "en", "value": "Number*Hours" } ], "charge": 2773.76, "currency_code": "JPY" }, { "last_modified": "2018-05-04T06:06:31.029", "billing_month": "2018-05", "sub_div": "D", "collected_at": "2018-05-03T00:00:00.000", "domain_id": "59856ae83b.....", "project_id": "", "line_seq": 134, "detail_div": "03", "reseller_id": "jp.fujitsu.com", "product_id": "VMXXXX", "region_id": "de-1", "service_provider_id": "fcx.fujitsu.com", "service_id": "compute", "product_name": [ { "lang": "ja", "value": "仮想サーバ S-1タイプ" }, { "lang": "en", "value": "Virtual Server S-1 type" } ], "comment": [ { "lang": "ja", "value": "" } ], "usage": 528, "unit_price": 7.88, "unit_name": [ { "lang": "ja", "value": "台数・時間" }, { "lang": "en", "value": "Number*Hours" } ], "charge": 4160.64, "currency_code": "JPY" }, { "last_modified": "2018-05-05T06:06:54.581", "billing_month": "2018-05", "sub_div": "D", "collected_at": "2018-05-04T00:00:00.000", "domain_id": "59856ae83b.....", "project_id": "", "line_seq": 134, "detail_div": "03", "reseller_id": "jp.fujitsu.com", "product_id": "VMXXXX", "region_id": "de-1", "service_provider_id": "fcx.fujitsu.com", "service_id": "compute", "product_name": [ { "lang": "ja", "value": "仮想サーバ S-1タイプ" }, { "lang": "en", "value": "Virtual Server S-1 type" } ], "comment": [ { "lang": "ja", "value": "" } ], "usage": 704, "unit_price": 7.88, "unit_name": [ { "lang": "ja", "value": "台数・時間" }, { "lang": "en", "value": "Number*Hours" } ], "charge": 5547.52, "currency_code": "JPY" }, { "last_modified": "2018-05-06T06:07:09.723", "billing_month": "2018-05", "sub_div": "D", "collected_at": "2018-05-05T00:00:00.000", "domain_id": "59856ae83b.....", "project_id": "", "line_seq": 134, "detail_div": "03", "reseller_id": "jp.fujitsu.com", "product_id": "VMXXXX", "region_id": "de-1", "service_provider_id": "fcx.fujitsu.com", "service_id": "compute", "product_name": [ { "lang": "ja", "value": "仮想サーバ S-1タイプ" }, { "lang": "en", "value": "Virtual Server S-1 type" } ], "comment": [ { "lang": "ja", "value": "" } ], "usage": 880, "unit_price": 7.88, "unit_name": [ { "lang": "ja", "value": "台数・時間" }, { "lang": "en", "value": "Number*Hours" } ], "charge": 6934.4, "currency_code": "JPY" }, { "last_modified": "2018-05-07T06:07:30.022", "billing_month": "2018-05", "sub_div": "D", "collected_at": "2018-05-06T00:00:00.000", "domain_id": "59856ae83b.....", "project_id": "", "line_seq": 134, "detail_div": "03", "reseller_id": "jp.fujitsu.com", "product_id": "VMXXXX", "region_id": "de-1", "service_provider_id": "fcx.fujitsu.com", "service_id": "compute", "product_name": [ { "lang": "ja", "value": "仮想サーバ S-1タイプ" }, { "lang": "en", "value": "Virtual Server S-1 type" } ], "comment": [ { "lang": "ja", "value": "" } ], "usage": 1056, "unit_price": 7.88, "unit_name": [ { "lang": "ja", "value": "台数・時間" }, { "lang": "en", "value": "Number*Hours" } ], "charge": 8321.28, "currency_code": "JPY" } ]