Show Usage Statistics For Tenant#

プロジェクトの利用情報の統計を表示します。

APIエンドポイント#

リージョン APIエンドポイント
西日本リージョン3の場合 https://compute.jp-west-3.cloud.global.fujitsu.com
東日本リージョン3の場合 https://compute.jp-east-3.cloud.global.fujitsu.com

HTTPメソッドとURI#

GET

/v2.1/{project_id}/os-simple-tenant-usage/{project_id}

HTTPステータスコード#

正常時:200

エラー時:400, 401, 403

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

名前 In Type デフォルト値
/必須指定
Description
project_id path string 必須 プロジェクトのUUID
end query string 任意 コンピュートとストレージのリソースの統計の計算終了日時
以下の形式のどれかで指定します。
CCYY-MM-DDThh:mm:ss
例: 2015-08-27T09:49:58.
CCYY-MM-DDThh:mm:ss.NNNNNN
例: 2015-08-27T09:49:58.123456.
CCYY-MM-DD hh:mm:ss.NNNNNN
例: 2015-08-2709:49:58.123456.
省略する場合は、現在の時刻が利用されます。
start query string 任意 コンピュートとストレージのリソース統計の計算開始日時
以下の形式のどれかで指定します。
CCYY-MM-DDThh:mm:ss
例: 2015-08-27T09:49:58.
CCYY-MM-DDThh:mm:ss.NNNNNN
例:2015-08-27T09:49:58.123456.
CCYY-MM-DD hh:mm:ss.NNNNNN
例: 2015-08-2709:49:58.123456.
省略する場合は、現在の時間が利用されます。
limit query integer 任意 クエリ結果で返却される項目の最大数
指定されたlimit値を超えない範囲で、最大個数の項目が返却されます。limitパラメータを指定した場合、レスポンス内の最後の項目のIDをmarkerパラメータで指定して再度リクエストを送ることで、リストの続きを取得することができます。
📒注:マイクロバージョン2.40以上を指定してください。
marker query string 任意 前回のレスポンスの最後項目のID
limitパラメータを指定した場合、レスポンス内の最後の項目のIDをmarkerパラメータで指定して再度リクエストを送ることで、リストの続きを取得することができます。
📒注: マイクロバージョン2.40以上を指定してください。

レスポンスボディ(正常系)の説明#

名前 Type Description
tenant_usage object プロジェクト利用のオブジェクト
server_usages array サーバ利用のオブジェクトのリスト
server_usages.ended_at string サーバの削除日時
以下の形式で表示されます。
CCYY-MM-DDThh:mm:ss.NNNNNN
例: 2015-08-27T09:49:58.123456.
サーバがまだ存在する場合は、「null」です。
server_usages.flavor string フレーバーの表示名
server_usages.hours float サーバの生存時間(時単位)
server_usages.instance_id string サーバのUUID
server_usages.local_gb integer サーバのシステムディスクサイズと揮発性ディスクサイズの合計(GB単位)
server_usages.memory_mb integer サーバのメモリサイズ(MB単位)
server_usages.name string サーバの名前
server_usages.started_at string サーバの起動日時
以下の形式で表示されます。
CCYY-MM-DDThh:mm:ss.NNNNNN
例: 2015-08-27T09:49:58.123456.
server_usages.state string VMの状態
server_usages.tenant_id string マルチプロジェクトクラウドでのプロジェクトのUUID
server_usages.uptime integer サーバのアップタイム
server_usages.vcpus integer サーバが利用している仮想CPUの数
start string コンピュートとストレージのリソース統計の計算開始日時
以下の形式で表示されます。
CCYY-MM-DDThh:mm:ss.NNNNNN
例:2015-08-27T09:49:58.123456
stop string コンピュートとストレージのリソース統計の計算終了日時
以下の形式で表示されます。
CCYY-MM-DDThh:mm:ss.NNNNNN
例:2015-08-27T09:49:58.123456
tenant_id string プロジェクトのUUID
total_hours float サーバの生存時間(時単位)
total_local_gb_usage float 各サーバの生存時間とサーバディスクサイズを掛け算した総数(GB単位)
total_memory_mb_usage float 各サーバの生存時間とサーバメモリサイズを掛け算した総数(MB単位)
total_vcpus_usage float 各サーバの生存時間と仮想CPUの数を掛け算した総数
tenant_usage_links array 利用情報に関連するリンクURL
📒注: 表示するにはマイクロバージョン2.40以上を指定してください。

レスポンス例#

{
    "tenant_usage": {
        "server_usages": [
            {
                "ended_at": null,
                "flavor": "m1.tiny",
                "hours": 1.0,
                "instance_id": "1f1deceb-17b5-4c04-84c7-e0d4499c8fe0",
                "local_gb": 1,
                "memory_mb": 512,
                "name": "instance-2",
                "started_at": "2012-10-08T20:10:44.541277",
                "state": "active",
                "tenant_id": "6f70656e737461636b20342065766572",
                "uptime": 3600,
                "vcpus": 1
            }
        ],
        "start": "2012-10-08T20:10:44.587336",
        "stop": "2012-10-08T21:10:44.587336",
        "tenant_id": "6f70656e737461636b20342065766572",
        "total_hours": 1.0,
        "total_local_gb_usage": 1.0,
        "total_memory_mb_usage": 512.0,
        "total_vcpus_usage": 1.0
    },
    "tenant_usage_links": [
        {
            "href": "http://openstack.example.com/v2.1/6f70656e737461636b20342065766572/os-simple-tenant-usage/6f70656e737461636b20342065766572?end=2016-10-12+18%3A22%3A04.868106&limit=1&marker=1f1deceb-17b5-4c04-84c7-e0d4499c8fe0&start=2016-10-12+18%3A22%3A04.868106",
            "rel": "next"
        }
    ]
}