조회¶
GET /api/v1/error_track_rule/{rule_uuid}/get
개요¶
단일 오류 추적 규칙 설정을 조회합니다.
호출 전 및 사용 단계¶
현재 Key에는 errorCenter.errorTrackRuleQuery 권한이 필요하며, 현재 워크스페이스의 삭제되지 않은 규칙만 대상으로 하고 비활성화 상태 2도 포함합니다. 목록의 uuid를 사용해 대상을 지정합니다. 알 수 없거나 다른 워크스페이스에 속하거나 이미 삭제된 경우 404를 반환합니다. 본 상세 정보에는 creatorInfo/updatorInfo가 포함되지 않으므로 목록을 기준으로 해당 필드가 존재한다고 가정할 수 없습니다.
RUM 소스에만 sourcesInfo가 첨부되며, *는 {name:*} 요약을 반환하고 알 수 없는 appId는 {}를 반환합니다. 요약 조회에는 삭제된 RUM 애플리케이션이 포함될 수 있으므로, 먼저 활성 애플리케이션 간단 목록으로 실제 연결 여부를 확인해야 합니다. 다른 유형에는 sourcesInfo가 없습니다. 규칙은 Studio에 저장된 설정만 나타내며, 오류 레코드가 이미 생성되었거나 과거 이력의 소급 재계산이 완료되었거나 다운스트림에 즉시 적용되었음을 의미하지 않습니다. content.declaration은 상위 공통 선언이며, 목록의 pageInfo는 최상위에 있고 data는 content.data를 유지합니다.
경로 파라미터¶
| 파라미터 이름 | 유형 | 필수 | 설명 |
|---|---|---|---|
| rule_uuid | string | Y | 현재 워크스페이스의 삭제되지 않은 규칙 UUID로, 상태 0(활성화) 및 2(비활성화)를 포함합니다. 텔레메트리 issue_id나 로컬 isset_ 처리 메타데이터가 아닙니다. 빈 문자열 허용: False 예: issetrule_example가져오기 또는 입력 방법: 오류 추적 규칙 목록에서 content.data[].uuid를 가져옵니다. |
요청 헤더¶
| 파라미터 이름 | 유형 | 필수 | 설명 |
|---|---|---|---|
| DF-API-KEY | string | Y | 워크스페이스의 OpenAPI 인증 자격 증명입니다. 예: <DF-API-KEY>가져오기 또는 입력 방법: 대상 워크스페이스의 API Key 관리에서 해당 작업 권한이 있는 OpenAPI Key를 가져옵니다. |
요청 예시¶
curl --get 'https://openapi.guance.com/api/v1/error_track_rule/issetrule_example/get' \
-H 'DF-API-KEY: <DF-API-KEY>'
응답¶
HTTP 200, application/json. 아래 예시는 직접 읽을 수 있는 주요 필드를 보여줍니다.
| 필드 | 유형 | 설명 |
|---|---|---|
| content | object | 규칙 엔터티 및 선택적 RUM 요약입니다. |
| content.id | integer 또는 null | 데이터베이스 행 ID이며 경로 지정에 사용되지 않습니다. 제출 전 스냅샷에서는 null일 수 있습니다. |
| content.uuid | string | 오류 추적 규칙 UUID이며 issetrule_ 접두사를 가집니다. 오류 처리 메타데이터 isset_ 또는 텔레메트리 issue_id가 아닙니다. |
| content.status | integer | 데이터베이스 상태: 0 활성화, 2 비활성화, 3 소프트 삭제(읽기 시 3 제외). |
| content.creator | string | 생성 주체 UUID입니다. 이 공개 진입점에서는 일반적으로 Key 리소스(wsak_)가 생성 주체이며, 과거 레코드는 다른 주체일 수 있고 sys 메타데이터를 자동으로 초기화하지 않습니다. |
| content.updator | string | 최근 갱신 주체이며, 갱신되지 않은 경우 비어 있을 수 있습니다. |
| content.createAt | integer | Unix 초 단위 생성 시간입니다. |
| content.updateAt | integer | Unix 초 단위 갱신 시간이며, 생성 후 갱신되지 않은 경우 일반적으로 -1입니다. |
| content.deleteAt | integer | Unix 초 단위 삭제 시간이며, 삭제되지 않은 경우 일반적으로 -1입니다. |
| content.workspaceUUID | string | 현재 Key가 속한 워크스페이스입니다. |
| content.name | string | 규칙 이름이며 중복될 수 있습니다. |
| content.desc | string | 규칙 설명입니다. |
| content.type | string | logging/tracing/rum. |
| content.sources | array | 저장된 소스 배열이며, 클라이언트는 문자열만 사용해야 합니다. 과거의 비문자열 값은 내결함성 있게 처리해야 합니다. |
| content.sources[] | JSON | 일반적으로 인덱스 이름/appId/서비스 이름 또는 *이며, 역할 또는 계정 ID가 아닙니다. |
| content.extend | object 또는 null | 저장된 확장이며, 일반적으로 객체로 기록됩니다. 과거 값은 내결함성 있게 처리해야 합니다. |
| content.extend.사용자 정의 키 | JSON | 사용자 정의 저장 값이며 고정된 실행 의미가 없습니다. |
| content.sourcesInfo | array<object> |
RUM 규칙의 list/get 응답에만 추가되며 sources와 동일한 순서입니다. 구문 분석할 수 없는 항목은 {}이며, 애플리케이션이 여전히 활성 상태임을 보장하지 않습니다. |
| content.sourcesInfo[].appId | string | 실제 애플리케이션 appId이며, 와일드카드 항목은 *입니다. |
| content.sourcesInfo[].jsonContent | object | 원본 RUM 애플리케이션 jsonContent입니다. 조회 시 삭제된 애플리케이션을 제외하지 않으므로 요약만으로 여전히 활성 상태라고 판단할 수 없습니다. |
| content.sourcesInfo[].jsonContent.name | string | 애플리케이션 표시 이름이며, 와일드카드 항목은 *입니다. |
| content.sourcesInfo[].jsonContent.type | string | 애플리케이션 플랫폼이며, 와일드카드 항목에는 일반적으로 값이 없습니다. |
| content.sourcesInfo[].jsonContent.extend | object | 선택적 애플리케이션 동적 확장입니다. |
| content.sourcesInfo[].jsonContent.extend.사용자 정의 키 | JSON | 애플리케이션에 저장된 확장 값입니다. |
| content.declaration | object 또는 null | 현재 워크스페이스의 공통 선언입니다. |
{
"code": 200,
"content": {
"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"
}
}
],
"declaration": {}
},
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE"
}
오류 응답¶
인증, 속도 제한 및 공통 요청 오류는 공통 오류 정의를 참조합니다.
| HTTP 상태 | errorCode | 발생 조건 | 메시지 또는 응답 설명 | 처리 방법 |
|---|---|---|---|---|
| 404 | ft.ObjectNotExists | 규칙이 존재하지 않거나, 삭제되었거나, 현재 Key 워크스페이스에 속하지 않음 | 지정된 객체가 존재하지 않음 | 현재 워크스페이스의 규칙 목록을 새로 고쳐 실제 uuid를 가져옵니다. |
| 500 | ft.InternalServerError | 데이터베이스 읽기, 과거 JSON 구조 또는 연관 요약 구성 중 처리되지 않은 예외 발생 | 내부 오류 | traceId를 보존하고 백오프합니다. 계속 실패하면 관리자에게 관련 과거 레코드와 설정을 확인하도록 요청합니다. |