移動先

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

インスタンスのヘルス・チェックの作成

post

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

ヘルス・チェックの手動開始

エラー修正やデバッグのために、このエンドポイントにPOSTリクエストを行ってヘルス・チェックを手動で開始できます。

これにより、対象ノードにレセプタ・メッシュ経由で作業単位が送信され、完了するまで待機します。モデルが結果で更新されます。各フィールドの最新の値がレスポンス・データで返されます。

リクエスト

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

• application/json

パス・パラメータ

• id(必須): 文字列

本文()

ルート・スキーマ : 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"
}

先頭に戻る

レスポンス

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

• application/json

201レスポンス

本文()

ルート・スキーマ : 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"
}

先頭に戻る