移動先

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

ブラックアウトの統計

get

https://EM_HOST:EM_CONSOLE_HTTPS_PORT/em/api/blackouts/dashboard

このAPIは、ブラックアウトに関する統計を返します

リクエスト

この操作にはリクエスト・パラメータはありません。

この操作にはリクエスト本文はありません。

先頭に戻る

レスポンス

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

• application/json

200レスポンス

OK

本文()

ルート・スキーマ: BlackoutDashboard

型: object

ブラックアウトに関する様々な統計。

ソースの表示

• totalActiveBlackouts: integer
  アクティブなブラックアウトの合計数。

  例: 12
• totalFailedBlackouts: integer
  失敗したブラックアウトの合計数。

  例: 23
• totalFutureBlackouts: integer
  将来予定されているブラックアウトの合計数。

  例: 15
• totalTargetsInActiveBlackout: integer
  アクティブなブラックアウトに含まれているターゲットの合計数。

  例: 40
• totalTargetsInBlackout: integer
  アクティブなブラックアウトまたはスケジュールされているブラックアウトのメンバーであるターゲットの合計数。

  例: 75

{
    "x-em-sdk-level":"emSDK",
    "description":"Various statistics about blackouts.",
    "type":"object",
    "properties":{
        "totalTargetsInActiveBlackout":{
            "type":"integer",
            "description":"Total number of targets which are in an active blackout.",
            "example":"40"
        },
        "totalTargetsInBlackout":{
            "type":"integer",
            "description":"Total number of targets which are member of an active or scheduled blackout.",
            "example":"75"
        },
        "totalActiveBlackouts":{
            "type":"integer",
            "description":"Total number of active blackouts.",
            "example":"12"
        },
        "totalFailedBlackouts":{
            "type":"integer",
            "description":"Total number of failed blackouts.",
            "example":"23"
        },
        "totalFutureBlackouts":{
            "type":"integer",
            "description":"Total number of blackouts scheduled for future.",
            "example":"15"
        }
    }
}

401レスポンス

クライアントが認証されていません

本文()

ルート・スキーマ: ErrorResponse

型: object

エラー・レスポンス

ソースの表示

• code(必須): string
  プログラムによる解析を目的とした、エラーを定義する短いエラー・コード。
• message(必須): string
  判読可能なエラー文字列

{
    "description":"Error response",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string",
            "type":"string"
        }
    }
}

500レスポンス

リクエスト処理中の内部エラー

本文()

ルート・スキーマ: ErrorResponse

型: object

エラー・レスポンス

ソースの表示

• code(必須): string
  プログラムによる解析を目的とした、エラーを定義する短いエラー・コード。
• message(必須): string
  判読可能なエラー文字列

{
    "description":"Error response",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string",
            "type":"string"
        }
    }
}

503レスポンス

必要なサービスが使用不可であることを示しています。

本文()

ルート・スキーマ: ErrorResponse

型: object

エラー・レスポンス

ソースの表示

• code(必須): string
  プログラムによる解析を目的とした、エラーを定義する短いエラー・コード。
• message(必須): string
  判読可能なエラー文字列

{
    "description":"Error response",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string",
            "type":"string"
        }
    }
}

先頭に戻る