GET /config/event_sources/log_source_management/protocol_types/{id}
요약 ID별로 프로토콜 유형을 검색합니다. 시스템 관리자, 보안 관리자 또는 로그 소스 관리 권한이 필요합니다.
MIME 유형 |
---|
애플리케이션/json |
매개 변수 | 유형 | 선택성 | 데이터 유형 | MIME 유형 | 설명 |
---|---|---|---|---|---|
자료 |
경로 |
필수 |
번호(정수) |
텍스트/일반 |
검색할 프로토콜 유형의 ID입니다. |
필드 |
쿼리 |
선택적 |
문자열 |
텍스트/일반 |
선택 사항 - 이 매개 변수를 사용하여 응답에서 다시 얻을 필드를 지정합니다. 이름이 지정되지 않은 필드는 제외됩니다. 괄호 안에 하위 필드를 지정하고 동일한 개체의 여러 필드가 쉼표로 구분됩니다. |
HTTP 응답 코드 | 고유 코드 | 설명 |
---|---|---|
200 |
|
프로토콜 유형이 성공적으로 검색되었습니다. |
404 |
1002 |
프로토콜 유형 ID가 발견되지 않았습니다. |
500 |
1020 |
프로토콜을 검색하려는 시도 중에 오류가 발생했습니다. |
응답 설명
- 프로토콜이 검색된 후의 유형입니다. 프로토콜 유형은 다음 필드를 포함합니다.
- id - Long - 프로토콜 유형의 ID.
- 이름 - 문자열 - 프로토콜 유형의 고유한 이름입니다.
- 버전 - 문자열 - 프로토콜 유형 구성 요소의 버전입니다.
- latest_version - 문자열 - 프로토콜 유형 구성 요소의 최신 사용 가능한 버전.
- gateway_supported - Boolean - 게이트웨이 로그 소스에 대해 이 프로토콜 유형을 구성할 수 있는 경우 조건은 'true'로 설정됩니다. 그렇지 않으면 조건이 'false'로 설정됩니다. 게이트웨이 로그 소스는 독립형 프로토콜 구성입니다. 로그 소스는 이벤트 자체를 수신하지 않으며, 다른 로그 소스를 피드하기 위해 이벤트 데이터를 검색하는 프로토콜 구성의 호스트 역할을 합니다. 여러 시스템의 이벤트가 이벤트 파이프라인에 진입하기 위한 "게이트웨이" 역할을 합니다. 여러 소스에서 이벤트 데이터 수집을 지원하지 않는 경우 모든 프로토콜 유형을 게이트웨이로 사용할 수 없습니다.
- 인바운드 - Boolean - 이것이 인바운드 프로토콜인지 여부를 나타냅니다.
- 매개 변수 - 배열 - 이 프로토콜 유형의 매개 변수.
- parameter_groups - 배열 - 이 프로토콜 유형의 매개변수 그룹.
- testing_capabilities - 개체 - 이 프로토콜 유형의 테스트 기능. 이러한 기능은 이 프로토콜 유형을 사용하여 로그 소스에 대한 로그 소스 테스트 API의 기능을 설명합니다.
- id - Long - 매개 변수 ID.
- 이름 - 문자열 - 매개 변수 이름.
- 유형 - 열거 - 매개 변수 유형. 가능한 값은 다음과 같습니다: 문자열, 텍스트, 정수, 실제, 부울, 날짜, 시간, 날짜 시간, 간격, 호스트, 암호, REGEX
- group_id - 번호 - 이 매개변수가 속한 프로토콜 매개변수 그룹의 ID. group_id 선택 사항입니다.
- 필요 - Boolean - 매개 변수가 필수인 경우 조건은 'true'로 설정됩니다. 그렇지 않으면 조건이 'false'로 설정됩니다.
- min_length - 정수 - 다음 매개 변수 유형에 대한 매개 변수 값의 최소 길이: 문자열, 텍스트, 호스트, 암호, REGEX. min_length 선택 사항입니다.
- max_length - 정수 - 다음 매개 변수 유형에 대한 매개 변수 값의 최대 길이: 문자열, 텍스트, 호스트, 암호, REGEX. max_length 선택 사항입니다.
- min_value - 문자열 - 다음 매개 변수 유형에 대한 매개 변수 값의 최소 값: 정수, 실제, 날짜, 시간, 날짜 시간, 간격. min_value 선택 사항입니다.
- max_value - 문자열 - 다음 매개 변수 유형에 대한 매개 변수 값의 최대 값: 정수, 실제, 날짜, 시간, 날짜 시간, 간격. max_value 선택 사항입니다.
- default_value - 문자열 - 선택적 기본 매개변수 값입니다.
- 패턴 - 문자열 - 문자열 - 다음 매개 변수 유형에 대한 매개 변수 값에 대한 선택적 Java regex 패턴 제한: 문자열, 텍스트, 호스트, 암호.
- pattern_error_message - 문자열 - '패턴' 제한이 실패할 때 표시할 선택적 메시지.
- allowed_values - 배열 - 열거 매개변수를 구현하는 데 사용되는 허용 파라미터 값의 선택적 제한 목록입니다.
- 규칙 - 배열 - 매개 변수 규칙은 다양한 매개 변수 조건을 관리합니다(예: 옵션 A는 옵션 B가 'true'로 설정된 경우에만 사용 가능하고, 옵션 A가 '거짓'으로 설정될 때마다 옵션 C가 필요합니다.)
- 이름 - 문자열 - 허용되는 값의 이름입니다.
- 값 - 문자열 - 허용되는 값입니다.
- parameter_id - 문자열 - 규칙의 영향을 받는 매개 변수 ID.
- trigger_parameter_id - 긴 - 트리거 매개 변수 ID.
- trigger_pattern - 문자열 - 규칙을 트리거하는 패턴. 예를 들어, trigger_parameter_id 값이 이 필드의 정규 표현식과 일치하면 규칙이 트리거됩니다.
- affected_property - 문자열 - 영향을 받는 속성입니다. 가능한 값은 다음과 같습니다.
- 사용 가능: 매개 변수의 가용성이 이 규칙의 영향을 받음을 나타냅니다.
- 필수: 매개 변수의 필수 상태가 이 규칙의 영향을 받음을 나타냅니다.
- 기본값: 매개 변수의 기본 값이 이 규칙의 영향을 받음을 나타냅니다.
- affected_property_value - 문자열 - 규칙이 트리거될 때 영향을 받는 매개 변수에 적용되는 값입니다. 다음 목록은 영향을 받는 속성을 기반으로 이 필드가 어떻게 해석되는지 설명합니다.
- 사용 가능: 영향을 받는 매개 변수를 사용할 수 있는지 여부를 나타내는 부울 값이 될 것입니다. 모든 필드를 기본적으로 사용할 수 있기 때문에 이를 'true'로 설정하는 것은 의미가 없습니다.
- 필수: 영향을 받는 매개 변수가 필요한지 여부를 나타내는 부울 값입니다.
- 기본값: 영향을 받는 매개 변수에 의해 사용되는 기본 값이 됩니다.
- id - Long - 프로토콜 매개 변수 그룹의 ID.
- 이름 - 문자열 - 프로토콜 매개 변수 그룹의 이름
- 필요 - Boolean - 이 그룹에서 하나 이상의 매개 변수를 설정해야 하는 경우 조건은 'true'로 설정됩니다. 그렇지 않으면 조건이 'false'로 설정됩니다.
- testable - Boolean - 프로토콜 유형이 테스트 가능한지 여부를 나타냅니다.
- can_collect_events - Boolean - 프로토콜 유형이 테스트 이벤트를 수집할 수 있는지 여부를 나타냅니다.
- can_accept_sample_events - Boolean - 프로토콜 유형이 샘플 이벤트를 수락할 수 있는지 여부를 나타냅니다(인바운드 프로토콜 유형에만 적용 가능).
응답 샘플
{ "gateway_supported": true, "id": 42, "inbound": true, "latest_version": "String", "name": "String", "parameter_groups": [ { "id": 42, "name": "String", "required": true } ], "parameters": [ { "allowed_values": [ { "name": "String", "value": "String" } ], "default_value": "String", "description": "String", "group_id": 42, "id": 42, "label": "String", "max_length": 42, "max_value": "String", "min_length": 42, "min_value": "String", "name": "String", "pattern": "String", "pattern_description": "String", "required": true, "rules": [ { "affected_property": "String", "affected_property_value": "String", "parameter_id": 42, "trigger_parameter_id": 42, "trigger_pattern": "String" } ], "type": "String" } ], "testing_capabilities": { "can_accept_sample_events": true, "can_collect_events": true, "testable": true }, "version": "String" }