移動先

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

ヘルス・チェック・データ

get

/api/v2/instances/{id}/health_check/

ヘルス・チェックは、インスタンスに関する重要データを取得するために使用されます。ヘルス・チェックによる影響を受けるインスタンス・フィールドは、このビューに表示されます。基本的に、ヘルス・チェックは問題となるマシンでコードを実行する必要があります。

• node_typeが"control"または"hybrid"の場合、ヘルス・チェックはバックグラウンドで実行される定期タスクとして実行されます。
• node_typeが"execution"の場合、ヘルス・チェックはレセプタ・メッシュを通じて作業単位を送信することで実施されます。

レセプタ・メッシュ経由で実行される場合、呼び出されるコマンドは次のとおりです:

ansible-runner worker --worker-info

実行ノードの場合、これらのチェックは定期的に行われません。機能ノードに対するヘルス・チェックは、ノードが最初に発見されたときに実行されます。エラーのあるノードに対するヘルス・チェックは、頻度を減らして繰り返し実行されます。

リクエスト

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

• application/json

パス・パラメータ

• id(必須): 文字列

問合せパラメータ

• page: 整数
  ページ区切りが設定された結果セット内のページ番号。
• page_size: 整数
  ページごとに返す結果の数。
• search: 文字列
  検索条件。

先頭に戻る

レスポンス

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

• application/json

200レスポンス

本文()

ルート・スキーマ: schema

型: object

ソースを表示

• count(必須): 整数
• next: 文字列(uri)
• previous: 文字列(uri)
• results(必須): 配列 results

{
    "properties":{
        "count":{
            "type":"integer"
        },
        "next":{
            "format":"uri",
            "type":"string",
            "x-nullable":true
        },
        "previous":{
            "format":"uri",
            "type":"string",
            "x-nullable":true
        },
        "results":{
            "items":{
                "$ref":"#/definitions/InstanceHealthCheck"
            },
            "type":"array"
        }
    },
    "required":[
        "count",
        "results"
    ],
    "type":"object"
}

ネストされたスキーマ : results

型: array

ソースを表示

• 配列: オブジェクト InstanceHealthCheck

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

ネストされたスキーマ : InstanceHealthCheck

型: object

ソースを表示

• capacity: 整数
  タイトル: Capacity

  読取り専用: true
• cpu: 文字列(10進)
  タイトル: Cpu

  読取り専用: true
• cpu_capacity: 整数
  タイトル: Cpu capacity

  読取り専用: true
• errors: 文字列
  タイトル: Errors

  読取り専用: true

  最小長: 1

  最後のヘルス・チェックからのエラーの詳細。
• hostname: 文字列
  タイトル: Hostname

  読取り専用: true

  最小長: 1
• ip_address: 文字列
  タイトル: Ip address

  読取り専用: true

  最小長: 1
• last_health_check: 文字列(日付-時間)
  タイトル: Last health check

  読取り専用: true

  CPU、メモリー、容量のリフレッシュのために、このインスタンスで最後にヘルス・チェックが実行されたとき。
• mem_capacity: 整数
  タイトル: Mem capacity

  読取り専用: true
• memory: 整数
  タイトル: Memory

  読取り専用: true

  このインスタンスの合計システム・メモリー(バイト単位)。
• uuid: 文字列
  タイトル: Uuid

  読取り専用: true

  最小長: 1
• version: 文字列
  タイトル: Version

  読取り専用: true

  最小長: 1

{
    "properties":{
        "capacity":{
            "readOnly":true,
            "title":"Capacity",
            "type":"integer"
        },
        "cpu":{
            "format":"decimal",
            "readOnly":true,
            "title":"Cpu",
            "type":"string"
        },
        "cpu_capacity":{
            "readOnly":true,
            "title":"Cpu capacity",
            "type":"integer"
        },
        "errors":{
            "description":"Any error details from the last health check.",
            "minLength":"1",
            "readOnly":true,
            "title":"Errors",
            "type":"string"
        },
        "hostname":{
            "minLength":"1",
            "readOnly":true,
            "title":"Hostname",
            "type":"string",
            "x-nullable":true
        },
        "ip_address":{
            "minLength":"1",
            "readOnly":true,
            "title":"Ip address",
            "type":"string",
            "x-nullable":true
        },
        "last_health_check":{
            "description":"Last time a health check was ran on this instance to refresh cpu, memory, and capacity.",
            "format":"date-time",
            "readOnly":true,
            "title":"Last health check",
            "type":"string",
            "x-nullable":true
        },
        "mem_capacity":{
            "readOnly":true,
            "title":"Mem capacity",
            "type":"integer"
        },
        "memory":{
            "description":"Total system memory of this instance in bytes.",
            "readOnly":true,
            "title":"Memory",
            "type":"integer"
        },
        "uuid":{
            "minLength":"1",
            "readOnly":true,
            "title":"Uuid",
            "type":"string",
            "x-nullable":true
        },
        "version":{
            "minLength":"1",
            "readOnly":true,
            "title":"Version",
            "type":"string",
            "x-nullable":true
        }
    },
    "type":"object"
}

先頭に戻る