暫定課金情報(リソース単位)の取得 (GET /v1/charges/transition/resources/YYYY/MM)

指定した期間と条件に合致する各月の確定済み課金情報を取得する。

取得する請求対象月は、URIの「YYYY」には4桁の西暦、「MM」には2桁の月で指定する。2021年1月分の情報を検索対象とする場合には、「/v1/charges/resources/2021/01」をURIとする。

 課金の開始時刻はその月の月初の0時、課金の締め時刻はcollected_atで戻される日時の終日となる。

(例:collected_at が2021-01-15T00:00:00.000の場合は、2021年1月1日0時から2021年1月15日24時までの使用量となる)

Request Headers

X-Auth-Token:

認証トークンIDを指定する。

Data Type Cardinality
String 1..1

Request Parameter

start_date

集計時刻"collected_at"を対象とした検索範囲の開始日時を指定する。

ただし、時刻部分は”00:00:00.000”を指定する。

(ISO8601フォーマット: YYYY-MM-DD'T'HH:MM:SS.sss)

Data Type Cardinality
String 1..1[Mandatory]

domain_id

絞込条件にドメインIDを指定する。

Data Type Cardinality
String 1..1[Mandatory]

project_id

絞込条件にプロジェクト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

domain_id

請求対象となるドメインのID

Data Type Cardinality Parent Element Child Element(s)
String 1..1 None None

currency_code

課金額の通貨コード(ISO4217)

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

projects

プロジェクト毎の情報が入ったArray

Data Type Cardinality Parent Element Child Element(s)
Array 1..1 None None

project_id

請求対象となるプロジェクトのID

"YYYY-MM"形式とする。

Data Type Cardinality Parent Element Child Element(s)
String 1..1 None None

region_id

請求対象となるリージョンのID

"YYYY-MM"形式とする。

Data Type Cardinality Parent Element Child Element(s)
String 1..1 None None

products

商品毎の情報が入ったArray

Data Type Cardinality Parent Element Child Element(s)
Array 1..1 None None

product_id

請求対象となる商品のID

"YYYY-MM"形式とする。

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

service_id

請求対象となった商品を提供するサービスのID

Data Type Cardinality Parent Element Child Element(s)
String 1..1 None None

product_name

言語毎の商品名が入ったArray

リストの各要素はobject型で、以下のメンバーを持つ。
"lang"(String):
言語コード(ISO639-1)
"value"(String):
商品名
Data Type Cardinality Parent Element Child Element(s)
Array 1..1 None None

unit_name

言語毎の使用量の単位が入ったArray

リストの各要素はobject型で、以下のメンバーを持つ。
"lang"(String):
言語コード(ISO639-1)
"value"(String):
単位を表す文字列
Data Type Cardinality Parent Element Child Element(s)
Array 1..1 None None

resources

リソース毎の情報が入ったArray

Data Type Cardinality Parent Element Child Element(s)
Array 1..1 None None

resource_id

請求対象となるリソースのID

Data Type Cardinality Parent Element Child Element(s)
String 1..1 None None

details

課金区分毎の情報が入ったArray

Data Type Cardinality Parent Element Child Element(s)
Array 1..1 None None

detail_type

課金の区分

billing」(課金)か「trial」(トライアル)

Data Type Cardinality Parent Element Child Element(s)
String 1..1 None None

usage

請求対象となった使用量

Data Type Cardinality Parent Element Child Element(s)
Number 1..1 None None

charge

課金額

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

Example of Request

GET /v1/charges/transition/resources/2021/01
HTTP/1.1
X-Auth-Token: "JpZCI6ICJjM2VlNzA4YTZhZTI0ZGRmOTJjMDc4..."
     

Example of Response

{
  "last_modified" : "2021-01-01T12:00:00.000",
  "billing_month" : "2021-01",
  "collected_at" : "2020-01-15T11:00:00.000",
  "domain_id" : "ca-1a2b3c4d5e",
  "currency_code" : "JPY",
  "reseller_id" : "ResellerId",
  "projects" : [
    {
      "project_id" : "a6944d763bf64ee6a275f1263fae0352",
      "region_id" : "jp-east-1",
      "products" : [
        {
          "product_id" : "P01C010001",
          "service_provider_id" : "fujitsu.com",
          "service_id" : "compute",
          "product_name" : [
            { "lang" : "ja", "value" : "商品名" },
            { "lang" : "en", "value" : "Product Name" },
            { "lang" : "de", "value" : "Produktname" }
          ],
          "unit_name" : [
            { "lang" : "ja", "value" : "GB" },
            { "lang" : "en", "value" : "GB" },
            { "lang" : "de", "value" : "GB" }
          ],
          "resources" : [
            {
              "resource_id" : "f5dc173b-6804-445a-a6d8-c705dad5b5eb",
              "details" : [
                {
                  "detail_type" : "trial",
                  "usage" : 23038502.1,
                  "charge" : 0,
                  "unit_price" : 0
                },
                {
                  "detail_type" : "billing",
                  "usage" : 23038502.1,
                  "charge" : 1280,
                  "unit_price" : 0.214
                }
              ]
            }
          ]
        }
      ]
    }
  ]
}