API reference
List segments
List log segments whose start sequence falls within the given range. Segments are the physical storage units of the log.
GET
/
api
/
v1
/
log
/
segments
List segments
curl --request GET \
--url http://localhost:3001/api/v1/log/segmentsimport requests
url = "http://localhost:3001/api/v1/log/segments"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('http://localhost:3001/api/v1/log/segments', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "3001",
CURLOPT_URL => "http://localhost:3001/api/v1/log/segments",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "http://localhost:3001/api/v1/log/segments"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("http://localhost:3001/api/v1/log/segments")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3001/api/v1/log/segments")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"status": "success",
"segments": [
{
"id": 0,
"startSeq": 0,
"startTimeMs": 1705766400000
}
]
}{
"status": "error",
"message": "<string>"
}Query Parameters
Start sequence number (inclusive). Defaults to 0.
Required range:
x >= 0End sequence number (exclusive). Defaults to max uint64.
Required range:
x >= 0⌘I
List segments
curl --request GET \
--url http://localhost:3001/api/v1/log/segmentsimport requests
url = "http://localhost:3001/api/v1/log/segments"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('http://localhost:3001/api/v1/log/segments', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "3001",
CURLOPT_URL => "http://localhost:3001/api/v1/log/segments",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "http://localhost:3001/api/v1/log/segments"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("http://localhost:3001/api/v1/log/segments")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3001/api/v1/log/segments")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"status": "success",
"segments": [
{
"id": 0,
"startSeq": 0,
"startTimeMs": 1705766400000
}
]
}{
"status": "error",
"message": "<string>"
}