移動

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

ノードのヘルス・ステータスの取得

get

/console/admin/api/v2/dashboard/statistics/nodeHealth

特定のピア、オーダラ、プロキシまたはコンソール自体のノード・ヘルス・ステータス(稼働中または停止中)を取得します。

リクエスト

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

• application/json

問合せパラメータ

• nodeID: string
  特定のピア、オーダラ、プロキシまたはコンソール自体のノードID

先頭に戻る

レスポンス

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

• application/json

200レスポンス

制約の結果の一連の稼働中/停止中ステータスを含むレスポンス

本文()

ルート・スキーマ: schema

型: object

ソースの表示

• data: array data

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

ネストしたスキーマ: data

型: array

ソースの表示

• 配列: object StatsNodeHealth

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

ネストしたスキーマ: StatsNodeHealth

型: object

ソースの表示

• health: object health
• nodeId: string
• nodeType: string

{
    "type":"object",
    "properties":{
        "nodeId":{
            "type":"string"
        },
        "nodeType":{
            "type":"string"
        },
        "health":{
            "type":"object",
            "properties":{
                "time":{
                    "type":"string"
                },
                "status":{
                    "type":"string"
                }
            }
        }
    }
}

ネストしたスキーマ: health

型: object

ソースの表示

• status: string
• time: string

{
    "type":"object",
    "properties":{
        "time":{
            "type":"string"
        },
        "status":{
            "type":"string"
        }
    }
}

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"
        }
    }
}

先頭に戻る

例

このエンドポイントは、指定したノードのヘルス・ステータス(稼働中または停止中)を取得するために使用されます。結果は、指定したノードの一連の稼働中/停止中ステータスを含むJSON本文です。nodeIDを指定しない場合、すべてのノードのヘルスが返されます。時間範囲はnodeHealthではサポートされていません。

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

curl -X GET -u username:password -k 
"http://<rest_server_url>:port/console/admin/api/v2/dashboard/statistics/nodeHealth?nodeID=<nodeID>"

たとえば、

curl -X GET -u [e-mail]:mypswd -k 
"http://server.oracle.com:10000/console/admin/api/v2/dashboard/statistics/nodeHealth?nodeID=console"

レスポンス本文の例

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

{
  "data": [
    {
      "nodeId": "console",
      "nodeType": "console",
      "health": {
        "time": "Sun, 24 Feb 2021 06:41:48 GMT",
        "status": "up"
      }
    }
  ]
}

先頭に戻る