4.3. 경로
4.3.1. GET / 링크 복사링크가 클립보드에 복사되었습니다!
4.3.1.1. 설명 링크 복사링크가 클립보드에 복사되었습니다!
Kafka Bridge 인스턴스에 대한 정보를 JSON 형식으로 검색합니다.
4.3.1.2. 응답 링크 복사링크가 클립보드에 복사되었습니다!
| HTTP 코드 | 설명 | 스키마 |
|---|---|---|
| 200 | Kafka 브리지 인스턴스에 대한 정보입니다. |
4.3.1.3. 생성 링크 복사링크가 클립보드에 복사되었습니다!
-
application/json
4.3.1.4. HTTP 응답의 예 링크 복사링크가 클립보드에 복사되었습니다!
4.3.1.4.1. 응답 200 링크 복사링크가 클립보드에 복사되었습니다!
{
"bridge_version" : "0.16.0"
}
4.3.2. POST /consumers/{groupid} 링크 복사링크가 클립보드에 복사되었습니다!
4.3.2.1. 설명 링크 복사링크가 클립보드에 복사되었습니다!
지정된 소비자 그룹에서 소비자 인스턴스를 생성합니다. 필요한 경우 소비자 이름 및 지원되는 구성 옵션을 지정할 수 있습니다. 이 소비자 인스턴스에 대한 후속 요청에 대한 URL을 구성하는 데 사용해야 하는 기본 URI를 반환합니다.
4.3.2.2. 매개 변수 링크 복사링크가 클립보드에 복사되었습니다!
| 유형 | 이름 | 설명 | 스키마 |
|---|---|---|---|
| 경로 |
groupID | 소비자를 생성할 소비자 그룹의 ID입니다. | string |
| 본문 |
본문 | 소비자의 이름 및 구성입니다. 이름은 consumer 그룹의 범위 내에서 고유합니다. 이름을 지정하지 않으면 임의로 생성된 이름이 할당됩니다. 모든 매개변수는 선택 사항입니다. 지원되는 구성 옵션은 다음 예에 표시되어 있습니다. |
4.3.2.3. 응답 링크 복사링크가 클립보드에 복사되었습니다!
| HTTP 코드 | 설명 | 스키마 |
|---|---|---|
| 200 | 소비자가 성공적으로 생성되었습니다. | |
| 409 | 지정된 이름의 소비자 인스턴스가 Kafka 브리지에 이미 존재합니다. | |
| 422 | 하나 이상의 소비자 구성 옵션에는 잘못된 값이 있습니다. |
4.3.2.4. 사용 링크 복사링크가 클립보드에 복사되었습니다!
-
application/vnd.kafka.v2+json
4.3.2.5. 생성 링크 복사링크가 클립보드에 복사되었습니다!
-
application/vnd.kafka.v2+json
4.3.2.6. 태그 링크 복사링크가 클립보드에 복사되었습니다!
- 소비자
4.3.2.7. HTTP 요청의 예 링크 복사링크가 클립보드에 복사되었습니다!
4.3.2.7.1. 요청 본문 링크 복사링크가 클립보드에 복사되었습니다!
{
"name" : "consumer1",
"format" : "binary",
"auto.offset.reset" : "earliest",
"enable.auto.commit" : false,
"fetch.min.bytes" : 512,
"consumer.request.timeout.ms" : 30000,
"isolation.level" : "read_committed"
}
4.3.2.8. HTTP 응답의 예 링크 복사링크가 클립보드에 복사되었습니다!
4.3.2.8.1. 응답 200 링크 복사링크가 클립보드에 복사되었습니다!
{
"instance_id" : "consumer1",
"base_uri" : "http://localhost:8080/consumers/my-group/instances/consumer1"
}
4.3.2.8.2. 응답 409 링크 복사링크가 클립보드에 복사되었습니다!
{
"error_code" : 409,
"message" : "A consumer instance with the specified name already exists in the Kafka Bridge."
}
4.3.2.8.3. 응답 422 링크 복사링크가 클립보드에 복사되었습니다!
{
"error_code" : 422,
"message" : "One or more consumer configuration options have invalid values."
}
4.3.3. DELETE /consumers/{groupid}/instances/{name} 링크 복사링크가 클립보드에 복사되었습니다!
4.3.3.1. 설명 링크 복사링크가 클립보드에 복사되었습니다!
지정된 소비자 인스턴스를 삭제합니다. 이 작업에 대한 요청은 이 소비자를 생성하는 데 사용된 /consumers/{groupid} 에 대한 POST 요청에서 반환된 기본 URL(호스트 및 포트 포함)을 사용해야 합니다.
4.3.3.2. 매개 변수 링크 복사링크가 클립보드에 복사되었습니다!
| 유형 | 이름 | 설명 | 스키마 |
|---|---|---|---|
| 경로 |
groupID | 소비자가 속한 소비자 그룹의 ID입니다. | string |
| 경로 |
이름 | 삭제할 소비자의 이름입니다. | string |
4.3.3.3. 응답 링크 복사링크가 클립보드에 복사되었습니다!
| HTTP 코드 | 설명 | 스키마 |
|---|---|---|
| 204 | 소비자가 성공적으로 제거되었습니다. | 콘텐츠 없음 |
| 404 | 지정된 소비자 인스턴스를 찾을 수 없습니다. |
4.3.3.4. 사용 링크 복사링크가 클립보드에 복사되었습니다!
-
application/vnd.kafka.v2+json
4.3.3.5. 생성 링크 복사링크가 클립보드에 복사되었습니다!
-
application/vnd.kafka.v2+json
4.3.3.6. 태그 링크 복사링크가 클립보드에 복사되었습니다!
- 소비자
4.3.3.7. HTTP 응답의 예 링크 복사링크가 클립보드에 복사되었습니다!
4.3.3.7.1. 응답 404 링크 복사링크가 클립보드에 복사되었습니다!
{
"error_code" : 404,
"message" : "The specified consumer instance was not found."
}
4.3.4. POST /consumers/{groupid}/instances/{name}/assignments 링크 복사링크가 클립보드에 복사되었습니다!
4.3.4.1. 설명 링크 복사링크가 클립보드에 복사되었습니다!
하나 이상의 주제 파티션을 소비자에 할당합니다.
4.3.4.2. 매개 변수 링크 복사링크가 클립보드에 복사되었습니다!
| 유형 | 이름 | 설명 | 스키마 |
|---|---|---|---|
| 경로 |
groupID | 소비자가 속한 소비자 그룹의 ID입니다. | string |
| 경로 |
이름 | 주제 파티션을 할당할 소비자의 이름입니다. | string |
| 본문 |
본문 | 소비자에게 할당할 주제 파티션 목록입니다. |
4.3.4.3. 응답 링크 복사링크가 클립보드에 복사되었습니다!
4.3.4.4. 사용 링크 복사링크가 클립보드에 복사되었습니다!
-
application/vnd.kafka.v2+json
4.3.4.5. 생성 링크 복사링크가 클립보드에 복사되었습니다!
-
application/vnd.kafka.v2+json
4.3.4.6. 태그 링크 복사링크가 클립보드에 복사되었습니다!
- 소비자
4.3.4.7. HTTP 요청의 예 링크 복사링크가 클립보드에 복사되었습니다!
4.3.4.7.1. 요청 본문 링크 복사링크가 클립보드에 복사되었습니다!
{
"partitions" : [ {
"topic" : "topic",
"partition" : 0
}, {
"topic" : "topic",
"partition" : 1
} ]
}
4.3.4.8. HTTP 응답의 예 링크 복사링크가 클립보드에 복사되었습니다!
4.3.4.8.1. 응답 404 링크 복사링크가 클립보드에 복사되었습니다!
{
"error_code" : 404,
"message" : "The specified consumer instance was not found."
}
4.3.4.8.2. 응답 409 링크 복사링크가 클립보드에 복사되었습니다!
{
"error_code" : 409,
"message" : "Subscriptions to topics, partitions, and patterns are mutually exclusive."
}
4.3.5. POST /consumers/{groupid}/instances/{name}/offsets 링크 복사링크가 클립보드에 복사되었습니다!
4.3.5.1. 설명 링크 복사링크가 클립보드에 복사되었습니다!
소비자 오프셋 목록을 커밋합니다. 소비자가 가져온 모든 레코드에 대한 오프셋을 커밋하려면 요청 본문을 비워 둡니다.
4.3.5.2. 매개 변수 링크 복사링크가 클립보드에 복사되었습니다!
| 유형 | 이름 | 설명 | 스키마 |
|---|---|---|---|
| 경로 |
groupID | 소비자가 속한 소비자 그룹의 ID입니다. | string |
| 경로 |
이름 | 소비자의 이름입니다. | string |
| 본문 |
본문 | 소비자 오프셋 커밋 로그에 커밋할 소비자 오프셋 목록입니다. 오프셋을 커밋할 하나 이상의 주제 파티션을 지정할 수 있습니다. |
4.3.5.3. 응답 링크 복사링크가 클립보드에 복사되었습니다!
| HTTP 코드 | 설명 | 스키마 |
|---|---|---|
| 204 | 성공적으로 커밋되었습니다. | 콘텐츠 없음 |
| 404 | 지정된 소비자 인스턴스를 찾을 수 없습니다. |
4.3.5.4. 사용 링크 복사링크가 클립보드에 복사되었습니다!
-
application/vnd.kafka.v2+json
4.3.5.5. 생성 링크 복사링크가 클립보드에 복사되었습니다!
-
application/vnd.kafka.v2+json
4.3.5.6. 태그 링크 복사링크가 클립보드에 복사되었습니다!
- 소비자
4.3.5.7. HTTP 요청의 예 링크 복사링크가 클립보드에 복사되었습니다!
4.3.5.7.1. 요청 본문 링크 복사링크가 클립보드에 복사되었습니다!
{
"offsets" : [ {
"topic" : "topic",
"partition" : 0,
"offset" : 15
}, {
"topic" : "topic",
"partition" : 1,
"offset" : 42
} ]
}
4.3.5.8. HTTP 응답의 예 링크 복사링크가 클립보드에 복사되었습니다!
4.3.5.8.1. 응답 404 링크 복사링크가 클립보드에 복사되었습니다!
{
"error_code" : 404,
"message" : "The specified consumer instance was not found."
}
4.3.6. POST /consumers/{groupid}/instances/{name}/positions 링크 복사링크가 클립보드에 복사되었습니다!
4.3.6.1. 설명 링크 복사링크가 클립보드에 복사되었습니다!
다음 번에 지정된 주제 파티션에서 레코드 집합을 가져올 때 서브스크립션된 소비자가 특정 오프셋에서 오프셋을 가져오도록 구성합니다. 이렇게 하면 소비자의 기본 가져오기 동작이 재정의됩니다. 하나 이상의 주제 파티션을 지정할 수 있습니다.
4.3.6.2. 매개 변수 링크 복사링크가 클립보드에 복사되었습니다!
| 유형 | 이름 | 설명 | 스키마 |
|---|---|---|---|
| 경로 |
groupID | 소비자가 속한 소비자 그룹의 ID입니다. | string |
| 경로 |
이름 | 구독한 소비자의 이름입니다. | string |
| 본문 |
본문 | 서브스크립션 소비자가 다음에 레코드를 가져올 파티션 오프셋 목록입니다. |
4.3.6.3. 응답 링크 복사링크가 클립보드에 복사되었습니다!
| HTTP 코드 | 설명 | 스키마 |
|---|---|---|
| 204 | 검색이 성공적으로 수행되었습니다. | 콘텐츠 없음 |
| 404 | 지정된 소비자 인스턴스를 찾을 수 없거나 지정된 소비자 인스턴스에 지정된 파티션 중 하나가 할당되지 않았습니다. |
4.3.6.4. 사용 링크 복사링크가 클립보드에 복사되었습니다!
-
application/vnd.kafka.v2+json
4.3.6.5. 생성 링크 복사링크가 클립보드에 복사되었습니다!
-
application/vnd.kafka.v2+json
4.3.6.6. 태그 링크 복사링크가 클립보드에 복사되었습니다!
- 소비자
- 검색
4.3.6.7. HTTP 요청의 예 링크 복사링크가 클립보드에 복사되었습니다!
4.3.6.7.1. 요청 본문 링크 복사링크가 클립보드에 복사되었습니다!
{
"offsets" : [ {
"topic" : "topic",
"partition" : 0,
"offset" : 15
}, {
"topic" : "topic",
"partition" : 1,
"offset" : 42
} ]
}
4.3.6.8. HTTP 응답의 예 링크 복사링크가 클립보드에 복사되었습니다!
4.3.6.8.1. 응답 404 링크 복사링크가 클립보드에 복사되었습니다!
{
"error_code" : 404,
"message" : "The specified consumer instance was not found."
}
4.3.7. POST /consumers/{groupid}/instances/{name}/positions/beginning 링크 복사링크가 클립보드에 복사되었습니다!
4.3.7.1. 설명 링크 복사링크가 클립보드에 복사되었습니다!
서브스크립션된 소비자를 구성하여 하나 이상의 지정된 주제 파티션에서 첫 번째 오프셋을 검색(따라서 읽음)합니다.
4.3.7.2. 매개 변수 링크 복사링크가 클립보드에 복사되었습니다!
| 유형 | 이름 | 설명 | 스키마 |
|---|---|---|---|
| 경로 |
groupID | 서브스크립션된 소비자가 속한 소비자 그룹의 ID입니다. | string |
| 경로 |
이름 | 구독한 소비자의 이름입니다. | string |
| 본문 |
본문 | 소비자가 서브스크립션하는 주제 파티션 목록입니다. 소비자는 지정된 파티션에서 첫 번째 오프셋을 검색합니다. |
4.3.7.3. 응답 링크 복사링크가 클립보드에 복사되었습니다!
| HTTP 코드 | 설명 | 스키마 |
|---|---|---|
| 204 | 처음에는 성공적으로 수행되었습니다. | 콘텐츠 없음 |
| 404 | 지정된 소비자 인스턴스를 찾을 수 없거나 지정된 소비자 인스턴스에 지정된 파티션 중 하나가 할당되지 않았습니다. |
4.3.7.4. 사용 링크 복사링크가 클립보드에 복사되었습니다!
-
application/vnd.kafka.v2+json
4.3.7.5. 생성 링크 복사링크가 클립보드에 복사되었습니다!
-
application/vnd.kafka.v2+json
4.3.7.6. 태그 링크 복사링크가 클립보드에 복사되었습니다!
- 소비자
- 검색
4.3.7.7. HTTP 요청의 예 링크 복사링크가 클립보드에 복사되었습니다!
4.3.7.7.1. 요청 본문 링크 복사링크가 클립보드에 복사되었습니다!
{
"partitions" : [ {
"topic" : "topic",
"partition" : 0
}, {
"topic" : "topic",
"partition" : 1
} ]
}
4.3.7.8. HTTP 응답의 예 링크 복사링크가 클립보드에 복사되었습니다!
4.3.7.8.1. 응답 404 링크 복사링크가 클립보드에 복사되었습니다!
{
"error_code" : 404,
"message" : "The specified consumer instance was not found."
}
4.3.8. POST /consumers/{groupid}/instances/{name}/positions/end 링크 복사링크가 클립보드에 복사되었습니다!
4.3.8.1. 설명 링크 복사링크가 클립보드에 복사되었습니다!
서브스크립션된 소비자를 구성하여 하나 이상의 주제 파티션 끝에 오프셋을 검색(및 이후에 읽음)합니다.
4.3.8.2. 매개 변수 링크 복사링크가 클립보드에 복사되었습니다!
| 유형 | 이름 | 설명 | 스키마 |
|---|---|---|---|
| 경로 |
groupID | 서브스크립션된 소비자가 속한 소비자 그룹의 ID입니다. | string |
| 경로 |
이름 | 구독한 소비자의 이름입니다. | string |
| 본문 |
본문 | 소비자가 서브스크립션하는 주제 파티션 목록입니다. 소비자는 지정된 파티션에서 마지막 오프셋을 검색합니다. |
4.3.8.3. 응답 링크 복사링크가 클립보드에 복사되었습니다!
| HTTP 코드 | 설명 | 스키마 |
|---|---|---|
| 204 | 성공적으로 수행 된 끝을 찾습니다. | 콘텐츠 없음 |
| 404 | 지정된 소비자 인스턴스를 찾을 수 없거나 지정된 소비자 인스턴스에 지정된 파티션 중 하나가 할당되지 않았습니다. |
4.3.8.4. 사용 링크 복사링크가 클립보드에 복사되었습니다!
-
application/vnd.kafka.v2+json
4.3.8.5. 생성 링크 복사링크가 클립보드에 복사되었습니다!
-
application/vnd.kafka.v2+json
4.3.8.6. 태그 링크 복사링크가 클립보드에 복사되었습니다!
- 소비자
- 검색
4.3.8.7. HTTP 요청의 예 링크 복사링크가 클립보드에 복사되었습니다!
4.3.8.7.1. 요청 본문 링크 복사링크가 클립보드에 복사되었습니다!
{
"partitions" : [ {
"topic" : "topic",
"partition" : 0
}, {
"topic" : "topic",
"partition" : 1
} ]
}
4.3.8.8. HTTP 응답의 예 링크 복사링크가 클립보드에 복사되었습니다!
4.3.8.8.1. 응답 404 링크 복사링크가 클립보드에 복사되었습니다!
{
"error_code" : 404,
"message" : "The specified consumer instance was not found."
}
4.3.9. GET /consumers/{groupid}/instances/{name}/records 링크 복사링크가 클립보드에 복사되었습니다!
4.3.9.1. 설명 링크 복사링크가 클립보드에 복사되었습니다!
메시지 값, 주제 및 파티션을 포함하여 구독한 소비자에 대한 레코드를 검색합니다. 이 작업에 대한 요청은 이 소비자를 생성하는 데 사용된 /consumers/{groupid} 에 대한 POST 요청에서 반환된 기본 URL(호스트 및 포트 포함)을 사용해야 합니다.
4.3.9.2. 매개 변수 링크 복사링크가 클립보드에 복사되었습니다!
| 유형 | 이름 | 설명 | 스키마 |
|---|---|---|---|
| 경로 |
groupID | 서브스크립션된 소비자가 속한 소비자 그룹의 ID입니다. | string |
| 경로 |
이름 | 레코드를 검색할 구독 소비자의 이름입니다. | string |
| 쿼리 |
max_bytes | 응답에 포함될 수 있는 인코딩되지 않은 키와 값의 최대 크기(바이트)입니다. 그렇지 않으면 코드 422에 대한 오류 응답이 반환됩니다. | integer |
| 쿼리 |
시간 초과 | HTTP 브리지가 요청을 타이밍하기 전에 레코드를 검색하는 데 사용하는 최대 시간(밀리초)입니다. | integer |
4.3.9.3. 응답 링크 복사링크가 클립보드에 복사되었습니다!
| HTTP 코드 | 설명 | 스키마 |
|---|---|---|
| 200 | 설문 조사 요청이 성공적으로 실행되었습니다. | |
| 404 | 지정된 소비자 인스턴스를 찾을 수 없습니다. | |
| 406 |
소비자 생성 요청에 사용된 | |
| 422 | 응답은 소비자가 수신할 수 있는 최대 바이트 수를 초과합니다. |
4.3.9.4. 생성 링크 복사링크가 클립보드에 복사되었습니다!
-
application/vnd.kafka.json.v2+json -
application/vnd.kafka.binary.v2+json -
application/vnd.kafka.text.v2+json -
application/vnd.kafka.v2+json
4.3.9.5. 태그 링크 복사링크가 클립보드에 복사되었습니다!
- 소비자
4.3.9.6. HTTP 응답의 예 링크 복사링크가 클립보드에 복사되었습니다!
4.3.9.6.1. 응답 200 링크 복사링크가 클립보드에 복사되었습니다!
[ {
"topic" : "topic",
"key" : "key1",
"value" : {
"foo" : "bar"
},
"partition" : 0,
"offset" : 2
}, {
"topic" : "topic",
"key" : "key2",
"value" : [ "foo2", "bar2" ],
"partition" : 1,
"offset" : 3
} ]
[
{
"topic": "test",
"key": "a2V5",
"value": "Y29uZmx1ZW50",
"partition": 1,
"offset": 100,
},
{
"topic": "test",
"key": "a2V5",
"value": "a2Fma2E=",
"partition": 2,
"offset": 101,
}
]
4.3.9.6.2. 응답 404 링크 복사링크가 클립보드에 복사되었습니다!
{
"error_code" : 404,
"message" : "The specified consumer instance was not found."
}
4.3.9.6.3. 응답 406 링크 복사링크가 클립보드에 복사되었습니다!
{
"error_code" : 406,
"message" : "The `format` used in the consumer creation request does not match the embedded format in the Accept header of this request."
}
4.3.9.6.4. 응답 422 링크 복사링크가 클립보드에 복사되었습니다!
{
"error_code" : 422,
"message" : "Response exceeds the maximum number of bytes the consumer can receive"
}
4.3.10. POST /consumers/{groupid}/instances/{name}/subscription 링크 복사링크가 클립보드에 복사되었습니다!
4.3.10.1. 설명 링크 복사링크가 클립보드에 복사되었습니다!
사용자를 하나 이상의 항목에 서브스크립션합니다. 소비자가 목록(주제 유형) 또는 topic_pattern 필드로 서브스크립션할 주제를 설명할 수 있습니다. 각 호출은 구독자에 대한 서브스크립션을 대체합니다.
4.3.10.2. 매개 변수 링크 복사링크가 클립보드에 복사되었습니다!
| 유형 | 이름 | 설명 | 스키마 |
|---|---|---|---|
| 경로 |
groupID | 서브스크립션된 소비자가 속한 소비자 그룹의 ID입니다. | string |
| 경로 |
이름 | 주제를 등록할 소비자의 이름입니다. | string |
| 본문 |
본문 | 소비자가 서브스크립션할 주제 목록입니다. |
4.3.10.3. 응답 링크 복사링크가 클립보드에 복사되었습니다!
4.3.10.4. 사용 링크 복사링크가 클립보드에 복사되었습니다!
-
application/vnd.kafka.v2+json
4.3.10.5. 생성 링크 복사링크가 클립보드에 복사되었습니다!
-
application/vnd.kafka.v2+json
4.3.10.6. 태그 링크 복사링크가 클립보드에 복사되었습니다!
- 소비자
4.3.10.7. HTTP 요청의 예 링크 복사링크가 클립보드에 복사되었습니다!
4.3.10.7.1. 요청 본문 링크 복사링크가 클립보드에 복사되었습니다!
{
"topics" : [ "topic1", "topic2" ]
}
4.3.10.8. HTTP 응답의 예 링크 복사링크가 클립보드에 복사되었습니다!
4.3.10.8.1. 응답 404 링크 복사링크가 클립보드에 복사되었습니다!
{
"error_code" : 404,
"message" : "The specified consumer instance was not found."
}
4.3.10.8.2. 응답 409 링크 복사링크가 클립보드에 복사되었습니다!
{
"error_code" : 409,
"message" : "Subscriptions to topics, partitions, and patterns are mutually exclusive."
}
4.3.10.8.3. 응답 422 링크 복사링크가 클립보드에 복사되었습니다!
{
"error_code" : 422,
"message" : "A list (of Topics type) or a topic_pattern must be specified."
}
4.3.11. GET /consumers/{groupid}/instances/{name}/subscription 링크 복사링크가 클립보드에 복사되었습니다!
4.3.11.1. 설명 링크 복사링크가 클립보드에 복사되었습니다!
소비자가 서브스크립션하는 주제 목록을 검색합니다.
4.3.11.2. 매개 변수 링크 복사링크가 클립보드에 복사되었습니다!
| 유형 | 이름 | 설명 | 스키마 |
|---|---|---|---|
| 경로 |
groupID | 서브스크립션된 소비자가 속한 소비자 그룹의 ID입니다. | string |
| 경로 |
이름 | 구독한 소비자의 이름입니다. | string |
4.3.11.3. 응답 링크 복사링크가 클립보드에 복사되었습니다!
| HTTP 코드 | 설명 | 스키마 |
|---|---|---|
| 200 | 서브스크립션된 주제 및 파티션 목록입니다. | |
| 404 | 지정된 소비자 인스턴스를 찾을 수 없습니다. |
4.3.11.4. 생성 링크 복사링크가 클립보드에 복사되었습니다!
-
application/vnd.kafka.v2+json
4.3.11.5. 태그 링크 복사링크가 클립보드에 복사되었습니다!
- 소비자
4.3.11.6. HTTP 응답의 예 링크 복사링크가 클립보드에 복사되었습니다!
4.3.11.6.1. 응답 200 링크 복사링크가 클립보드에 복사되었습니다!
{
"topics" : [ "my-topic1", "my-topic2" ],
"partitions" : [ {
"my-topic1" : [ 1, 2, 3 ]
}, {
"my-topic2" : [ 1 ]
} ]
}
4.3.11.6.2. 응답 404 링크 복사링크가 클립보드에 복사되었습니다!
{
"error_code" : 404,
"message" : "The specified consumer instance was not found."
}
4.3.12. DELETE /consumers/{groupid}/instances/{name}/subscription 링크 복사링크가 클립보드에 복사되었습니다!
4.3.12.1. 설명 링크 복사링크가 클립보드에 복사되었습니다!
모든 주제에서 소비자를 서브스크립션 해제합니다.
4.3.12.2. 매개 변수 링크 복사링크가 클립보드에 복사되었습니다!
| 유형 | 이름 | 설명 | 스키마 |
|---|---|---|---|
| 경로 |
groupID | 서브스크립션된 소비자가 속한 소비자 그룹의 ID입니다. | string |
| 경로 |
이름 | 주제에서 구독 취소할 소비자의 이름입니다. | string |
4.3.12.3. 응답 링크 복사링크가 클립보드에 복사되었습니다!
| HTTP 코드 | 설명 | 스키마 |
|---|---|---|
| 204 | 소비자가 성공적으로 취소되었습니다. | 콘텐츠 없음 |
| 404 | 지정된 소비자 인스턴스를 찾을 수 없습니다. |
4.3.12.4. 태그 링크 복사링크가 클립보드에 복사되었습니다!
- 소비자
4.3.12.5. HTTP 응답의 예 링크 복사링크가 클립보드에 복사되었습니다!
4.3.12.5.1. 응답 404 링크 복사링크가 클립보드에 복사되었습니다!
{
"error_code" : 404,
"message" : "The specified consumer instance was not found."
}
4.3.13. GET /healthy 링크 복사링크가 클립보드에 복사되었습니다!
4.3.13.1. 설명 링크 복사링크가 클립보드에 복사되었습니다!
브리지가 실행 중인지 확인합니다. 이는 반드시 요청을 수락할 준비가 되어 있음을 의미하지는 않습니다.
4.3.13.2. 응답 링크 복사링크가 클립보드에 복사되었습니다!
| HTTP 코드 | 설명 | 스키마 |
|---|---|---|
| 204 | 브릿지가 정상입니다. | 콘텐츠 없음 |
| 500 | 브릿지는 건강하지 않습니다. | 콘텐츠 없음 |
4.3.14. GET /metrics 링크 복사링크가 클립보드에 복사되었습니다!
4.3.14.1. 설명 링크 복사링크가 클립보드에 복사되었습니다!
Prometheus 형식으로 브리지 지표를 검색합니다.
4.3.14.2. 응답 링크 복사링크가 클립보드에 복사되었습니다!
| HTTP 코드 | 설명 | 스키마 |
|---|---|---|
| 200 | Prometheus 형식의 메트릭이 성공적으로 검색되었습니다. | string |
4.3.14.3. 생성 링크 복사링크가 클립보드에 복사되었습니다!
-
텍스트/설명
4.3.15. GET /openapi 링크 복사링크가 클립보드에 복사되었습니다!
4.3.15.1. 설명 링크 복사링크가 클립보드에 복사되었습니다!
OpenAPI v2 사양을 JSON 형식으로 검색합니다.
4.3.15.2. 응답 링크 복사링크가 클립보드에 복사되었습니다!
| HTTP 코드 | 설명 | 스키마 |
|---|---|---|
| 204 | JSON 형식의 OpenAPI v2 사양이 성공적으로 검색되었습니다. | string |
4.3.15.3. 생성 링크 복사링크가 클립보드에 복사되었습니다!
-
application/json
4.3.16. GET /ready 링크 복사링크가 클립보드에 복사되었습니다!
4.3.16.1. 설명 링크 복사링크가 클립보드에 복사되었습니다!
브리지가 준비되었는지 확인하고 요청을 수락할 수 있는지 확인합니다.
4.3.16.2. 응답 링크 복사링크가 클립보드에 복사되었습니다!
| HTTP 코드 | 설명 | 스키마 |
|---|---|---|
| 204 | 브리지가 준비됨 | 콘텐츠 없음 |
| 500 | 브리지가 준비되지 않았습니다. | 콘텐츠 없음 |
4.3.17. GET /topics 링크 복사링크가 클립보드에 복사되었습니다!
4.3.17.1. 설명 링크 복사링크가 클립보드에 복사되었습니다!
모든 주제 목록을 검색합니다.
4.3.17.2. 응답 링크 복사링크가 클립보드에 복사되었습니다!
| HTTP 코드 | 설명 | 스키마 |
|---|---|---|
| 200 | 주제 목록. | < string > array |
4.3.17.3. 생성 링크 복사링크가 클립보드에 복사되었습니다!
-
application/vnd.kafka.v2+json
4.3.17.4. 태그 링크 복사링크가 클립보드에 복사되었습니다!
- 주제
4.3.17.5. HTTP 응답의 예 링크 복사링크가 클립보드에 복사되었습니다!
4.3.17.5.1. 응답 200 링크 복사링크가 클립보드에 복사되었습니다!
[ "topic1", "topic2" ]
4.3.18. POST /topics/{topicname} 링크 복사링크가 클립보드에 복사되었습니다!
4.3.18.1. 설명 링크 복사링크가 클립보드에 복사되었습니다!
하나 이상의 레코드를 지정된 항목에 전송하고, 필요에 따라 파티션, 키 또는 둘 다를 지정합니다.
4.3.18.2. 매개 변수 링크 복사링크가 클립보드에 복사되었습니다!
| 유형 | 이름 | 설명 | 스키마 |
|---|---|---|---|
| 경로 |
주제 이름 | 레코드를 보내거나 메타데이터에서 검색할 항목의 이름입니다. | string |
| 쿼리 |
Async | 메타데이터를 기다리는 대신 레코드를 전송할 때 즉시 반환할지 여부입니다. 지정된 경우 오프셋은 반환되지 않습니다. 기본값은 false입니다. | boolean |
| 본문 |
본문 |
4.3.18.3. 응답 링크 복사링크가 클립보드에 복사되었습니다!
| HTTP 코드 | 설명 | 스키마 |
|---|---|---|
| 200 | 레코드가 성공적으로 전송되었습니다. | |
| 404 | 지정된 주제를 찾을 수 없습니다. | |
| 422 | 레코드 목록이 유효하지 않습니다. |
4.3.18.4. 사용 링크 복사링크가 클립보드에 복사되었습니다!
-
application/vnd.kafka.json.v2+json -
application/vnd.kafka.binary.v2+json -
application/vnd.kafka.text.v2+json
4.3.18.5. 생성 링크 복사링크가 클립보드에 복사되었습니다!
-
application/vnd.kafka.v2+json
4.3.18.6. 태그 링크 복사링크가 클립보드에 복사되었습니다!
- 생산자
- 주제
4.3.18.7. HTTP 요청의 예 링크 복사링크가 클립보드에 복사되었습니다!
4.3.18.7.1. 요청 본문 링크 복사링크가 클립보드에 복사되었습니다!
{
"records" : [ {
"key" : "key1",
"value" : "value1"
}, {
"value" : "value2",
"partition" : 1
}, {
"value" : "value3"
} ]
}
4.3.18.8. HTTP 응답의 예 링크 복사링크가 클립보드에 복사되었습니다!
4.3.18.8.1. 응답 200 링크 복사링크가 클립보드에 복사되었습니다!
{
"offsets" : [ {
"partition" : 2,
"offset" : 0
}, {
"partition" : 1,
"offset" : 1
}, {
"partition" : 2,
"offset" : 2
} ]
}
4.3.18.8.2. 응답 404 링크 복사링크가 클립보드에 복사되었습니다!
{
"error_code" : 404,
"message" : "The specified topic was not found."
}
4.3.18.8.3. 응답 422 링크 복사링크가 클립보드에 복사되었습니다!
{
"error_code" : 422,
"message" : "The record list contains invalid records."
}
4.3.19. GET /topics/{topicname} 링크 복사링크가 클립보드에 복사되었습니다!
4.3.19.1. 설명 링크 복사링크가 클립보드에 복사되었습니다!
지정된 항목에 대한 메타데이터를 검색합니다.
4.3.19.2. 매개 변수 링크 복사링크가 클립보드에 복사되었습니다!
| 유형 | 이름 | 설명 | 스키마 |
|---|---|---|---|
| 경로 |
주제 이름 | 레코드를 보내거나 메타데이터에서 검색할 항목의 이름입니다. | string |
4.3.19.3. 응답 링크 복사링크가 클립보드에 복사되었습니다!
| HTTP 코드 | 설명 | 스키마 |
|---|---|---|
| 200 | 주제 메타데이터 |
4.3.19.4. 생성 링크 복사링크가 클립보드에 복사되었습니다!
-
application/vnd.kafka.v2+json
4.3.19.5. 태그 링크 복사링크가 클립보드에 복사되었습니다!
- 주제
4.3.19.6. HTTP 응답의 예 링크 복사링크가 클립보드에 복사되었습니다!
4.3.19.6.1. 응답 200 링크 복사링크가 클립보드에 복사되었습니다!
{
"name" : "topic",
"offset" : 2,
"configs" : {
"cleanup.policy" : "compact"
},
"partitions" : [ {
"partition" : 1,
"leader" : 1,
"replicas" : [ {
"broker" : 1,
"leader" : true,
"in_sync" : true
}, {
"broker" : 2,
"leader" : false,
"in_sync" : true
} ]
}, {
"partition" : 2,
"leader" : 2,
"replicas" : [ {
"broker" : 1,
"leader" : false,
"in_sync" : true
}, {
"broker" : 2,
"leader" : true,
"in_sync" : true
} ]
} ]
}
4.3.20. GET /topics/{topicname}/partitions 링크 복사링크가 클립보드에 복사되었습니다!
4.3.20.1. 설명 링크 복사링크가 클립보드에 복사되었습니다!
주제의 파티션 목록을 검색합니다.
4.3.20.2. 매개 변수 링크 복사링크가 클립보드에 복사되었습니다!
| 유형 | 이름 | 설명 | 스키마 |
|---|---|---|---|
| 경로 |
주제 이름 | 레코드를 보내거나 메타데이터에서 검색할 항목의 이름입니다. | string |
4.3.20.3. 응답 링크 복사링크가 클립보드에 복사되었습니다!
| HTTP 코드 | 설명 | 스키마 |
|---|---|---|
| 200 | 파티션 목록 | < PartitionMetadata > 배열 |
| 404 | 지정된 주제를 찾을 수 없습니다. |
4.3.20.4. 생성 링크 복사링크가 클립보드에 복사되었습니다!
-
application/vnd.kafka.v2+json
4.3.20.5. 태그 링크 복사링크가 클립보드에 복사되었습니다!
- 주제
4.3.20.6. HTTP 응답의 예 링크 복사링크가 클립보드에 복사되었습니다!
4.3.20.6.1. 응답 200 링크 복사링크가 클립보드에 복사되었습니다!
[ {
"partition" : 1,
"leader" : 1,
"replicas" : [ {
"broker" : 1,
"leader" : true,
"in_sync" : true
}, {
"broker" : 2,
"leader" : false,
"in_sync" : true
} ]
}, {
"partition" : 2,
"leader" : 2,
"replicas" : [ {
"broker" : 1,
"leader" : false,
"in_sync" : true
}, {
"broker" : 2,
"leader" : true,
"in_sync" : true
} ]
} ]
4.3.20.6.2. 응답 404 링크 복사링크가 클립보드에 복사되었습니다!
{
"error_code" : 404,
"message" : "The specified topic was not found."
}
4.3.21. POST /topics/{topicname}/partitions/{partitionid} 링크 복사링크가 클립보드에 복사되었습니다!
4.3.21.1. 설명 링크 복사링크가 클립보드에 복사되었습니다!
지정된 주제 파티션에 하나 이상의 레코드를 전송하고 선택적으로 키를 지정합니다.
4.3.21.2. 매개 변수 링크 복사링크가 클립보드에 복사되었습니다!
| 유형 | 이름 | 설명 | 스키마 |
|---|---|---|---|
| 경로 |
PartitionID | 레코드를 보내거나 메타데이터에서 검색할 파티션의 ID입니다. | integer |
| 경로 |
주제 이름 | 레코드를 보내거나 메타데이터에서 검색할 항목의 이름입니다. | string |
| 쿼리 |
Async | 메타데이터를 기다리는 대신 레코드를 전송할 때 즉시 반환할지 여부입니다. 지정된 경우 오프셋은 반환되지 않습니다. 기본값은 false입니다. | boolean |
| 본문 |
본문 | 값(필수) 및 키(선택 사항)를 포함하여 지정된 주제 파티션에 보낼 레코드 목록입니다. |
4.3.21.3. 응답 링크 복사링크가 클립보드에 복사되었습니다!
| HTTP 코드 | 설명 | 스키마 |
|---|---|---|
| 200 | 레코드가 성공적으로 전송되었습니다. | |
| 404 | 지정된 주제 파티션을 찾을 수 없습니다. | |
| 422 | 레코드가 유효하지 않습니다. |
4.3.21.4. 사용 링크 복사링크가 클립보드에 복사되었습니다!
-
application/vnd.kafka.json.v2+json -
application/vnd.kafka.binary.v2+json -
application/vnd.kafka.text.v2+json
4.3.21.5. 생성 링크 복사링크가 클립보드에 복사되었습니다!
-
application/vnd.kafka.v2+json
4.3.21.6. 태그 링크 복사링크가 클립보드에 복사되었습니다!
- 생산자
- 주제
4.3.21.7. HTTP 요청의 예 링크 복사링크가 클립보드에 복사되었습니다!
4.3.21.7.1. 요청 본문 링크 복사링크가 클립보드에 복사되었습니다!
{
"records" : [ {
"key" : "key1",
"value" : "value1"
}, {
"value" : "value2"
} ]
}
4.3.21.8. HTTP 응답의 예 링크 복사링크가 클립보드에 복사되었습니다!
4.3.21.8.1. 응답 200 링크 복사링크가 클립보드에 복사되었습니다!
{
"offsets" : [ {
"partition" : 2,
"offset" : 0
}, {
"partition" : 1,
"offset" : 1
}, {
"partition" : 2,
"offset" : 2
} ]
}
4.3.21.8.2. 응답 404 링크 복사링크가 클립보드에 복사되었습니다!
{
"error_code" : 404,
"message" : "The specified topic partition was not found."
}
4.3.21.8.3. 응답 422 링크 복사링크가 클립보드에 복사되었습니다!
{
"error_code" : 422,
"message" : "The record is not valid."
}
4.3.22. GET /topics/{topicname}/partitions/{partitionid} 링크 복사링크가 클립보드에 복사되었습니다!
4.3.22.1. 설명 링크 복사링크가 클립보드에 복사되었습니다!
주제 파티션의 파티션 메타데이터를 검색합니다.
4.3.22.2. 매개 변수 링크 복사링크가 클립보드에 복사되었습니다!
| 유형 | 이름 | 설명 | 스키마 |
|---|---|---|---|
| 경로 |
PartitionID | 레코드를 보내거나 메타데이터에서 검색할 파티션의 ID입니다. | integer |
| 경로 |
주제 이름 | 레코드를 보내거나 메타데이터에서 검색할 항목의 이름입니다. | string |
4.3.22.3. 응답 링크 복사링크가 클립보드에 복사되었습니다!
| HTTP 코드 | 설명 | 스키마 |
|---|---|---|
| 200 | 파티션 메타데이터 | |
| 404 | 지정된 주제 파티션을 찾을 수 없습니다. |
4.3.22.4. 생성 링크 복사링크가 클립보드에 복사되었습니다!
-
application/vnd.kafka.v2+json
4.3.22.5. 태그 링크 복사링크가 클립보드에 복사되었습니다!
- 주제
4.3.22.6. HTTP 응답의 예 링크 복사링크가 클립보드에 복사되었습니다!
4.3.22.6.1. 응답 200 링크 복사링크가 클립보드에 복사되었습니다!
{
"partition" : 1,
"leader" : 1,
"replicas" : [ {
"broker" : 1,
"leader" : true,
"in_sync" : true
}, {
"broker" : 2,
"leader" : false,
"in_sync" : true
} ]
}
4.3.22.6.2. 응답 404 링크 복사링크가 클립보드에 복사되었습니다!
{
"error_code" : 404,
"message" : "The specified topic partition was not found."
}
4.3.23. GET /topics/{topicname}/partitions/{partitionid}/offsets 링크 복사링크가 클립보드에 복사되었습니다!
4.3.23.1. 설명 링크 복사링크가 클립보드에 복사되었습니다!
주제 파티션에 대한 오프셋에 대한 요약을 검색합니다.
4.3.23.2. 매개 변수 링크 복사링크가 클립보드에 복사되었습니다!
| 유형 | 이름 | 설명 | 스키마 |
|---|---|---|---|
| 경로 |
PartitionID | 파티션의 ID입니다. | integer |
| 경로 |
주제 이름 | 파티션이 포함된 주제의 이름입니다. | string |
4.3.23.3. 응답 링크 복사링크가 클립보드에 복사되었습니다!
| HTTP 코드 | 설명 | 스키마 |
|---|---|---|
| 200 | 주제 파티션에 대한 오프셋에 대한 요약입니다. | |
| 404 | 지정된 주제 파티션을 찾을 수 없습니다. |
4.3.23.4. 생성 링크 복사링크가 클립보드에 복사되었습니다!
-
application/vnd.kafka.v2+json
4.3.23.5. 태그 링크 복사링크가 클립보드에 복사되었습니다!
- 주제
4.3.23.6. HTTP 응답의 예 링크 복사링크가 클립보드에 복사되었습니다!
4.3.23.6.1. 응답 200 링크 복사링크가 클립보드에 복사되었습니다!
{
"beginning_offset" : 10,
"end_offset" : 50
}
4.3.23.6.2. 응답 404 링크 복사링크가 클립보드에 복사되었습니다!
{
"error_code" : 404,
"message" : "The specified topic partition was not found."
}