목록¶
GET /api/v1/slo/list
개요¶
현재 워크스페이스의 SLO를 페이지 단위로 나열하며, 이름, UUID, 연결된 모니터 및 태그로 필터링할 수 있습니다.
호출 전 및 사용 단계¶
첫 페이지는 1부터 시작합니다. 결과는 레코드 ID 내림차순으로 반환됩니다. content.data[].uuid를 확보한 후 상세, 일일 가용률 또는 실행 상태를 조회합니다. 목록에는 모니터 유형과 메트릭 유형이 포함되며, config.sliType에 따라 후속 API를 선택합니다.
요청 헤더¶
| 파라미터명 | 유형 | 필수 | 설명 |
|---|---|---|---|
| DF-API-KEY | string | Y | 현재 워크스페이스의 OpenAPI Key입니다. 예: <DF-API-KEY>가져오기 또는 입력 방법: 대상 워크스페이스의 API Key 관리에서 호출 자격 증명을 가져옵니다. |
Query 요청 파라미터¶
| 파라미터명 | 유형 | 필수 | 설명 |
|---|---|---|---|
| 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 | 페이지당 항목 수이며 기본값은 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 | 수집 데이터에 사용되는 식별자이며, 이 API의 비즈니스 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 | 페이지당 항목 수입니다. |
| 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 | Query 필드가 선언되지 않음, 페이지 값이 제약을 벗어남 또는 tagMode가 허용 값에 없음 | 요청 필드 유효성 검사에 실패했습니다. | 필터 항목과 페이지 범위를 확인하고 pageIndex/pageSize에는 양의 정수를 사용합니다. |
| 500 | ft.InternalServerError | pageIndex 또는 pageSize를 소수 형식으로 전달하고 사전 범위 검사를 통과한 경우 | 내부 오류입니다. | 십진 정수 문자열을 사용합니다. |
| 404 | ft.NotFoundSLO | 일치하는 메트릭 유형 SLO에 연결된 수집기가 없음 | 지정된 SLO를 찾지 못했습니다. | 선택한 메트릭 유형 SLO의 수집 설정을 확인합니다. |