API料金・利用量集計 APIgetクライアントアプリ全体の料金・利用量集計結果の取得get特定の課金分類ラベルについての料金・利用量集計結果の取得get課金分類ラベルごとの料金・利用量集計結果の取得スキーマCostAndUsageResponseAPI docs by RedoclyRICOH Live Streaming REST API: 料金・利用量集計 API (v1)Download OpenAPI specification:DownloadRICOH Live Streaming REST API は Live Streaming サービスの公開 REST API です。本ページは料金・利用量集計 API の仕様について記載します。共通仕様API の認証/認可に失敗した場合、ステータスコード 401 のレスポンスが返却されます本 API で取得されるデータの保証範囲について終了後 24 時間以上経過した RoomInstance について確定した値が算入されていることを保証します指定時刻範囲についてRoomInstance の開始時刻が since 以降、until 未満のデータ、及び、その RoomInstance に付随する ConnectionInstance のデータに対して集計が行われますsince で指定可能な時刻は、現在時刻から過去 1 年以内until で指定可能な時刻は、since 以降 1 ヶ月以内approximate_total_cost および approximate_cost について単位は日本円 (JPY) です料金・利用量の明細リストの各明細項目についてitem_nameusage の単位詳細connection_time分usage は ConnectionInstance 単位で接続時間の 1 分未満を切り捨てた値の合計値traffic_volumeGiBusage はデータ通信量の合計値クライアントアプリ全体の集計の場合は合計値の 1GiB 未満を切り捨てた値room_specのtypeがsfuまたはsfu_largeの場合はSFUサーバの送受信量を対象としますroom_specのtypeがp2p_turnの場合は中継経路上の各TURNサーバからの送信量を対象としますbitrate_reservation分sub_items は各予約帯域幅設定ごとの副項目のリスト各副項目の item_name は予約帯域幅の設定値 (Mbps) 各副項目の usage は RoomInstance 単位で接続時間の 1 分未満を切り捨てた値の合計値料金・利用量集計 APIクライアントアプリ全体の料金・利用量集計結果の取得 Authorizations:ClientBasicpath Parametersclient_idrequiredstring Client IDquery ParametersenvArray of strings (LSEnv) Default: ["prod","dev"]Items Enum: "prod" "dev" 集計対象の環境prod: プロダクション環境dev: 開発環境複数指定可能 ?env=prod&env=dev指定されない場合は全ての環境について収集しますsincerequiredstring 集計範囲の開始時刻 (ISO8601 拡張形式)untilrequiredstring 集計範囲の終了時刻 (ISO8601 拡張形式)Responses200 CostAndUsageResponse オブジェクトクライアントアプリ全体の集計結果のため、 classification_label は空となります400 リクエスト不正error_id の値invalid_parameter: リクエストのクエリパラメータの不正、options のキーに不正だったパラメータ名が入りますget/clients/{client_id}/cost_and_usage/totalv1 Endpointhttps://api.livestreaming.mw.smart-integration.ricoh.com/v1/clients/{client_id}/cost_and_usage/total Response samples 200400Content typeapplication/jsonCopy Expand all Collapse all {"results": [{"classification_label": "string","approximate_total_cost": 0,"items": [{"item_name": "string","usage": 0,"approximate_cost": 0}]}]}特定の課金分類ラベルについての料金・利用量集計結果の取得 Authorizations:ClientBasicpath Parametersclient_idrequiredstring Client IDclassification_labelrequiredstring 課金分類ラベルquery ParametersenvArray of strings (LSEnv) Default: ["prod","dev"]Items Enum: "prod" "dev" 集計対象の環境prod: プロダクション環境dev: 開発環境複数指定可能 ?env=prod&env=dev指定されない場合は全ての環境について収集しますsincerequiredstring 集計範囲の開始時刻 (ISO8601 拡張形式)untilrequiredstring 集計範囲の終了時刻 (ISO8601 拡張形式)Responses200 CostAndUsageResponse オブジェクト400 リクエスト不正error_id の値invalid_parameter: リクエストのクエリパラメータの不正、options のキーに不正だったパラメータ名が入りますget/clients/{client_id}/cost_and_usage/classification_labels/{classification_label}v1 Endpointhttps://api.livestreaming.mw.smart-integration.ricoh.com/v1/clients/{client_id}/cost_and_usage/classification_labels/{classification_label} Response samples 200400Content typeapplication/jsonCopy Expand all Collapse all {"results": [{"classification_label": "string","approximate_total_cost": 0,"items": [{"item_name": "string","usage": 0,"approximate_cost": 0}]}]}課金分類ラベルごとの料金・利用量集計結果の取得 Authorizations:ClientBasicpath Parametersclient_idrequiredstring Client IDquery ParametersenvArray of strings (LSEnv) Default: ["prod","dev"]Items Enum: "prod" "dev" 集計対象の環境prod: プロダクション環境dev: 開発環境複数指定可能 ?env=prod&env=dev指定されない場合は全ての環境について収集しますsincerequiredstring 集計範囲の開始時刻 (ISO8601 拡張形式)untilrequiredstring 集計範囲の終了時刻 (ISO8601 拡張形式)starts_withstring この値に前方一致する課金分類ラベルについてのみ結果を返却します指定されない場合は全ての課金分類ラベルについての結果を返却しますResponses200 CostAndUsageResponse オブジェクト400 リクエスト不正error_id の値invalid_parameter: リクエストのクエリパラメータの不正、options のキーに不正だったパラメータ名が入りますget/clients/{client_id}/cost_and_usage/classification_labelsv1 Endpointhttps://api.livestreaming.mw.smart-integration.ricoh.com/v1/clients/{client_id}/cost_and_usage/classification_labels Response samples 200400Content typeapplication/jsonCopy Expand all Collapse all {"results": [{"classification_label": "string","approximate_total_cost": 0,"items": [{"item_name": "string","usage": 0,"approximate_cost": 0}]}]}CostAndUsageResponseresultsArray of objects (CostAndUsage) 料金・利用量オブジェクトのリストCopy Expand all Collapse all {"results": [{"classification_label": "string","approximate_total_cost": 0,"items": [{"item_name": "string","usage": 0,"approximate_cost": 0}]}]} const __redoc_state = {"menu":{"activeItemIdx":-1},"spec":{"data":{"openapi":"3.0.2","info":{"title":"RICOH Live Streaming REST API: 料金・利用量集計 API","version":"v1","description":"RICOH Live Streaming REST API は Live Streaming サービスの公開 REST API です。\n\n本ページは料金・利用量集計 API の仕様について記載します。\n\n### 共通仕様\n- API の認証/認可に失敗した場合、ステータスコード 401 のレスポンスが返却されます\n- 本 API で取得されるデータの保証範囲について\n - 終了後 24 時間以上経過した `RoomInstance` について確定した値が算入されていることを保証します\n- 指定時刻範囲について\n - `RoomInstance` の開始時刻が `since` 以降、`until` 未満のデータ、及び、その `RoomInstance` に付随する `ConnectionInstance` のデータに対して集計が行われます\n - `since` で指定可能な時刻は、現在時刻から過去 1 年以内\n - `until` で指定可能な時刻は、`since` 以降 1 ヶ月以内\n- `approximate_total_cost` および `approximate_cost` について\n - 単位は日本円 (JPY) です\n- 料金・利用量の明細リストの各明細項目について\n | item_name | usage の単位 | 詳細\n |:--------------------|:------------|:-----\n | connection_time | 分 | `usage` は `ConnectionInstance` 単位で接続時間の 1 分未満を切り捨てた値の合計値 |\n | traffic_volume | GiB | `usage` はデータ通信量の合計値
クライアントアプリ全体の集計の場合は合計値の 1GiB 未満を切り捨てた値
`room_spec`の`type`が`sfu`または`sfu_large`の場合はSFUサーバの送受信量を対象とします
`room_spec`の`type`が`p2p_turn`の場合は中継経路上の各TURNサーバからの送信量を対象とします |\n | bitrate_reservation | 分 | `sub_items` は各予約帯域幅設定ごとの副項目のリスト
各副項目の `item_name` は予約帯域幅の設定値 (Mbps)
各副項目の `usage` は `RoomInstance` 単位で接続時間の 1 分未満を切り捨てた値の合計値 |\n"},"servers":[{"url":"https://api.livestreaming.mw.smart-integration.ricoh.com/v1","description":"v1 Endpoint"}],"x-tagGroups":[{"name":"API","tags":["api_cost_and_usage"]},{"name":"スキーマ","tags":["cost_and_usage_response"]}],"tags":[{"name":"api_cost_and_usage","x-displayName":"料金・利用量集計 API"},{"name":"cost_and_usage_response","x-displayName":"CostAndUsageResponse","description":""}],"paths":{"/clients/{client_id}/cost_and_usage/total":{"get":{"summary":"クライアントアプリ全体の料金・利用量集計結果の取得","tags":["api_cost_and_usage"],"security":[{"ClientBasic":[]}],"parameters":[{"$ref":"#/components/parameters/client_id"},{"$ref":"#/components/parameters/env_optional"},{"$ref":"#/components/parameters/since"},{"$ref":"#/components/parameters/until"}],"responses":{"200":{"description":"CostAndUsageResponse オブジェクト\n- クライアントアプリ全体の集計結果のため、 `classification_label` は空となります\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CostAndUsageResponse"}}}},"400":{"$ref":"#/components/responses/400"}}}},"/clients/{client_id}/cost_and_usage/classification_labels/{classification_label}":{"get":{"summary":"特定の課金分類ラベルについての料金・利用量集計結果の取得","tags":["api_cost_and_usage"],"security":[{"ClientBasic":[]}],"parameters":[{"$ref":"#/components/parameters/client_id"},{"$ref":"#/components/parameters/classification_label"},{"$ref":"#/components/parameters/env_optional"},{"$ref":"#/components/parameters/since"},{"$ref":"#/components/parameters/until"}],"responses":{"200":{"description":"CostAndUsageResponse オブジェクト\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CostAndUsageResponse"}}}},"400":{"$ref":"#/components/responses/400"}}}},"/clients/{client_id}/cost_and_usage/classification_labels":{"get":{"summary":"課金分類ラベルごとの料金・利用量集計結果の取得","tags":["api_cost_and_usage"],"security":[{"ClientBasic":[]}],"parameters":[{"$ref":"#/components/parameters/client_id"},{"$ref":"#/components/parameters/env_optional"},{"$ref":"#/components/parameters/since"},{"$ref":"#/components/parameters/until"},{"$ref":"#/components/parameters/classification_label_starts_with"}],"responses":{"200":{"description":"CostAndUsageResponse オブジェクト\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CostAndUsageResponse"}}}},"400":{"$ref":"#/components/responses/400"}}}}},"components":{"schemas":{"CostAndUsageResponse":{"description":"- 料金・利用量集計 API のレスポンス\n","type":"object","properties":{"results":{"type":"array","description":"- 料金・利用量オブジェクトのリスト\n","items":{"$ref":"#/components/schemas/CostAndUsage"}}}},"CostAndUsage":{"type":"object","required":["plan_id","currency","approximate_total_cost","items"],"properties":{"classification_label":{"type":"string","description":"- 課金分類ラベル\n- 課金分類ラベルごとの集計の場合のみ設定され、クライアントアプリ全体の集計の場合は空\n"},"approximate_total_cost":{"type":"number","description":"- 料金合計の概算値\n"},"items":{"type":"array","description":"- 料金・利用量の明細リスト\n","items":{"oneOf":[{"$ref":"#/components/schemas/CostAndUsageItem"},{"$ref":"#/components/schemas/HierarchicalCostAndUsageItem"}]}}}},"CostAndUsageItem":{"description":"- 明細項目の利用量及び料金\n","required":["item_name","usage","usage_unit","approximate_cost"],"properties":{"item_name":{"type":"string","description":"- 項目名\n"},"usage":{"type":"number","description":"- 項目の利用量\n"},"approximate_cost":{"type":"number","description":"- 項目の料金の概算値\n"}}},"HierarchicalCostAndUsageItem":{"description":"- 料金形態が階層化された明細項目の利用量及び料金\n","required":["item_name","stages"],"properties":{"item_name":{"type":"string","description":"- 項目名\n"},"sub_items":{"type":"array","description":"- サブ項目に関しての利用量及び料金オブジェクトのリスト\n","items":{"$ref":"#/components/schemas/CostAndUsageItem"}}}},"Error":{"type":"object","required":["error_id"],"properties":{"error_id":{"type":"string","description":"- エラーの種類を識別する ID\n"},"message":{"type":"string","description":"- エラーの内容を記述した開発者向けのメッセージ\n- バージョンアップによってテキストの内容が変更される可能性があるため、これに依存した処理を実装してはいけません\n"},"options":{"type":"object","description":"- エラーの補助情報\n- 内容は API および error_id によって異なります\n"}}},"LSEnv":{"type":"string","enum":["prod","dev"],"description":"- Live Streaming の環境種別\n - prod: プロダクション環境\n - dev: 開発環境\n"},"schemas-Error":{"type":"object","required":["error_id"],"properties":{"error_id":{"type":"string","description":"- エラーの種類を識別する ID\n"},"message":{"type":"string","description":"- エラーの内容を記述した開発者向けのメッセージ\n- バージョンアップによってテキストの内容が変更される可能性があるため、これに依存した処理を実装してはいけません\n"},"options":{"type":"object","description":"- エラーの補助情報\n- 内容は API および error_id によって異なります\n"}}}},"parameters":{"client_id":{"in":"path","name":"client_id","schema":{"type":"string"},"required":true,"description":"- Client ID\n"},"env_optional":{"in":"query","name":"env","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/LSEnv"},"default":["prod","dev"]},"description":"- 集計対象の環境\n - prod: プロダクション環境\n - dev: 開発環境\n\n- 複数指定可能 `?env=prod&env=dev`\n- 指定されない場合は全ての環境について収集します\n"},"since":{"in":"query","name":"since","required":true,"schema":{"type":"string","format":"date-time"},"description":"- 集計範囲の開始時刻 (ISO8601 拡張形式)\n"},"until":{"in":"query","name":"until","required":true,"schema":{"type":"string","format":"date-time"},"description":"- 集計範囲の終了時刻 (ISO8601 拡張形式)\n"},"classification_label":{"in":"path","name":"classification_label","required":true,"schema":{"type":"string"},"description":"- 課金分類ラベル\n"},"classification_label_starts_with":{"in":"query","name":"starts_with","required":false,"schema":{"type":"string"},"description":"- この値に前方一致する課金分類ラベルについてのみ結果を返却します\n- 指定されない場合は全ての課金分類ラベルについての結果を返却します\n"}},"securitySchemes":{"ClientBasic":{"type":"http","scheme":"basic","description":"Client ID を username、ClientSecretを password にした Basic 認証"}},"responses":{"400":{"description":"リクエスト不正\n- error_id の値\n\n - invalid_parameter: リクエストのクエリパラメータの不正、options のキーに不正だったパラメータ名が入ります\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/schemas-Error"}}}}}}}},"searchIndex":{"store":["tag/api_cost_and_usage","tag/api_cost_and_usage/paths/~1clients~1{client_id}~1cost_and_usage~1total/get","tag/api_cost_and_usage/paths/~1clients~1{client_id}~1cost_and_usage~1classification_labels~1{classification_label}/get","tag/api_cost_and_usage/paths/~1clients~1{client_id}~1cost_and_usage~1classification_labels/get","tag/cost_and_usage_response"],"index":{"version":"2.3.9","fields":["title","description"],"fieldVectors":[["title/0",[0,0.068,1,1.089]],["description/0",[]],["title/1",[0,0.093]],["description/1",[2,1.488]],["title/2",[0,0.093]],["description/2",[3,1.488]],["title/3",[0,0.093]],["description/3",[4,1.488]],["title/4",[5,1.488]],["description/4",[0,0.054,6,0.859,7,0.859]]],"invertedIndex":[["",{"_index":0,"title":{"0":{},"1":{},"2":{},"3":{}},"description":{"4":{}}}],["api",{"_index":1,"title":{"0":{}},"description":{}}],["clients/{client_id}/cost_and_usage/classification_label",{"_index":4,"title":{},"description":{"3":{}}}],["clients/{client_id}/cost_and_usage/classification_labels/{classification_label",{"_index":3,"title":{},"description":{"2":{}}}],["clients/{client_id}/cost_and_usage/tot",{"_index":2,"title":{},"description":{"1":{}}}],["costandusagerespons",{"_index":5,"title":{"4":{}},"description":{}}],["schemadefinit",{"_index":6,"title":{},"description":{"4":{}}}],["schemaref=\"#/components/schemas/costandusagerespons",{"_index":7,"title":{},"description":{"4":{}}}]],"pipeline":[]}},"options":{}}; var container = document.getElementById('redoc'); Redoc.hydrate(__redoc_state, container);