Obtaining the resource-based 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/resources/YYYY/MM

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

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

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

HTTPステータスコード#

正常時:200

エラー時:400, 401, 500, 503

リクエストパラメータの説明#

名前 In Type デフォルト値
/必須指定
Description
X-Auth-Token header string 必須 認証のトークン
start_date query string 必須 集計時刻"collected_at"を対象とした検索範囲の開始日時を指定します。
ただし、時刻部分は”00:00:00.000”を指定する。
(ISO8601フォーマット: YYYY-MM-DD'T'HH:MM:SS.sss)
domain_id query string 必須 絞込条件にドメインIDを指定します。
project_id query string 任意 絞込条件にプロジェクト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から本要素で指定されている日時までの使用量に基づいて計算されていることを示します。
domain_id string 請求対象となるドメインのID
currency_code string 課金額の通貨コード(ISO4217)
reseller_id string 請求対象となるリセラーのID
projects array プロジェクト毎の情報が入ったArray
project_id string 請求対象となるプロジェクトのID
"YYYY-MM"形式です。
region_id string 請求対象となるリージョンのID
"YYYY-MM"形式です。
products array 商品毎の情報が入ったArray
product_id string 請求対象となる商品のID
"YYYY-MM"形式です。
service_provider_id string 商品のサービスプロバイダのID
service_id string 請求対象となった商品を提供するサービスのID
product_name array 言語毎の商品名が入ったArray
リストの各要素はobject型で、以下のメンバーを持ちます。
"lang"(String):
   言語コード(ISO639-1)
"value"(String):
   商品名
unit_name array 言語毎の使用量の単位が入ったArray
リストの各要素はobject型で、以下のメンバーを持ちます。
"lang"(String):
>   言語コード(ISO639-1)
"value"(String):
>   単位を表す文字列
resources array リソース毎の情報が入ったArray
resource_id string 請求対象となるリソースのID
details array 課金区分毎の情報が入ったArray
detail_type string 課金の区分
「billing」(課金)か「trial」(トライアル)
usage number 請求対象となった使用量
charge number 課金額
unit_price number 商品の単価

リクエスト例#

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

レスポンス例#

{
  "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
                }
              ]
            }
          ]
        }
      ]
    }
  ]
}