暫定課金情報の取得 (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時までの使用量となる)
Request Headers
X-Auth-Token:
認証トークンIDを指定する。
Data Type | Cardinality |
---|---|
String | 1..1 |
Request Parameter
start_date
集計時刻"collected_at"を対象とした検索範囲の開始日時を指定する。
(ISO8601フォーマット: YYYY-MM-DD'T'HH:MM:SS.sss)
課金集計の開始時刻ではなく課金の締め時刻を範囲指定するためのパラメータ。start_dateとend_dateの範囲に入るcollected_atに該当する課金情報が戻される。
collected_atは集計日の0時で表現されるため、指定したい時刻の24時間前の日時を設定すること。
Data Type | Cardinality |
---|---|
String | 1..1[Mandatory] |
end_date
集計時刻"collected_at"を対象とした検索範囲の終了日時を指定する。
(ISO8601フォーマット: YYYY-MM-DD'T'HH:MM:SS.sss)
課金集計の終了時刻ではなく課金の締め時刻を範囲指定するためのパラメータ。start_dateとend_dateの範囲に入るcollected_atに該当する課金情報が戻される。
collected_atは集計日の0時で表現されるため、指定したい時刻の24時間前の日時を設定すること。
Data Type | Cardinality |
---|---|
String | 1..1[Mandatory] |
domain_id
絞込条件にドメインIDを指定する。省略時には認証トークンから得られるドメインIDが使用される。
Data Type | Cardinality |
---|---|
String | 0..1 |
project_id
絞込条件にプロジェクトIDを指定する。指定時には、指定されたプロジェクトのみで集計された課金情報を返却する。この場合のレスポンス情報の、sub_divは"P"となる。
省略するとプロジェクト毎の個別ではなく、domain_idで指定された(domain_id省略時は認証トークンから得られる)ドメインの全プロジェクトを合計して集計された課金情報を返却する。この場合のレスポンス情報の、sub_divは"D"となる。
なお、集計範囲が、ドメイン全体か, 指定されたプロジェクトなのかは、domain_idの指定にかかわらず、本パラメータの指定に依存する。
Data Type | Cardinality |
---|---|
String | 0..1 |
product_id
絞込条件に商品IDを指定する。
Data Type | Cardinality |
---|---|
String | 0..1 |
service_id
絞込条件にサービスIDを指定する。
Data Type | Cardinality |
---|---|
String | 0..1 |
region_id
絞込条件にリソースが配備されているリージョンのIDを指定する。
Data Type | Cardinality |
---|---|
String | 0..1 |
Response Headers
ステータス
リクエストのステータスを返却する。
以下もしくは「API共通エラー情報」へ記載のステータス。
- 200:
- 正常終了
Data Type | Cardinality |
---|---|
Int | 1..1 |
Content-Type
application/json
Data Type | Cardinality |
---|---|
String | 1..1 |
Response Elements
last_modified
本データの最終更新時刻(UTC)。
ISO-8601の下記形式とする。
YYYY-MM-DD'T'HH:mm:ss.sss
タイムゾーンは指定しない
Data Type | Cardinality | Parent Element | Child Element(s) |
---|---|---|---|
String | 1..1 | None | None |
billing_month
請求の対象となる月。
"YYYY-MM"形式とする。
Data Type | Cardinality | Parent Element | Child Element(s) |
---|---|---|---|
String | 1..1 | None | None |
collected_at
本データの集計時刻。本データは、billing_monthで指定される月の1日00:00から本要素で指定されている日時までの使用量に基づいて計算されていることを示す。
Data Type | Cardinality | Parent Element | Child Element(s) |
---|---|---|---|
String | 1..1 | None | None |
sub_div
- ドメイン毎:
- "D"
- プロジェクト毎:
- "P"
Data Type | Cardinality | Parent Element | Child Element(s) |
---|---|---|---|
String | 1..1 | None | None |
domain_id
請求対象となるドメインのID
Data Type | Cardinality | Parent Element | Child Element(s) |
---|---|---|---|
String | 1..1 | None | None |
project_id
請求対象となるプロジェクトのID
Data Type | Cardinality | Parent Element | Child Element(s) |
---|---|---|---|
String | 0..1 |
None | None |
line_seq
明細上の行番号。
Data Type | Cardinality | Parent Element | Child Element(s) |
---|---|---|---|
Number | 1..1 | None | None |
detail_div
- 定額:
- 01
- 一時:
- 02
- 従量:
- 03
- 割引:
- 04
- 小計:
- 05
- 調整:
- 07
- 合計:
- 08
- コメント:
- 99
Data Type | Cardinality | Parent Element | Child Element(s) |
---|---|---|---|
String | 1..1 | None | None |
reseller_id
契約しているリセラーのID
Data Type | Cardinality | Parent Element | Child Element(s) |
---|---|---|---|
String | 1..1 | None | None |
product_id
請求対象となった商品のID
Data Type | Cardinality | Parent Element | Child Element(s) |
---|---|---|---|
String | 1..1 | None | None |
region_id
請求対象となったリージョンのID
Data Type | Cardinality | Parent Element | Child Element(s) |
---|---|---|---|
String | 1..1 | None | None |
service_provider_id
商品のサービスプロバイダのID
Data Type | Cardinality | Parent Element | Child Element(s) |
---|---|---|---|
String | 1..1 | None | None |
product_name
言語毎の商品名が入ったArray。
- "lang"(String):
- 言語コード(ISO639-1)
- "value"(String):
- 商品名
Data Type | Cardinality | Parent Element | Child Element(s) |
---|---|---|---|
Array | 1..1 | None | None |
comment
言語毎の備考情報が入ったArray。
- "lang"(String):
- 言語コード(ISO639-1)
- "value"(String):
- 備考
Data Type | Cardinality | Parent Element | Child Element(s) |
---|---|---|---|
Array | 1..1 | None | None |
usage
請求対象となった使用量
Data Type | Cardinality | Parent Element | Child Element(s) |
---|---|---|---|
Number | 1..1 | None | None |
unit_price
商品の単価
Data Type | Cardinality | Parent Element | Child Element(s) |
---|---|---|---|
Number | 1..1 | None | None |
unit_name
言語毎の使用量の単位が入ったArray。
- "lang"(String):
- 言語コード(ISO639-1)
- "value"(String):
- 単位を表す文字列
Data Type | Cardinality | Parent Element | Child Element(s) |
---|---|---|---|
Array | 1..1 | None | None |
charge
課金額
Data Type | Cardinality | Parent Element | Child Element(s) |
---|---|---|---|
Number | 1..1 | None | None |
currency_code
課金額の通貨コード(ISO4217)
Data Type | Cardinality | Parent Element | Child Element(s) |
---|---|---|---|
String | 1..1 | None | None |
Example of Request
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'
Example of Response
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"
}
]