取得¶
GET /api/v1/slo/{slo_uuid}/get
概要¶
UUID を指定して、SLO の設定、関連付けられたモニター、アラートポリシーを取得します。
呼び出し前の準備と使用手順¶
まず SLO リスト を呼び出し、content.data[].uuid から SLO の識別子を選択します。リクエストには同一ワークスペースの API Key を使用します。日次可用率を照会する場合は、config.sliType が monitor であることを確認してください。
ルートパラメータ¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| slo_uuid | string | Y | 対象 SLO の UUID。 例: monitor_example取得または入力方法: SLO リストのレスポンスにある content.data[].uuid から取得します。 |
リクエストヘッダー¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| DF-API-KEY | string | Y | 現在のワークスペースの OpenAPI Key。 例: <DF-API-KEY>取得または入力方法: 対象ワークスペースの API Key 管理から呼び出し資格情報を取得します。 |
パラメータの補足説明¶
現在の API Key が属するワークスペース内で SLO を読み取ります。
リクエスト例¶
curl --get -H "DF-API-KEY: <DF-API-KEY>" \
'https://openapi.guance.com/api/v1/slo/monitor_example/get'
レスポンス¶
HTTP 200、application/json。
| フィールド | 型 | 説明 |
|---|---|---|
| content.uuid | string | SLO の UUID。SLO の読み取り、可用率および稼働状態の照会に使用します。 |
| content.workspaceUUID | string | 所属ワークスペース。 |
| content.name | string | SLO 名。 |
| content.id | integer | レコード ID。 |
| content.type | string | 固定値 slo。 |
| content.score | number | SLO レコードのスコアフィールド。 |
| content.status | integer | 0 は有効、2 は無効を表します。 |
| content.creator | string | 作成者の識別子。 |
| content.updator | string | 最終更新者の識別子。 |
| content.createAt | number | 作成時間、Unix 秒。 |
| content.updateAt | number | 最終更新時間、Unix 秒。 |
| content.deleteAt | number | 削除時間、未削除の場合は通常 -1。 |
| content.creatorInfo | object | 作成者情報。取得できない場合は {}。 |
| content.updatorInfo | object | 最終更新者情報。取得できない場合は {}。 |
| content.config | object | SLO 設定。 |
| content.config.sliType | string | monitor はモニター型、metric はメトリクス型を表します。旧レコードで未設定の場合は monitor として返されます。 |
| content.config.checkRange | integer | 集計期間、単位は秒。604800(7 日)と 2592000(30 日)をサポートし、未指定の場合は 604800 として返されます。 |
| content.config.goal | number | 目標可用率のパーセント。 |
| content.config.minGoal | number | 最低可用率目標のパーセント。 |
| content.config.describe | string | SLO の説明。 |
| content.config.interval | string | 検出頻度。例: 5m または 10m。 |
| content.config.groupBy | array<string> |
グループ化フィールド。 |
| content.config.ignoreBadGroupEvents | boolean | 異常なグループイベントを無視するかどうか。 |
| content.config.sli_infos | array<object> |
関連付けられたモニターのリスト。関連付けがない場合は空です。 |
| content.config.sli_infos[].id | string | 関連付けられたモニターの UUID。 |
| content.config.sli_infos[].name | string | 関連付けられたモニターの名前。 |
| content.config.sli_infos[].status | integer | 関連付けられたモニターのステータス。 |
| content.config.metricQueries | object | メトリクス型のみ。total と good はそれぞれ総量と成功量のクエリ設定です。キーの下に dql、queryType、editor を含み、PromQL の場合は promqlType も含むことがあります。 |
| content.metricQueryInfo | object | メトリクス型のみ。収集データの選択に使用します。 |
| content.metricQueryInfo.measurement | string | 固定値 slo_metric。 |
| content.metricQueryInfo.sloId | string | 収集データに使用する識別子。本インターフェースのビジネス UUID とは用途が異なります。 |
| content.metricQueryInfo.validAfter | integer または null | 計算の有効開始時間、Unix ミリ秒。 |
| content.metricQueryInfo.stoppedAt | integer または null | 収集停止時間、Unix ミリ秒。 |
| content.tagInfo | array<object> |
関連付けられたタグ。関連付けがない場合は空の配列です。 |
| content.tagInfo[].id | integer | タグのレコード ID。 |
| content.tagInfo[].uuid | string | タグの識別子。 |
| content.tagInfo[].name | string | タグ名。タグの照会に使用します。 |
| content.tagInfo[].description | string | タグの説明。 |
| content.tagInfo[].colour | string | タグの色。 |
| content.tagInfo[].scope | string | タグの適用範囲。 |
| content.alertPolicyInfos | array<object> |
関連付けられたアラートポリシー。関連付けがない場合は空の配列です。 |
| content.alertPolicyInfos[].uuid | string | アラートポリシーの UUID。 |
| content.alertPolicyInfos[].name | string | アラートポリシー名。 |
| content.declaration | object または null | ワークスペース宣言。 |
{
"code": 200,
"content": {
"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": {},
"declaration": null,
"creator": "wsak_example",
"updator": "wsak_example",
"createAt": 1785427200,
"updateAt": 1785430800,
"deleteAt": -1
},
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE"
}
エラーレスポンス¶
認証、レート制限、共通リクエストエラーについては共通エラー定義 を参照してください。
| HTTP ステータス | errorCode | 発生条件 | メッセージまたはレスポンスの説明 | 対処方法 |
|---|---|---|---|---|
| 404 | ft.NotFoundSLO | SLO が存在しない、削除済み、現在のワークスペースに属していない、またはメトリクス型の設定に関連するコレクターがない | 指定された SLO が見つかりません。 | 現在のワークスペースの SLO リストから実際の UUID を取得し、モニター設定が有効であることを確認してください。 |