목록 조회¶
GET /api/v1/error_track_rule/list
개요¶
오류 추적 규칙을 페이지 단위로 나열합니다.
호출 전 및 사용 단계¶
현재 Key에는 errorCenter.errorTrackRuleQuery 권한이 필요하며, 현재 워크스페이스의 삭제되지 않은 규칙만 포함하고 비활성화 상태 2도 포함합니다. id 내림차순으로 페이지네이션되며, 이름 search 및 type을 조합할 수 있습니다. 목록 data 항목에는 creatorInfo/updatorInfo가 포함됩니다.
RUM 소스에만 sourcesInfo가 포함되며, *는 {name:*} 요약을 반환하고 알 수 없는 appId는 {}를 반환합니다. 요약 조회에는 삭제된 RUM 애플리케이션이 포함될 수 있으므로, 먼저 활성 애플리케이션 간략 목록으로 실제 연결 여부를 확인해야 합니다. 다른 유형에는 sourcesInfo가 없습니다. 규칙은 Studio에 저장된 구성만 나타내며, 오류 레코드가 이미 생성되었거나 과거 추적 재계산이 완료되었거나 다운스트림에서 즉시 적용되었음을 보장하지 않습니다. content.declaration은 상위 공통 선언이며, 목록의 pageInfo는 최상위에 있고 data는 content.data를 유지합니다.
요청 헤더¶
| 파라미터 이름 | 유형 | 필수 | 설명 |
|---|---|---|---|
| DF-API-KEY | string | Y | 워크스페이스의 OpenAPI 인증 자격 증명입니다. 예시: <DF-API-KEY>가져오기 또는 입력 방법: 대상 워크스페이스의 API Key 관리에서 해당 작업 권한이 있는 OpenAPI Key를 가져옵니다. |
Query 요청 파라미터¶
| 파라미터 이름 | 유형 | 필수 | 설명 |
|---|---|---|---|
| pageIndex | integer | 선택적 양의 정수이며, 생략 시 1이고 최소값은 1입니다. null 허용: False $minValue: 1 예시: 1가져오기 또는 입력 방법: 호출자의 페이지네이션 제어입니다. |
|
| pageSize | integer | 선택적 정수 1–100이며, 생략 시 20입니다. 이전 예시 10은 기본값이 아닙니다. null 허용: False $maxValue: 100 $minValue: 1 예시: 20가져오기 또는 입력 방법: 호출자의 페이지네이션 제어입니다. |
|
| search | string | 선택적 이름 부분 일치이며, 앞뒤 공백을 제거하고 생략 또는 공백이면 필터링하지 않습니다. SQL LIKE 의미론이며 %와 _는 와일드카드 의미를 가지며 리터럴 부분 문자열 이스케이프를 보장하지 않습니다. null 허용: True 예시: 支付가져오기 또는 입력 방법: 호출자가 규칙 이름으로 조회합니다. |
|
| type | string | 선택적 logging/tracing/rum이며, 생략 시 필터링하지 않습니다. 빈 문자열은 공개 열거형에 포함되지 않습니다. null 허용: False 선택 가능한 값: ['logging', 'tracing', 'rum'] 예시: rum가져오기 또는 입력 방법: 규칙 소스 유형별로 필터링합니다. |
요청 예시¶
curl --get 'https://openapi.guance.com/api/v1/error_track_rule/list' \
-H 'DF-API-KEY: <DF-API-KEY>' \
--data-urlencode pageIndex=1 \
--data-urlencode pageSize=20 \
--data-urlencode type=rum
응답¶
HTTP 200, application/json. 아래 예시는 바로 읽을 수 있는 주요 필드를 보여줍니다.
| 필드 | 유형 | 설명 |
|---|---|---|
| content | object | 규칙 페이지 내용 객체입니다. |
| content.data | array<object> |
이 페이지의 활성/비활성 규칙이며, 일치하는 항목이 없으면 []입니다. |
| content.data[].id | integer 또는 null | 데이터베이스 행 ID이며 경로 위치 지정에 사용되지 않습니다. 제출 전 스냅샷은 null일 수 있습니다. |
| content.data[].uuid | string | 오류 추적 규칙 UUID이며 issetrule_ 접두사가 붙습니다. 오류 처리 메타데이터 isset_ 또는 텔레메트리 issue_id가 아닙니다. |
| content.data[].status | integer | 데이터베이스 상태: 0 활성, 2 비활성, 3 소프트 삭제(읽기 시 3 제외). |
| content.data[].creator | string | 생성 주체 UUID입니다. 이 공개 진입점에서 생성 주체는 일반적으로 Key 리소스 wsak_입니다. 과거 기록은 다른 주체일 수 있으며 sys 메타데이터를 자동으로 초기화하지 않습니다. |
| content.data[].updator | string | 최근 업데이트 주체이며, 업데이트되지 않은 경우 비어 있을 수 있습니다. |
| content.data[].createAt | integer | Unix 초 단위 생성 시간입니다. |
| content.data[].updateAt | integer | Unix 초 단위 업데이트 시간이며, 생성 후 업데이트되지 않은 경우 일반적으로 -1입니다. |
| content.data[].deleteAt | integer | Unix 초 단위 삭제 시간이며, 삭제되지 않은 경우 일반적으로 -1입니다. |
| content.data[].workspaceUUID | string | 현재 Key가 속한 워크스페이스입니다. |
| content.data[].name | string | 규칙 이름이며 동일한 이름을 사용할 수 있습니다. |
| content.data[].desc | string | 규칙 설명입니다. |
| content.data[].type | string | logging/tracing/rum. |
| content.data[].sources | array | 저장된 소스 배열이며, 클라이언트는 문자열만 사용해야 합니다. 과거의 비문자열 값은 내결함성 있게 처리해야 합니다. |
| content.data[].sources[] | JSON | 일반적으로 인덱스 이름/appId/서비스 이름 또는 *입니다. 역할 또는 계정 ID가 아닙니다. |
| content.data[].extend | object 또는 null | 저장 확장이며, 일반적으로 객체로 기록됩니다. 과거 값은 내결함성 있게 처리해야 합니다. |
| content.data[].extend.사용자 지정 키 | JSON | 사용자 지정 저장 값이며 고정된 실행 의미론은 없습니다. |
| content.data[].sourcesInfo | array<object> |
RUM 규칙 list/get에만 첨부되며 sources와 동일한 순서입니다. 해석할 수 없는 항목은 {}이며, 애플리케이션이 여전히 활성 상태임을 보장하지 않습니다. |
| content.data[].sourcesInfo[].appId | string | 실제 애플리케이션 appId이며, 와일드카드 항목은 *입니다. |
| content.data[].sourcesInfo[].jsonContent | object | 원본 RUM 애플리케이션 jsonContent입니다. 조회 시 삭제된 애플리케이션을 제외하지 않으므로 요약만으로 여전히 활성 상태라고 판단해서는 안 됩니다. |
| content.data[].sourcesInfo[].jsonContent.name | string | 애플리케이션 표시 이름이며, 와일드카드 항목은 *입니다. |
| content.data[].sourcesInfo[].jsonContent.type | string | 애플리케이션 플랫폼이며, 와일드카드 항목에는 일반적으로 없습니다. |
| content.data[].sourcesInfo[].jsonContent.extend | object | 선택적 애플리케이션 동적 확장입니다. |
| content.data[].sourcesInfo[].jsonContent.extend.사용자 지정 키 | JSON | 애플리케이션에 저장된 확장 값입니다. |
| content.data[].creatorInfo | object | 목록에만 첨부되는 주체 요약이며, 일치하는 항목이 없으면 {}입니다. 시스템 주체 필드는 계정보다 적을 수 있습니다. |
| content.data[].creatorInfo.uuid | string | 주체 UUID이며 계정, Key 또는 시스템 식별자일 수 있습니다. |
| content.data[].creatorInfo.status | integer | 주체 상태입니다. |
| content.data[].creatorInfo.wsAccountStatus | integer | 현재 워크스페이스 구성원 관계 상태 요약입니다. |
| content.data[].creatorInfo.username | string | 로그인 이름 또는 Key 이름입니다. |
| content.data[].creatorInfo.name | string | 표시 이름입니다. |
| content.data[].creatorInfo.iconUrl | string | 아바타 URL이며 비어 있을 수 있습니다. |
| content.data[].creatorInfo.email | string | 이메일이며, Key 주체의 경우 자체 UUID일 수 있고 전달 가능성을 보장하지 않습니다. |
| content.data[].creatorInfo.mobile | string | 휴대폰 번호이며 비어 있을 수 있습니다. |
| content.data[].creatorInfo.countryCode | string | 전화 국가 코드이며 비어 있을 수 있습니다. |
| content.data[].creatorInfo.acntWsNickname | string | 현재 워크스페이스 닉네임이며 비어 있을 수 있습니다. |
| content.data[].updatorInfo | object | 목록에만 첨부되는 주체 요약이며, 일치하는 항목이 없으면 {}입니다. 시스템 주체 필드는 계정보다 적을 수 있습니다. |
| content.data[].updatorInfo.uuid | string | 주체 UUID이며 계정, Key 또는 시스템 식별자일 수 있습니다. |
| content.data[].updatorInfo.status | integer | 주체 상태입니다. |
| content.data[].updatorInfo.wsAccountStatus | integer | 현재 워크스페이스 구성원 관계 상태 요약입니다. |
| content.data[].updatorInfo.username | string | 로그인 이름 또는 Key 이름입니다. |
| content.data[].updatorInfo.name | string | 표시 이름입니다. |
| content.data[].updatorInfo.iconUrl | string | 아바타 URL이며 비어 있을 수 있습니다. |
| content.data[].updatorInfo.email | string | 이메일이며, Key 주체의 경우 자체 UUID일 수 있고 전달 가능성을 보장하지 않습니다. |
| content.data[].updatorInfo.mobile | string | 휴대폰 번호이며 비어 있을 수 있습니다. |
| content.data[].updatorInfo.countryCode | string | 전화 국가 코드이며 비어 있을 수 있습니다. |
| content.data[].updatorInfo.acntWsNickname | string | 현재 워크스페이스 닉네임이며 비어 있을 수 있습니다. |
| pageInfo | object | 페이지 메타 정보이며, OpenAPI에서는 최상위에 있습니다. content는 객체를 유지합니다. |
| pageInfo.count | integer | 이 페이지의 실제 항목 수입니다. |
| pageInfo.totalCount | integer | 필터를 충족하는 후보/로컬 레코드 총수입니다. 텔레메트리 목록은 10000개 후보 상한의 영향을 받습니다. |
| pageInfo.pageIndex | integer | 페이지 번호이며 1부터 시작합니다. |
| pageInfo.pageSize | integer | 이번 요청의 페이지당 요청 수입니다. |
| content.declaration | object 또는 null | 현재 워크스페이스의 공통 선언이며, content 상위 객체에만 추가되고 data 항목에 재귀적으로 추가되지 않습니다. |
{
"code": 200,
"content": {
"data": [
{
"id": 7,
"uuid": "issetrule_example",
"status": 0,
"creator": "wsak_example",
"updator": "",
"createAt": 1785427200,
"updateAt": -1,
"deleteAt": -1,
"workspaceUUID": "wksp_example",
"name": "支付Web错误聚合",
"desc": "跟踪支付Web应用错误",
"type": "rum",
"sources": [
"payment_web"
],
"extend": {
"ownerTeam": "payment"
},
"sourcesInfo": [
{
"appId": "payment_web",
"jsonContent": {
"name": "支付Web",
"type": "web"
}
}
],
"creatorInfo": {},
"updatorInfo": {}
}
],
"declaration": {}
},
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE",
"pageInfo": {
"count": 1,
"totalCount": 1,
"pageIndex": 1,
"pageSize": 20
}
}
오류 응답¶
인증, 속도 제한 및 공통 요청 오류는 공통 오류 정의를 참조하세요.
| HTTP 상태 | errorCode | 발생 조건 | 메시지 또는 응답 설명 | 처리 방법 |
|---|---|---|---|---|
| 406 | ft.ParameterValidationFailed | 선언되지 않은 Query 파라미터를 사용하거나 파라미터가 규칙을 위반함 | 파라미터 파싱 실패 | Query 파라미터 표 및 예시를 확인합니다. |
| 500 | ft.InternalServerError | 데이터베이스 읽기, 과거 JSON 구조 또는 연관 요약 구성 중 처리되지 않은 예외 발생 | 내부 오류 | traceId를 보존하고 백오프합니다. 계속 실패하면 관리자에게 관련 과거 기록과 구성을 확인하도록 요청합니다. |