一覧取得¶
GET /api/v1/slo/list
概要¶
現在のワークスペースの SLO をページングで一覧取得します。名前、UUID、関連付けられたモニター、タグでフィルタできます。
呼び出し前の準備と使用手順¶
最初のページは 1 から始まります。結果はレコード ID の降順で返されます。content.data[].uuid を取得した後、詳細、日次可用率、または稼働状態を照会します。一覧にはモニター型とメトリクス型が含まれます。config.sliType に応じて後続のインターフェースを選択してください。
リクエストヘッダー¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| DF-API-KEY | string | Y | 現在のワークスペースの OpenAPI Key。 例: <DF-API-KEY>取得または入力方法: 対象ワークスペースの API Key 管理から呼び出し資格情報を取得します。 |
クエリリクエストパラメータ¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| refSli | string | このモニターが関連付けられた SLO を返します。 null 許容: True 例: rul_example取得または入力方法: モニター一覧のレスポンスの content.data[].uuid、または SLO 詳細の content.config.sli_infos[].id からモニター UUID を取得します。 |
|
| search | string | 名前または UUID の部分一致で検索します。 null 許容: True 例: 結账取得または入力方法: ワークスペース内で既知の SLO 名または UUID を使用します。一部のみを指定することもできます。 |
|
| tags | string | タグ名でフィルタします。 null 許容: True 例: team:checkout取得または入力方法: SLO のタグまたは詳細の content.tagInfo[].name からタグ名を取得し、半角カンマで連結します。 |
|
| tagMode | string | 複数タグのマッチ方式。デフォルトは and。 null 許容: False 選択可能な値: ['and', 'or'] 例: and取得または入力方法: 必要に応じて、すべて一致する and またはいずれかが一致する or を選択します。 |
|
| pageIndex | integer | 現在のページ。デフォルトは 1、最小値は 1。 null 許容: False $minValue: 1 例: 1取得または入力方法: 1 から始めてページごとに増やします。 |
|
| pageSize | integer | 1 ページあたりの件数。デフォルトは 100、1 から 10000 まで指定できます。 null 許容: False $minValue: 1 $maxValue: 10000 例: 100取得または入力方法: 必要な結果件数に応じて正の整数を設定します。 |
パラメータ補足説明¶
現在の API Key が属するワークスペース内で SLO を読み取ります。
リクエスト例¶
curl --get -H "DF-API-KEY: <DF-API-KEY>" \
'https://openapi.guance.com/api/v1/slo/list' \
--data-urlencode "search=服务" \
--data-urlencode "pageIndex=1" \
--data-urlencode "pageSize=100"
レスポンス¶
HTTP 200、application/json。
| フィールド | 型 | 説明 |
|---|---|---|
| content.data | array<object> |
SLO 一覧。レコードがない場合は空配列です。 |
| content.data[].uuid | string | SLO UUID。SLO の読み取り、可用率、稼働状態の照会に使用します。 |
| content.data[].workspaceUUID | string | 所属ワークスペース。 |
| content.data[].name | string | SLO 名。 |
| content.data[].id | integer | レコード ID。 |
| content.data[].type | string | 固定値は slo。 |
| content.data[].score | number | SLO レコードのスコアフィールド。 |
| content.data[].status | integer | 0 は有効、2 は無効を表します。 |
| content.data[].creator | string | 作成者の識別子。 |
| content.data[].updator | string | 最終更新者の識別子。 |
| content.data[].createAt | number | 作成日時(Unix 秒)。 |
| content.data[].updateAt | number | 最終更新日時(Unix 秒)。 |
| content.data[].deleteAt | number | 削除日時。未削除の場合は通常 -1 です。 |
| content.data[].creatorInfo | object | 作成者情報。取得できない場合は {} です。 |
| content.data[].updatorInfo | object | 最終更新者情報。取得できない場合は {} です。 |
| content.data[].config | object | SLO 設定。 |
| content.data[].config.sliType | string | monitor はモニター型、metric はメトリクス型を表します。旧レコードで未設定の場合は monitor として返されます。 |
| content.data[].config.checkRange | integer | 集計期間。単位は秒です。604800(7 日)と 2592000(30 日)をサポートし、省略時は 604800 として返されます。 |
| content.data[].config.goal | number | 目標可用率のパーセント。 |
| content.data[].config.minGoal | number | 最低可用率目標のパーセント。 |
| content.data[].config.describe | string | SLO の説明。 |
| content.data[].config.interval | string | 検出頻度。例: 5m または 10m。 |
| content.data[].config.groupBy | array<string> |
グループ化フィールド。 |
| content.data[].config.ignoreBadGroupEvents | boolean | 異常なグループイベントを無視するかどうか。 |
| content.data[].config.sli_infos | array<object> |
関連付けられたモニターの一覧。未関連付けの場合は空です。 |
| content.data[].config.sli_infos[].id | string | 関連付けられたモニター UUID。 |
| content.data[].config.sli_infos[].name | string | 関連付けられたモニター名。 |
| content.data[].config.sli_infos[].status | integer | 関連付けられたモニターのステータス。 |
| content.data[].config.metricQueries | object | メトリクス型のみ。total と good はそれぞれ総量と成功量のクエリ設定です。キーの下には dql、queryType、editor が含まれ、PromQL の場合はさらに promqlType を含めることができます。 |
| content.data[].metricQueryInfo | object | メトリクス型のみ。収集データの選択に使用します。 |
| content.data[].metricQueryInfo.measurement | string | 固定値は slo_metric。 |
| content.data[].metricQueryInfo.sloId | string | 収集データに使用する識別子。本インターフェースの業務用 UUID とは用途が異なります。 |
| content.data[].metricQueryInfo.validAfter | integer または null | 計算の有効開始時刻(Unix ミリ秒)。 |
| content.data[].metricQueryInfo.stoppedAt | integer または null | 収集停止時刻(Unix ミリ秒)。 |
| 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[].alertPolicyInfos | array<object> |
関連付けられたアラートポリシー。未関連付けの場合は空配列です。 |
| content.data[].alertPolicyInfos[].uuid | string | アラートポリシー UUID。 |
| content.data[].alertPolicyInfos[].name | string | アラートポリシー名。 |
| pageInfo | object | ページングオブジェクト。レスポンスの最上位に配置されます。 |
| pageInfo.pageIndex | integer | 現在のページ番号。 |
| pageInfo.pageSize | integer | 1 ページあたりの件数。 |
| pageInfo.count | integer | 現在のページの件数。 |
| pageInfo.totalCount | integer | 一致した総件数。 |
| content.declaration | object または null | ワークスペース宣言。 |
{
"code": 200,
"content": {
"data": [
{
"id": 1,
"uuid": "monitor_example",
"workspaceUUID": "wksp_example",
"name": "服务可用率",
"type": "slo",
"score": 0,
"status": 0,
"config": {
"sliType": "monitor",
"checkRange": 604800,
"goal": 99.9,
"minGoal": 99.5,
"describe": "结账服务",
"interval": "5m",
"sli_infos": [
{
"id": "rul_example",
"name": "结账检查",
"status": 0
}
]
},
"tagInfo": [],
"alertPolicyInfos": [],
"creatorInfo": {},
"updatorInfo": {},
"creator": "wsak_example",
"updator": "wsak_example",
"createAt": 1785427200,
"updateAt": 1785430800,
"deleteAt": -1
}
],
"declaration": null
},
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE",
"pageInfo": {
"pageIndex": 1,
"pageSize": 100,
"count": 1,
"totalCount": 1
}
}
エラー応答¶
認証、レート制限、および共通リクエストエラーについては共通エラー定義を参照してください。
| HTTP ステータス | errorCode | 発生条件 | メッセージまたは応答の説明 | 対処方法 |
|---|---|---|---|---|
| 406 | ft.ParameterValidationFailed | クエリフィールドが宣言されていない、ページング値が制約を超えている、または tagMode が許可値に含まれていない | リクエストフィールドの検証に失敗しました。 | フィルタ条件とページング範囲を確認し、pageIndex/pageSize には正の整数を使用してください。 |
| 500 | ft.InternalServerError | pageIndex または pageSize を小数形式で渡し、事前の範囲検証を通過した | 内部エラー。 | 10 進整数の文字列を使用してください。 |
| 404 | ft.NotFoundSLO | 一致したメトリクス型 SLO に関連付けられたコレクターがない | 指定された SLO が見つかりません。 | 選択したメトリクス型 SLO の収集設定を確認してください。 |