Abacus利用量メータリングと集計のREST APIは、クラウドリソースプロバイダによる利用量の登録や、リアルタイムにレポートされる利用量ダッシュボード、請求のために料金として集計・計算するための課金システムによって利用されます。例えば、クラウドリソースにはサービス、およびアプリケーションランタイムやコンテナなどが含まれます。
利用量はAbacusによって利用量ドキュメントの形式に変換されます。それぞれのドキュメントタイプはJSON形式と１つ以上のREST関数を持ちます。
リソース利用量集計
リソース設定
リソース単価
利用量サマリレポート
GraphQL利用量クエリ
リソース利用量集計 APIはクラウドリソースプロバイダがクラウドリソースのインスタンス利用量を登録する場合に利用します。クラウドリソースはサービスインスタンスと、アプリケーションランタイム、もしくはコンテナを含みます。
利用量は_リソース利用量_ドキュメントをAbacusにPOSTすることで登録できます。
_リソース利用量ドキュメント_には、1つ以上のクラウドリソースによって計測された利用量が含まれます。
一度_リソース利用量_ドキュメントがAbacusに登録されると、GETメソッドによって取り出すことが可能となります。
HTTP request:
POST /v1/metering/collected/usage with a resource usage document
説明: _リソース利用量_ドキュメントを記録し、そこに含まれているクラウドリソース利用量を処理します。
HTTPレスポンス: 成功した場合、Locationヘッダに_リソース利用量_ドキュメントのURLが設定されて201で返ります。リクエストが不正な場合は400、サーバでエラーが発生した場合は500が返ります。
HTTP request:
GET /v1/metering/collected/usage/:usage_document_id
説明: 以前に登録された_リソース利用量_ドキュメントを取得します。
HTTPレスポンス: _リソース利用量_ドキュメントが200で返ります。利用量が見つからない場合は404、サーバでエラーが発生した場合は500が返ります。
{
"usage": [
{
"start": 1396421450000,
"end": 1396421451000,
"organization_id": "us-south:54257f98-83f0-4eca-ae04-9ea35277a538",
"space_id": "d98b5916-3c77-44b9-ac12-04456df23eae",
"consumer_id": "app:d98b5916-3c77-44b9-ac12-045678edabae",
"resource_id": "object-storage",
"plan_id": "basic",
"resource_instance_id": "d98b5916-3c77-44b9-ac12-04d61c7a4eae",
"measured_usage": [
{
"measure": "storage",
"quantity": 10
},
{
"measure": "api_calls",
"quantity": 10
}
]
}
]
}{
"type": "object",
"required": [
"usage"
],
"properties": {
"usage": {
"type": "array",
"minItems": 1,
"items": {
"type": "object",
"required": [
"start",
"end",
"organization_id",
"space_id",
"resource_id",
"plan_id",
"resource_instance_id",
"measured_usage"
],
"properties": {
"start": {
"type": "integer",
"format": "utc-millisec"
},
"end": {
"type": "integer",
"format": "utc-millisec"
},
"organization_id": {
"type": "string"
},
"space_id": {
"type": "string"
},
"consumer_id": {
"type": "string"
},
"resource_id": {
"type": "string"
},
"plan_id": {
"type": "string"
},
"resource_instance_id": {
"type": "string"
},
"measured_usage": {
"type": "array",
"minItems": 1,
"items": {
"type": "object",
"required": [
"measure",
"quantity"
],
"properties": {
"measure": {
"type": "string"
},
"quantity": {
"type": "number"
}
},
"additionalProperties": false
},
"additionalItems": false
}
},
"additionalProperties": false
},
"additionalItems": false
}
},
"additionalProperties": false,
"title": "Resource Usage"
}リソース設定 APIはクラウドリソースの_リソース設定_ドキュメントを取得するためにAbacusによって利用されます。
_リソース設定_ドキュメントには、計測・メトリクス・単位そしてメータリング・集計・金額計算とレポート形式のタイプが記載されます。 これらはAbacusがメータリングし、金額を計算し、クラウドリソース毎に利用量レポートを作成するために必要なものです。
このAPIはAbacusとクラウドプラットフォーム間の契約を定義します。クラウドプラットフォームは、Abacusが関与しない方法で決められたクラウドリソースが記載されている_リソース設定_ドキュメントを管理することができます。また、GETメソッドがサポートされているAbacusのAPIエンドポイントをによって、これらのドキュメントを簡単に有効化することが出来ます。
HTTP request:
GET /v1/provisioning/resources/:resource_id/config/:time
説明: 指定された時間の、指定された有効なクラウドリソースの設定を取得します。
HTTPレスポンス: 要求された_リソース設定_ドキュメントが200で返ります。設定が見つからない場合は404、サーバでエラーが発生した場合は500が返ります。
{
"resource_id": "object-storage",
"effective": 1420070400000,
"plans": [
{
"plan_id": "basic",
"measures": [
{
"name": "storage",
"unit": "BYTE"
},
{
"name": "api_calls",
"units": "CALL"
}
],
"metrics": [
{
"name": "storage",
"unit": "GIGABYTE",
"meter": "(m) => m.storage / 1073741824",
"accumulate": "(a, qty) => Math.max(a, qty)"
},
{
"name": "thousand_api_calls",
"unit": "THOUSAND_CALLS",
"meter": "(m) => m.light_api_calls / 1000",
"accumulate": "(a, qty) => a ? a + qty : qty",
"aggregate": "(a, qty) => a ? a + qty : qty",
"rate": "(p, qty) => p ? p * qty : 0",
"summarize": "(t, qty) => qty",
"charge": "(t, cost) => cost"
}
]
},
{
"plan_id": "standard",
"measures": [
{
"name": "storage",
"unit": "BYTE"
},
{
"name": "api_calls",
"units": "CALL"
}
],
"metrics": [
{
"name": "storage",
"unit": "GIGABYTE",
"meter": "(m) => m.storage / 1073741824",
"accumulate": "(a, qty) => Math.max(a, qty)"
},
{
"name": "thousand_api_calls",
"unit": "THOUSAND_CALLS",
"meter": "(m) => m.light_api_calls / 1000",
"accumulate": "(a, qty) => a ? a + qty : qty",
"aggregate": "(a, qty) => a ? a + qty : qty",
"rate": "(p, qty) => p ? p * qty : 0",
"summarize": "(t, qty) => qty",
"charge": "(t, cost) => cost"
}
]
}
]
}{
"type": "object",
"required": [
"resource_id",
"effective"
],
"properties": {
"resource_id": {
"type": "string"
},
"effective": {
"type": "integer",
"format": "utc-millisec"
},
"plans": {
"type": "array",
"minItems": 1,
"items": {
"type": "object",
"required": [
"plan_id",
"measures",
"metrics"
],
"properties": {
"plan_id": {
"type": "string"
},
"measures": {
"type": "array",
"minItems": 1,
"items": {
"type": "object",
"required": [
"name",
"unit"
],
"properties": {
"name": {
"type": "string"
},
"unit": {
"type": "string"
}
},
"additionalProperties": false
},
"additionalItems": false
},
"metrics": {
"type": "array",
"minItems": 1,
"items": {
"type": "object",
"required": [
"name",
"unit"
],
"properties": {
"name": {
"type": "string"
},
"unit": {
"type": "string"
},
"meter": {
"type": "string"
},
"accumulate": {
"type": "string"
},
"aggregate": {
"type": "string"
},
"rate": {
"type": "string"
},
"summarize": {
"type": "string"
},
"charge": {
"type": "string"
}
},
"additionalProperties": false
},
"additionalItems": false
}
},
"additionalProperties": false
},
"additionalItems": false
}
},
"additionalProperties": false,
"title": "Resource Definition"
}リソース単価 APIは、Abacusがクラウドリソースに対する_リソース単価_データを取得するときに利用します。
_リソース単価_ドキュメントは、クラウドリソースで計測されたメトリクスの単価を設定するために使われます。異なる国ごとに異なる単価を設定することができます。
このAPIはAbacusとクラウドプラットフォーム間の契約を定義します。クラウドプラットフォームは、Abacusが関与しない方法で決められたクラウドリソースの_リソース単価_データを管理・登録することができます。また、GETメソッドがサポートされているAbacusのAPIエンドポイントをによって、これらの単価データを簡単に有効化することが出来ます。
HTTP request:
GET /v1/pricing/resources/:resource_id/config/:time
説明: 指定された時間の、指定された有効なクラウドリソースの単価を取得します。
HTTPレスポンス: 要求された_リソース単価_ドキュメントが200で返ります。単価データが見つからない場合は404、サーバでエラーが発生した場合は500が返ります。
{
"resource_id": "object-storage",
"effective": 1420070400000,
"plans": [
{
"plan_id": "basic",
"metrics": [
{
"name": "storage",
"prices": [
{
"country": "USA",
"price": 1
},
{
"country": "EUR",
"price": 0.7523
},
{
"country": "CAN",
"price": 1.06
}
]
},
{
"name": "thousand_light_api_calls",
"prices": [
{
"country": "USA",
"price": 0.03
},
{
"country": "EUR",
"price": 0.0226
},
{
"country": "CAN",
"price": 0.0317
}
]
},
{
"name": "heavy_api_calls",
"prices": [
{
"country": "USA",
"price": 0.15
},
{
"country": "EUR",
"price": 0.1129
},
{
"country": "CAN",
"price": 0.1585
}
]
}
]
},
{
"plan_id": "standard",
"metrics": [
{
"name": "storage",
"prices": [
{
"country": "USA",
"price": 0.5
},
{
"country": "EUR",
"price": 0.45
},
{
"country": "CAN",
"price": 0.65
}
]
},
{
"name": "thousand_light_api_calls",
"prices": [
{
"country": "USA",
"price": 0.04
},
{
"country": "EUR",
"price": 0.04
},
{
"country": "CAN",
"price": 0.05
}
]
},
{
"name": "heavy_api_calls",
"prices": [
{
"country": "USA",
"price": 0.18
},
{
"country": "EUR",
"price": 0.16
},
{
"country": "CAN",
"price": 0.24
}
]
}
]
}
]
}{
"title": "priceConfig",
"type": "object",
"properties": {
"resource_id": {
"type": "string"
},
"effective": {
"type": "integer",
"format": "utc-millisec"
},
"plans": {
"type": "array",
"minItems": 1,
"items": {
"title": "plan",
"type": "object",
"properties": {
"plan_id": {
"type": "string"
},
"metrics": {
"type": "array",
"minItems": 1,
"items": {
"title": "metric",
"type": "object",
"properties": {
"name": {
"type": "string"
},
"prices": {
"type": "array",
"minItems": 1,
"items": {
"title": "price",
"type": "object",
"properties": {
"country": {
"type": "string"
},
"price": {
"type": "number"
}
},
"required": [
"country",
"price"
],
"additionalProperties": false
},
"additionalItems": false
}
},
"required": [
"name",
"prices"
],
"additionalProperties": false
},
"additionalItems": false
}
},
"required": [
"plan_id",
"metrics"
],
"additionalProperties": false
},
"additionalItems": false
}
},
"required": [
"resource_id",
"effective",
"plans"
],
"additionalProperties": false
}利用量サマリサポート APIは集計された利用量のサマリレポートドキュメントをAbacusから取得する場合に利用します。
HTTP request:
GET /v1/metering/organizations/:organization_id/aggregated/usage/:time
説明: 指定された時間の、指定された組織に対応した、クラウドリソース使用量の集計結果のサマリを含む、利用量レポートドキュメントを取得します。
HTTPレスポンス: _利用量サマリレポート_のJSONドキュメントが200で返ります。利用量が見つからない場合は404、サーバでエラーが発生した場合は500が返ります。
{
"start": 1435622400000,
"end": 1435708799999,
"processed": 1435708800000,
"organization_id": "us-south:a3d7fe4d-3cb1-4cc3-a831-ffe98e20cf27",
"windows": [
[{
"charge": 46.09,
}],
[{
"charge": 46.09,
}],
[{
"charge": 46.09,
}],
[{
"charge": 46.09,
}],
[{
"charge": 46.09,
}]
],
"id": "k-a3d7fe4d-3cb1-4cc3-a831-ffe98e20cf27-t-0001435622400000",
"spaces": [
{
"space_id": "aaeae239-f3f8-483c-9dd0-de5d41c38b6a",
"windows": [
[{
"charge": 46.09,
}],
[{
"charge": 46.09,
}],
[{
"charge": 46.09,
}],
[{
"charge": 46.09,
}],
[{
"charge": 46.09,
}]
],
"consumers": [
{
"consumer_id": "app:d98b5916-3c77-44b9-ac12-045678edabae",
"windows": [
[{
"charge": 46.09,
}],
[{
"charge": 46.09,
}],
[{
"charge": 46.09,
}],
[{
"charge": 46.09,
}],
[{
"charge": 46.09,
}]
],
"resources": [
{
"resource_id": "object-storage",
"charge": 46.09,
"aggregated_usage": [
{
"metric": "storage",
"windows": [
[{
"quantity": 1,
"summary": 1,
"charge": 1
}],
[{
"quantity": 1,
"summary": 1,
"charge": 1
}],
[{
"quantity": 1,
"summary": 1,
"charge": 1
}],
[{
"quantity": 1,
"summary": 1,
"charge": 1
}],
[{
"quantity": 1,
"summary": 1,
"charge": 1
}]
]
},
{
"metric": "thousand_light_api_calls",
"windows": [
[{
"quantity": 3,
"summary": 3,
"charge": 0.09
}],
[{
"quantity": 3,
"summary": 3,
"charge": 0.09
}],
[{
"quantity": 3,
"summary": 3,
"charge": 0.09
}],
[{
"quantity": 3,
"summary": 3,
"charge": 0.09
}],
[{
"quantity": 3,
"summary": 3,
"charge": 0.09
}]
]
},
{
"metric": "heavy_api_calls",
"windows": [
[{
"quantity": 300,
"summary": 300,
"charge": 45
}],
[{
"quantity": 300,
"summary": 300,
"charge": 45
}],
[{
"quantity": 300,
"summary": 300,
"charge": 45
}],
[{
"quantity": 300,
"summary": 300,
"charge": 45
}],
[{
"quantity": 300,
"summary": 300,
"charge": 45
}]
]
}
],
"plans": [
{
"plan_id": "basic",
"windows": [
[{
"charge": 46.09,
}],
[{
"charge": 46.09,
}],
[{
"charge": 46.09,
}],
[{
"charge": 46.09,
}],
[{
"charge": 46.09,
}]
],
"aggregated_usage": [
{
"metric": "storage",
"windows": [
[{
"quantity": 1,
"summary": 1,
"cost": 1,
"charge": 1
}],
[{
"quantity": 1,
"summary": 1,
"cost": 1,
"charge": 1
}],
[{
"quantity": 1,
"summary": 1,
"cost": 1,
"charge": 1
}],
[{
"quantity": 1,
"summary": 1,
"cost": 1,
"charge": 1
}],
[{
"quantity": 1,
"summary": 1,
"cost": 1,
"charge": 1
}]
]
},
{
"metric": "thousand_light_api_calls",
"windows": [
[{
"quantity": 3,
"summary": 3,
"cost": 0.09,
"charge": 0.09
}],
[{
"quantity": 3,
"summary": 3,
"cost": 0.09,
"charge": 0.09
}],
[{
"quantity": 3,
"summary": 3,
"cost": 0.09,
"charge": 0.09
}],
[{
"quantity": 3,
"summary": 3,
"cost": 0.09,
"charge": 0.09
}],
[{
"quantity": 3,
"summary": 3,
"cost": 0.09,
"charge": 0.09
}]
]
},
{
"metric": "heavy_api_calls",
"windows": [
[{
"quantity": 300,
"summary": 300,
"cost": 45,
"charge": 45
}],
[{
"quantity": 300,
"summary": 300,
"cost": 45,
"charge": 45
}],
[{
"quantity": 300,
"summary": 300,
"cost": 45,
"charge": 45
}],
[{
"quantity": 300,
"summary": 300,
"cost": 45,
"charge": 45
}],
[{
"quantity": 300,
"summary": 300,
"cost": 45,
"charge": 45
}]
]
}
]
}
]
}
]
}
],
"resources": [
{
"resource_id": "object-storage",
"windows": [
[{
"charge": 46.09,
}],
[{
"charge": 46.09,
}],
[{
"charge": 46.09,
}],
[{
"charge": 46.09,
}],
[{
"charge": 46.09,
}]
],
"aggregated_usage": [
{
"metric": "storage",
"windows": [
[{
"quantity": 1,
"summary": 1,
"charge": 1
}],
[{
"quantity": 1,
"summary": 1,
"charge": 1
}],
[{
"quantity": 1,
"summary": 1,
"charge": 1
}],
[{
"quantity": 1,
"summary": 1,
"charge": 1
}],
[{
"quantity": 1,
"summary": 1,
"charge": 1
}]
]
},
{
"metric": "thousand_light_api_calls",
"windows": [
[{
"quantity": 3,
"summary": 3,
"charge": 0.09
}],
[{
"quantity": 3,
"summary": 3,
"charge": 0.09
}],
[{
"quantity": 3,
"summary": 3,
"charge": 0.09
}],
[{
"quantity": 3,
"summary": 3,
"charge": 0.09
}],
[{
"quantity": 3,
"summary": 3,
"charge": 0.09
}]
]
},
{
"metric": "heavy_api_calls",
"windows": [
[{
"quantity": 300,
"summary": 300,
"charge": 45
}],
[{
"quantity": 300,
"summary": 300,
"charge": 45
}],
[{
"quantity": 300,
"summary": 300,
"charge": 45
}],
[{
"quantity": 300,
"summary": 300,
"charge": 45
}],
[{
"quantity": 300,
"summary": 300,
"charge": 45
}]
]
}
],
"plans": [
{
"plan_id": "basic",
"windows": [
[{
"charge": 46.09,
}],
[{
"charge": 46.09,
}],
[{
"charge": 46.09,
}],
[{
"charge": 46.09,
}],
[{
"charge": 46.09,
}]
],
"aggregated_usage": [
{
"metric": "storage",
"windows": [
[{
"quantity": 1,
"summary": 1,
"charge": 1
}],
[{
"quantity": 1,
"summary": 1,
"charge": 1
}],
[{
"quantity": 1,
"summary": 1,
"charge": 1
}],
[{
"quantity": 1,
"summary": 1,
"charge": 1
}],
[{
"quantity": 1,
"summary": 1,
"charge": 1
}]
]
},
{
"metric": "thousand_light_api_calls",
"windows": [
[{
"quantity": 3,
"summary": 3,
"charge": 0.09
}],
[{
"quantity": 3,
"summary": 3,
"charge": 0.09
}],
[{
"quantity": 3,
"summary": 3,
"charge": 0.09
}],
[{
"quantity": 3,
"summary": 3,
"charge": 0.09
}],
[{
"quantity": 3,
"summary": 3,
"charge": 0.09
}]
]
},
{
"metric": "heavy_api_calls",
"windows": [
[{
"quantity": 300,
"summary": 300,
"charge": 45
}],
[{
"quantity": 300,
"summary": 300,
"charge": 45
}],
[{
"quantity": 300,
"summary": 300,
"charge": 45
}],
[{
"quantity": 300,
"summary": 300,
"charge": 45
}],
[{
"quantity": 300,
"summary": 300,
"charge": 45
}]
]
}
]
}
]
}
]
}
],
"resources": [
{
"resource_id": "object-storage",
"windows": [
[{
"charge": 46.09,
}],
[{
"charge": 46.09,
}],
[{
"charge": 46.09,
}],
[{
"charge": 46.09,
}],
[{
"charge": 46.09,
}]
],
"aggregated_usage": [
{
"metric": "storage",
"windows": [
[{
"quantity": 1,
"summary": 1,
"charge": 1
}],
[{
"quantity": 1,
"summary": 1,
"charge": 1
}],
[{
"quantity": 1,
"summary": 1,
"charge": 1
}],
[{
"quantity": 1,
"summary": 1,
"charge": 1
}],
[{
"quantity": 1,
"summary": 1,
"charge": 1
}]
]
},
{
"metric": "thousand_light_api_calls",
"windows": [
[{
"quantity": 3,
"summary": 3,
"charge": 0.09
}],
[{
"quantity": 3,
"summary": 3,
"charge": 0.09
}],
[{
"quantity": 3,
"summary": 3,
"charge": 0.09
}],
[{
"quantity": 3,
"summary": 3,
"charge": 0.09
}],
[{
"quantity": 3,
"summary": 3,
"charge": 0.09
}]
]
},
{
"metric": "heavy_api_calls",
"windows": [
[{
"quantity": 300,
"summary": 300,
"charge": 45
}],
[{
"quantity": 300,
"summary": 300,
"charge": 45
}],
[{
"quantity": 300,
"summary": 300,
"charge": 45
}],
[{
"quantity": 300,
"summary": 300,
"charge": 45
}],
[{
"quantity": 300,
"summary": 300,
"charge": 45
}]
]
}
],
"plans": [
{
"plan_id": "basic",
"windows": [
[{
"charge": 46.09,
}],
[{
"charge": 46.09,
}],
[{
"charge": 46.09,
}],
[{
"charge": 46.09,
}],
[{
"charge": 46.09,
}]
],
"aggregated_usage": [
{
"metric": "storage",
"windows": [
[{
"quantity": 1,
"summary": 1,
"charge": 1
}],
[{
"quantity": 1,
"summary": 1,
"charge": 1
}],
[{
"quantity": 1,
"summary": 1,
"charge": 1
}],
[{
"quantity": 1,
"summary": 1,
"charge": 1
}],
[{
"quantity": 1,
"summary": 1,
"charge": 1
}]
]
},
{
"metric": "thousand_light_api_calls",
"windows": [
[{
"quantity": 3,
"summary": 3,
"charge": 0.09
}],
[{
"quantity": 3,
"summary": 3,
"charge": 0.09
}],
[{
"quantity": 3,
"summary": 3,
"charge": 0.09
}],
[{
"quantity": 3,
"summary": 3,
"charge": 0.09
}],
[{
"quantity": 3,
"summary": 3,
"charge": 0.09
}]
]
},
{
"metric": "heavy_api_calls",
"windows": [
[{
"quantity": 300,
"summary": 300,
"charge": 45
}],
[{
"quantity": 300,
"summary": 300,
"charge": 45
}],
[{
"quantity": 300,
"summary": 300,
"charge": 45
}],
[{
"quantity": 300,
"summary": 300,
"charge": 45
}],
[{
"quantity": 300,
"summary": 300,
"charge": 45
}]
]
}
]
}
]
}
]
}{
"title": "organizationReport",
"type": "object",
"properties": {
"id": {
"type": "string"
},
"start": {
"type": "integer",
"format": "utc-millisec"
},
"end": {
"type": "integer",
"format": "utc-millisec"
},
"processed": {
"type": "integer",
"format": "utc-millisec"
},
"organization_id": {
"type": "string"
},
"windows": {
"type": "array",
"items": {
"title": "cwindow",
"type": "object",
"properties": {
"charge": {
"type": "number"
}
},
"required": [
"charge"
]
}
},
"resources": {
"type": "array",
"minItems": 1,
"items": {
"title": "resource",
"type": "object",
"properties": {
"resource_id": {
"type": "string"
},
"windows": {
"type": "array",
"items": {
"title": "cwindow",
"type": "object",
"properties": {
"charge": {
"type": "number"
}
},
"required": [
"charge"
]
}
},
"aggregated_usage": {
"type": "array",
"minItems": 1,
"items": {
"title": "rmetric",
"type": "object",
"properties": {
"metric": {
"type": "string"
},
"windows": {
"type": "array",
"items": {
"title": "rwindow",
"type": "object",
"properties": {
"quantity": {
"type": "number"
},
"summary": {
"type": "number"
},
"charge": {
"type": "number"
}
},
"required": [
"quantity",
"summary",
"charge"
]
}
}
},
"required": [
"metric",
"windows"
],
"additionalProperties": false
},
"additionalItems": false
},
"plans": {
"type": "array",
"minItems": 1,
"items": {
"title": "plan",
"type": "object",
"properties": {
"plan_id": {
"type": "string"
},
"windows": {
"type": "array",
"items": {
"title": "cwindow",
"type": "object",
"properties": {
"charge": {
"type": "number"
}
},
"required": [
"charge"
]
}
},
"aggregated_usage": {
"type": "array",
"minItems": 1,
"items": {
"title": "pmetric",
"type": "object",
"properties": {
"metric": {
"type": "string"
},
"windows": {
"type": "array",
"items": {
"title": "pwindow",
"type": "object",
"properties": {
"quantity": {
"type": "number"
},
"summary": {
"type": "number"
},
"cost": {
"type": "number"
},
"charge": {
"type": "number"
}
},
"required": [
"quantity",
"summary",
"cost",
"charge"
]
}
}
},
"required": [
"metric",
"windows"
],
"additionalProperties": false
},
"additionalItems": false
}
},
"required": [
"plan_id",
"windows",
"aggregated_usage"
],
"additionalProperties": false
},
"additionalItems": false
}
},
"required": [
"resource_id",
"windows",
"aggregated_usage",
"plans"
],
"additionalProperties": false
},
"additionalItems": false
},
"spaces": {
"type": "array",
"minItems": 1,
"items": {
"title": "space",
"type": "object",
"properties": {
"space_id": {
"type": "string"
},
"windows": {
"type": "array",
"items": {
"title": "cwindow",
"type": "object",
"properties": {
"charge": {
"type": "number"
}
},
"required": [
"charge"
]
}
},
"resources": {
"type": "array",
"minItems": 1,
"items": {
"title": "resource",
"type": "object",
"properties": {
"resource_id": {
"type": "string"
},
"windows": {
"type": "array",
"items": {
"title": "cwindow",
"type": "object",
"properties": {
"charge": {
"type": "number"
}
},
"required": [
"charge"
]
}
},
"aggregated_usage": {
"type": "array",
"minItems": 1,
"items": {
"title": "rmetric",
"type": "object",
"properties": {
"metric": {
"type": "string"
},
"windows": {
"type": "array",
"items": {
"title": "rwindow",
"type": "object",
"properties": {
"quantity": {
"type": "number"
},
"summary": {
"type": "number"
},
"charge": {
"type": "number"
}
},
"required": [
"quantity",
"summary",
"charge"
]
}
}
},
"required": [
"metric",
"windows"
],
"additionalProperties": false
},
"additionalItems": false
},
"plans": {
"type": "array",
"minItems": 1,
"items": {
"title": "plan",
"type": "object",
"properties": {
"plan_id": {
"type": "string"
},
"windows": {
"type": "array",
"items": {
"title": "cwindow",
"type": "object",
"properties": {
"charge": {
"type": "number"
}
},
"required": [
"charge"
]
}
},
"aggregated_usage": {
"type": "array",
"minItems": 1,
"items": {
"title": "pmetric",
"type": "object",
"properties": {
"metric": {
"type": "string"
},
"windows": {
"type": "array",
"items": {
"title": "pwindow",
"type": "object",
"properties": {
"quantity": {
"type": "number"
},
"summary": {
"type": "number"
},
"cost": {
"type": "number"
},
"charge": {
"type": "number"
}
},
"required": [
"quantity",
"summary",
"cost",
"charge"
]
}
}
},
"required": [
"metric",
"windows"
],
"additionalProperties": false
},
"additionalItems": false
}
},
"required": [
"plan_id",
"windows",
"aggregated_usage"
],
"additionalProperties": false
},
"additionalItems": false
}
},
"required": [
"resource_id",
"windows",
"aggregated_usage",
"plans"
],
"additionalProperties": false
},
"additionalItems": false
},
"consumers": {
"type": "array",
"minItems": 1,
"items": {
"title": "consumer",
"type": "object",
"properties": {
"consumer_id": {
"type": "string"
},
"windows": {
"type": "array",
"items": {
"title": "cwindow",
"type": "object",
"properties": {
"charge": {
"type": "number"
}
},
"required": [
"charge"
]
}
},
"resources": {
"type": "array",
"minItems": 1,
"items": {
"title": "resource",
"type": "object",
"properties": {
"resource_id": {
"type": "string"
},
"windows": {
"type": "array",
"items": {
"title": "cwindow",
"type": "object",
"properties": {
"charge": {
"type": "number"
}
},
"required": [
"charge"
]
}
},
"aggregated_usage": {
"type": "array",
"minItems": 1,
"items": {
"title": "rmetric",
"type": "object",
"properties": {
"metric": {
"type": "string"
},
"windows": {
"type": "array",
"items": {
"title": "rwindow",
"type": "object",
"properties": {
"quantity": {
"type": "number"
},
"summary": {
"type": "number"
},
"charge": {
"type": "number"
}
},
"required": [
"quantity",
"summary",
"charge"
]
}
}
},
"required": [
"metric",
"windows"
],
"additionalProperties": false
},
"additionalItems": false
},
"plans": {
"type": "array",
"minItems": 1,
"items": {
"title": "plan",
"type": "object",
"properties": {
"plan_id": {
"type": "string"
},
"windows": {
"type": "array",
"items": {
"title": "cwindow",
"type": "object",
"properties": {
"charge": {
"type": "number"
}
},
"required": [
"charge"
]
}
},
"aggregated_usage": {
"type": "array",
"minItems": 1,
"items": {
"title": "pmetric",
"type": "object",
"properties": {
"metric": {
"type": "string"
},
"windows": {
"type": "array",
"items": {
"title": "pwindow",
"type": "object",
"properties": {
"quantity": {
"type": "number"
},
"summary": {
"type": "number"
},
"cost": {
"type": "number"
},
"charge": {
"type": "number"
}
},
"required": [
"quantity",
"summary",
"cost",
"charge"
]
}
}
},
"required": [
"metric",
"windows"
],
"additionalProperties": false
},
"additionalItems": false
}
},
"required": [
"plan_id",
"windows",
"aggregated_usage"
],
"additionalProperties": false
},
"additionalItems": false
}
},
"required": [
"resource_id",
"windows",
"aggregated_usage",
"plans"
],
"additionalProperties": false
},
"additionalItems": false
}
},
"required": [
"consumer_id",
"windows",
"resources"
],
"additionalProperties": false
},
"additionalItems": false
}
},
"required": [
"space_id",
"windows",
"resources",
"consumers"
],
"additionalProperties": false
},
"additionalItems": false
}
},
"required": [
"id",
"organization_id",
"start",
"end",
"processed",
"windows",
"resources",
"spaces"
],
"additionalProperties": false
}_GraphQL利用量クエリ_APIはGraphQLクエリ言語を用いて利用量を集める場合に利用します。
Abacusでは利用量集計のGraphQLスキーマを定義しています。GraphQLクエリ言語を利用することで、組織とスペース、リソースに含まれている利用量を集計したグラフを問い合わせることができます。
下記のGraphQLスキーマでは、サポートされている利用量のクエリはもちろん、利用量の集計に関する代表的なグラフを表現しています。
GraphQLスキーマとクエリ言語に関する詳細な情報は、GraphQLドキュメントを参照してください。
HTTP request:
GET /v1/metering/aggregated/usage/graph/:query
説明: 指定されたGraphQLクエリにマッチするクラウドリソース利用量のサマリを含む、利用量レポートドキュメントを取得します。
HTTPレスポンス: 成功した場合、_利用量サマリサポート_のJSONドキュメントが200で返ります。利用量が見つからない場合は404、サーバでエラーが発生した場合は500が返ります。
{
organization(
organization_id: "us-south:a3d7fe4d-3cb1-4cc3-a831-ffe98e20cf27",
time: 1435622400000) {
organization_id,
resources {
resource_id,
aggregated_usage {
metric,
quantity
}
}
}
}
{
organization(
organization_id: "us-south:a3d7fe4d-3cb1-4cc3-a831-ffe98e20cf27",
time: 1435622400000) {
organization_id,
spaces {
space_id,
resources {
resource_id,
aggregated_usage {
metric,
quantity
}
}
}
}
}
{
organization(
organization_id: "us-south:a3d7fe4d-3cb1-4cc3-a831-ffe98e20cf27",
time: 1435622400000) {
organization_id,
spaces {
space_id,
consumers {
consumer_id,
resources {
resource_id,
aggregated_usage {
metric,
quantity
}
}
}
}
}
}
{
organization(
organization_id: "us-south:a3d7fe4d-3cb1-4cc3-a831-ffe98e20cf27",
time: 1435622400000) {
organization_id,
spaces {
space_id,
consumers {
consumer_id
}
}
}
}
{
organization(
organization_id: "us-south:a3d7fe4d-3cb1-4cc3-a831-ffe98e20cf27",
time: 1435622400000) {
organization_id,
resources {
resource_id,
aggregated_usage {
metric,
quantity
}
}
}
}
{
organizations(
organization_ids: [
"us-south:a3d7fe4d-3cb1-4cc3-a831-ffe98e20cf27",
"us-south:b3d7fe4d-3cb1-4cc3-a831-ffe98e20cf28"],
time: 1435622400000) {
organization_id,
resources {
resource_id,
aggregated_usage {
metric,
quantity
}
}
}
}
{
account(
account_id: "1234",
time: 1435622400000) {
organization_id,
resources {
resource_id,
aggregated_usage {
metric,
quantity
}
}
}
}
{
resource_instance(
organization_id: "us-south:a3d7fe4d-3cb1-4cc3-a831-ffe98e20cf27",
consumer_id: "bbeae239-f3f8-483c-9dd0-de6781c38bab",
resource_instance_id: "0b39fa70-a65f-4183-bae8-385633ca5c87",
plan_id: "basic",
time: time: 1435622400000) {
organization_id,
space_id,
resource_id,
resource_instance_id,
plan_id,
accumulated_usage {
metric,
windows {
summary,
charge
}
}
}
}type ChargeWindow {
charge: Float
}
type PlanWindow {
quantity: Float
cost: Float
summary: Float
charge: Float
}
type PlanMetric {
metric: String
windows: [[PlanWindow]]
}
type Plan {
plan_id: String
windows: [[ChargeWindow]]
aggregated_usage: [PlanMetric]
}
type ResourceWindow {
quantity: Float
summary: Float
charge: Float
}
type ResourceMetric {
metric: String
windows: [[ResourceWindow]]
}
type Resource {
resource_id: String
windows: [[ChargeWindow]]
aggregated_usage: [ResourceMetric]
plans: [Plan]
}
type Consumer {
consumer_id: String
windows: [[ChargeWindow]]
resources: [Resource]
}
type Space {
space_id: String
windows: [[ChargeWindow]]
resources: [Resource]
consumers: [Consumer]
}
type OrganizationReport {
id: String
start: Int
end: Int
organization_id: String
windows: [[ChargeWindow]]
resources: [Resource]
spaces: [Space]
}
type resourceInstanceReport {
id: String
start: Int
end: Int
organization_id: String
space_id: String
resource_id: String
resource_instance_id: String
consumer_id: String
plan_id: String
windows: [[ChargeWindow]]
accumulated_usage: [PlanMetric]
}
type Query {
organization(
organization_id: String!,
time: Int) : OrganizationReport
organizations(
organization_ids: [String],
time: Int) : [OrganizationReport]
account(
account_id: String!,
time: Int) : [OrganizationReport]
}