移動

• リクエスト
• レスポンス
• 例

ノードの使用状況関連のメトリックの取得

get

/console/admin/api/v1.1/dashboard/statistics/nodeRes

ノードの使用状況関連のメトリック(CPU、メモリー、ディスク使用量)を取得します。

リクエスト

サポートされるメディア・タイプ

• application/json

問合せパラメータ

• endTime(オプション): string
  'yyyyMMddhhmmss'形式の時間範囲の終了時間
• nodeID(オプション): string
  特定のピア、オーダラ、プロキシまたはコンソール自体のノードID
• startTime(オプション): string
  'yyyyMMddhhmmss'形式の時間範囲の開始時間

先頭に戻る

レスポンス

サポートされるメディア・タイプ

• application/json

200レスポンス

制約の結果の一連の使用状況レコードを含むレスポンス

本文()

ルート・スキーマ: schema

型: object

ソースの表示

• data(オプション): array data

{
    "type":"object",
    "properties":{
        "data":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/StatsNodeRes"
            }
        }
    }
}

ネストしたスキーマ: data

型: array

ソースの表示

• 配列: object StatsNodeRes

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/StatsNodeRes"
    }
}

ネストしたスキーマ: StatsNodeRes

型: object

ソースの表示

• nodeId(オプション): string
• nodeType(オプション): string
• resUsage(オプション): object resUsage

{
    "type":"object",
    "properties":{
        "nodeId":{
            "type":"string"
        },
        "nodeType":{
            "type":"string"
        },
        "resUsage":{
            "type":"object",
            "properties":{
                "startTime":{
                    "type":"string"
                },
                "endTime":{
                    "type":"string"
                },
                "cpu":{
                    "type":"number"
                },
                "memory":{
                    "type":"number"
                },
                "disk":{
                    "type":"number"
                }
            }
        }
    }
}

ネストしたスキーマ: resUsage

型: object

ソースの表示

• cpu(オプション): number
• disk(オプション): number
• endTime(オプション): string
• memory(オプション): number
• startTime(オプション): string

{
    "type":"object",
    "properties":{
        "startTime":{
            "type":"string"
        },
        "endTime":{
            "type":"string"
        },
        "cpu":{
            "type":"number"
        },
        "memory":{
            "type":"number"
        },
        "disk":{
            "type":"number"
        }
    }
}

400レスポンス

無効な引数

本文()

ルート・スキーマ: 400errorModels

型: object

ソースの表示

• key(オプション): string
• value(オプション): string

{
    "type":"object",
    "properties":{
        "key":{
            "type":"string"
        },
        "value":{
            "type":"string"
        }
    },
    "example":{
        "respMesg":"invalid argument"
    }
}

例:

{
    "respMesg":"invalid argument"
}

デフォルト・レスポンス

予期しないエラー

本文()

ルート・スキーマ: errorModel

型: object

ソースの表示

• code: integer(int32)
• message: string

{
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"integer",
            "format":"int32"
        },
        "message":{
            "type":"string"
        }
    }
}

先頭に戻る

例

このエンドポイントは、CPU、メモリー、ディスクの使用率などのノードの使用状況に関連するメトリックを取得するために使用され、コンソールに表示されるヘルス・メトリックを反映しています。結果は、指定した時間範囲内の指定したノードの一連の使用状況レコードを含むJSON本文です。nodeIDを指定しない場合、インスタンスのすべてのノードについてこの情報が返されます。時間範囲を指定した場合、返される使用状況の情報は、指定した時間範囲におけるすべての使用の平均値です。時間範囲を指定しない場合、最新の使用状況の情報に加えて1分の時間範囲が返されます。

次の例は、cURLを使用してRESTリソースに対するGETリクエストを送信し、ノードのメトリックを生成する方法を示しています。

curl -X GET -u username:password -k 
"http://<rest_server_url>:port/console/admin/api/v1.1/dashboard/statistics/nodeRes?nodeID=<nodeID>&startTime=<yyyymmddhhmmss>&endTime=yyyymmddhhmmss"

例:

curl -X GET -u [e-mail]:mypswd -k 
"http://server.oracle.com:10000/console/admin/api/v1.1/dashboard/statistics/nodeRes?nodeID=peer0-1&startTime=20190224000000&endTime=20190224050000"

レスポンス本文の例

JSON形式のレスポンス本文のコンテンツの例を次に示します。

{
  "data": [
    {
      "nodeId": "peer0-1",
      "nodeType": "peer",
      "resUsage": {
        "startTime": "Sun, 24 Feb 2019 00:00:00 GMT",
        "endTime": "Sun, 24 Feb 2019 05:00:00 GMT",
        "cpu": 2.8215833333333333,
        "memory": 0.34320972222222224,
        "disk": 0.065
      }
    }
  ]
}

先頭に戻る