コンテンツにスキップ

日次可用率の一括取得



POST /api/v1/slo/availability/list

概要

現在のワークスペース内のモニター型 SLO の日次可用率を一括取得します。秒単位のウィンドウ集計を付加できます。

呼び出し前の準備と使用手順

  1. SLO リストを呼び出してモニター型 SLO を絞り込み、結果内の content.data[].uuid を使用します。1 つの UUID が使用できない場合、リクエスト全体が失敗します。

  2. レポートの必要に応じて業務日と IANA タイムゾーンを選択します。開始日と終了日の両方が結果に含まれ、各日はその暦日の実際の秒数で計算されます。

  3. 特定の期間を照会する必要がある場合は、選択した日付範囲内にある window を入力します。ウィンドウ値と各日の points は個別に計算されます。日次サンプルがない場合、points の対応する値は空です。ウィンドウが成功したもののコストサンプルがない場合、value は 100、hasData は true、updatedAt は null です。

リクエストヘッダー

パラメータ名 型 必須 説明
DF-API-KEY string Y 現在のワークスペースの OpenAPI Key。
例: <DF-API-KEY>
取得または入力方法: 対象ワークスペースの API Key 管理から呼び出し用の認証情報を取得します。

Body リクエストパラメータ

パラメータ名 型 必須 説明
window object 開始を含み、終了を含みません。最長 604800 秒。
例: {"startTime": 1785427200, "endTime": 1785430800}
取得または入力方法: 秒単位の集計が本当に必要な場合に入力します。それ以外の場合はオブジェクト全体を省略します。
window.startTime integer 条件付き必須 startDate の暦日の開始より早くすることはできません。
例: 1785427200
取得または入力方法: 業務ウィンドウの開始時間を Unix 秒に変換します。
window.endTime integer 条件付き必須 開始より後である必要があり、サーバーの現在時刻より後になることはできず、endDate の暦日の終了を超えることもできません。
例: 1785430800
取得または入力方法: ウィンドウ終了時間を Unix 秒に変換します。
sloUUIDs array Y 最大 100 個の SLO UUID。結果は重複排除後のリクエスト順になります。
null を許可: False
例: ["monitor_example"]
取得または入力方法: SLO リスト応答の content.data[].uuid から取得し、モニター型を選択します。
startDate string Y 開始日を含みます。
null を許可: False
例: 2026-07-31
取得または入力方法: リクエストのタイムゾーンに従ってレポート開始日を指定します。形式は YYYY-MM-DD。
endDate string Y 終了日を含みます。日付範囲は最大 90 暦日です。
null を許可: False
例: 2026-07-31
取得または入力方法: 同じタイムゾーンに従ってレポート終了日を指定します。形式は YYYY-MM-DD。
timezone string Y 統計に使用する暦日の境界を決定します。
null を許可: False
例: Asia/Shanghai
取得または入力方法: 業務日が属する IANA タイムゾーンを入力します。ワークスペース詳細 の content.timezone から参考値を取得できます。
interval string 日次集計。デフォルトは 1d。
null を許可: False
選択可能な値: ['1d']
例: 1d
取得または入力方法: 1d を入力するか省略します。

パラメータ補足説明

結果には日次可用率とそのレベルが含まれ、正確な時間で集計することもできます。2 つの統計基準については呼び出し説明を参照してください。

リクエスト例

curl 'https://openapi.guance.com/api/v1/slo/availability/list' \
  -H 'DF-API-KEY: <DF-API-KEY>' \
  -H 'Content-Type: application/json' \
  --data-raw '{"sloUUIDs":["monitor_example"],"startDate":"2026-07-31","endDate":"2026-07-31","timezone":"Asia/Shanghai","window":{"startTime":1785427200,"endTime":1785430800}}'

応答

HTTP 200、application/json。

フィールド 型 説明
content.data array<object> 重複排除後のリクエスト順で返される SLO 統計。
content.data[].sloUUID string SLO UUID。
content.data[].name string SLO 名。
content.data[].status integer 0 は有効、2 は無効。
content.data[].goal number 目標可用率(パーセント)。
content.data[].minGoal number 最低可用率目標(パーセント)。
content.data[].tagInfo array<object> 関連タグ。関連付けがない場合は空の配列。
content.data[].tagInfo[].id integer タグレコード ID。
content.data[].tagInfo[].uuid string タグ識別子。
content.data[].tagInfo[].name string タグ名。タグクエリに使用します。
content.data[].tagInfo[].description string タグの説明。
content.data[].tagInfo[].colour string タグの色。
content.data[].tagInfo[].scope string タグの適用範囲。
content.data[].points array<object> 選択した業務日の日次結果(日付の早い順から遅い順)。
content.data[].points[].date string 業務日(YYYY-MM-DD)。
content.data[].points[].availability number または null 当日の可用率(パーセント)。小数点以下最大 6 桁まで保持します。サンプルがない場合は null。
content.data[].points[].level string goal に達した場合は normal、goal 未満だが minGoal に達した場合は warning、minGoal 未満は critical、データがない場合は unknown。
content.data[].points[].hasData boolean 当日に利用可能なサンプルがあるかどうか。
content.data[].window object リクエストに window が含まれる場合にのみ返されます。
content.data[].window.startTime integer 正確なウィンドウの開始時間(Unix 秒)。
content.data[].window.endTime integer 正確なウィンドウの終了時間(Unix 秒)。
content.data[].window.value number ウィンドウ可用率(パーセント)。小数点以下最大 6 桁まで保持します。
content.data[].window.hasData boolean 完全なクエリが成功した場合は true(コストサンプルがない場合を含む)。
content.data[].window.dataState string 完全なウィンドウのクエリが成功した場合は complete。
content.data[].window.updatedAt integer または null 最新の未修正コストサンプルの Unix 秒。そのようなサンプルがない場合は null で、修正データは引き続き可用率の計算に使用できます。
content.declaration object または null ワークスペースの宣言。
{
  "code": 200,
  "content": {
    "data": [
      {
        "sloUUID": "monitor_example",
        "name": "服务可用率",
        "status": 0,
        "goal": 99.9,
        "minGoal": 99.5,
        "tagInfo": [],
        "points": [
          {
            "date": "2026-07-31",
            "availability": null,
            "level": "unknown",
            "hasData": false
          }
        ],
        "window": {
          "startTime": 1785427200,
          "endTime": 1785430800,
          "value": 100,
          "hasData": true,
          "dataState": "complete",
          "updatedAt": null
        }
      }
    ],
    "declaration": null
  },
  "errorCode": "",
  "message": "",
  "success": true,
  "traceId": "TRACE-EXAMPLE"
}

エラー応答

認証、レート制限、共通リクエストエラーについては共通エラー定義を参照してください。

HTTP ステータス errorCode 発生条件 メッセージまたは応答の説明 対処方法
406 ft.ParameterValidationFailed フィールドの型、必須、制約がパラメータ表に適合しない リクエストフィールドの検証に失敗しました。メッセージにフィールドまたはルールが示されます。 フィールド、型、制約を確認してください。
400 ft.RequestJsonFormatError リクエスト JSON の構文が無効 リクエスト JSON の形式エラーです。 content 内の reason、line、column を確認して修正してください。
400 ft.JsonFormatError JSON 構文は有効だがトップレベルがオブジェクトではない JSON 形式エラーです。 パラメータを JSON オブジェクトに格納してください。
400 ft.ParamsValidateError SLO リスト、日付範囲、タイムゾーンのいずれかが無効 パラメータ検証に失敗しました。詳細には該当フィールドが含まれます。 UUID の数、日付が 90 日以内かどうか、IANA タイムゾーンを確認してください。
400 ft.SloMetricUnsupportedOperation メトリクス型 SLO が選択されている この操作はメトリクス型 SLO には適用されません。 モニター型 SLO に変更するか、メトリクス型 SLO の動作状態を確認してください。
400 ft.StatusPage.invalid_parameter 正確なウィンドウが日付、長さ、時間境界の条件を満たさない、またはウィンドウクエリの UUID が有効な識別子ではない invalid_parameter Unix 秒、日付境界、SLO UUID を確認してください。
404 ft.NotFoundSLO リクエスト内のいずれかの SLO が存在しない、削除済み、または現在のワークスペースに属していない 指定された SLO が見つかりません。 同じワークスペースで SLO リストを再取得してください。
403 ft.ForbiddenQuery 対象メトリクスをクエリする権限がない クエリ権限が不足しています。 API Key のメトリクスクエリ権限を確認してください。
503 ft.QueryServiceUnavailable クエリサービスが利用不可 クエリサービスは一時的に利用できません。 content.retryable に基づいて後で再試行するかどうかを決定してください。
500 ft.InternalServerError 正確なウィンドウで不完全なクエリ結果が読み取られた 内部エラーです。 後で再試行してください。調査のために応答の traceId を保持してください。

フィードバック

このページは役に立ちましたか?