リソース一覧取得 (GET /v2/resources)

指定されたクエリに基づいて、すべてのリソースを取得します。

Request Headers

API共通項目」を参照してください。

Request Parameter

q.field

以下の検索対象のフィールドを指定します。

  • resource_id:リソースID。
  • source:監視項目のソース。
  • user_id:監視項目を登録したユーザーID。

未指定の場合は、すべてのリソースを取得します。

Data Type Cardinality
String 0..10

q.op

以下の比較演算子を指定します。

  • q.fieldがresource_idの場合

    eq:等しい

  • q.fieldがsourceの場合

    eq:等しい

  • q.fieldがuser_idの場合

    eq:等しい

未指定の場合は、"eq"が設定されます。

Data Type Cardinality
String 0..10

q.value

比較対象データの値。

以下の比較対象データの値を指定します。

  • q.fieldがresource_idの場合

    リソースID

  • q.fieldがsourceの場合

    ソース

  • q.fieldがuser_idの場合

    ユーザーID

使用可能文字:全角文字、半角英数字、半角記号

文字数:1~255文字

Data Type Cardinality
String 0..10

meter_links

関連する監視項目のリンク情報を取得するかどうかを指定します。

  • 0:取得しない
  • 0以外:取得する

未指定の場合は、0以外(取得する)が設定されます。

Data Type Cardinality
Int 0..1

limit

取得するリソースの最大数を指定します。

範囲:1~1440

未指定の場合は、1440が設定されます。

Data Type Cardinality
Int 0..1

offset

取得するリソースのオフセットとなる件数を指定します。

未指定の場合は、0が設定されます。

Data Type Cardinality
Int 0..1

Response Headers

ステータス

正常の場合は以下のステータスを返却します。

200:正常終了

異常の場合は、「API共通エラー情報」を参照してください。

Data Type Cardinality
Int 1..1

Response Elements

指定された条件に基づいて取得したリソースのリストをJSON形式で返します。

内容の詳細は、「type Resource」を参照してください。

Example of Request

例1:すべてのリソースの一覧を取得する。


curl -H 'X-Auth-Token: ImFkbWluVVJMIjogImh0dHA6Ly8xMC4x...' \
'https://telemetry.jp-east-1.cloud.global.fujitsu.com/v2/resources'
     

例2:limitを指定して、取得するリソース数の上限を設定する。


curl -H 'X-Auth-Token: ImFkbWluVVJMIjogImh0dHA6Ly8xMC4x...' \
'https://telemetry.jp-east-1.cloud.global.fujitsu.com/v2/resources?limit=100
     

Example of Response


[
    {
        "links": [
            {
                "href": "https://telemetry.jp-east-1.cloud.global.fujitsu.com/v2/resources/bef3d406-a050-4854-821e-c3024d286e03", 
                "rel": "self"
            }
        ], 
        "project_id": "7c4f776d782049108a6255aaff940629", 
        "resource_id": "bef3d406-a050-4854-821e-c3024d286e03", 
        "source": "fcx", 
        "user_id": "bc880de0722e4c78b2cb5afd9838ad11"
    }, 
    {
        "links": [
            {
                "https://telemetry.jp-east-1.cloud.global.fujitsu.com/v2/resources/d4415484-a4c1-4f05-a910-e55cba5e4984", 
                "rel": "self"
            }
        ], 
        "project_id": "7c4f776d782049108a6255aaff940629", 
        "resource_id": "d4415484-a4c1-4f05-a910-e55cba5e4984", 
        "source": "fcx", 
        "user_id": "bc880de0722e4c78b2cb5afd9838ad11"
    }
]