Skip to content

Commit 97166b8

Browse files
committed
Add missing /cloud_storage/ endpoints
1 parent eecf277 commit 97166b8

File tree

1 file changed

+269
-3
lines changed

1 file changed

+269
-3
lines changed

admin/admin.yaml

Lines changed: 269 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2225,7 +2225,6 @@ paths:
22252225
200:
22262226
description: Topic scan and recovery started successfully
22272227
content: {}
2228-
x-codegen-request-body-name: body
22292228
/v1/cloud_storage/status/{topic}/{partition}:
22302229
get:
22312230
tags:
@@ -2329,7 +2328,150 @@ paths:
23292328
responses:
23302329
200:
23312330
description: Partition metadata is up to date
2332-
content: {}
2331+
content: {}
2332+
/v1/cloud_storage/automated_recovery:
2333+
post:
2334+
tags:
2335+
- Tiered Storage
2336+
summary: Initialize cluster recovery
2337+
description: Initializes a cluster recovery.
2338+
operationId: initialize_cluster_recovery
2339+
requestBody:
2340+
content:
2341+
application/json:
2342+
schema:
2343+
type: object
2344+
required: false
2345+
responses:
2346+
200:
2347+
description: Cluster recovery was initialized successfully
2348+
content: {}
2349+
get:
2350+
tags:
2351+
- Tiered Storage
2352+
summary: Get cluster recovery status
2353+
description: Get status of cluster recovery.
2354+
operationId: get_cluster_recovery
2355+
responses:
2356+
200:
2357+
description: Cluster recovery status response
2358+
content:
2359+
application/json:
2360+
schema:
2361+
$ref: '#/components/schemas/cluster_recovery_status'
2362+
/v1/cloud_storage/cache/trim:
2363+
post:
2364+
tags:
2365+
- Tiered Storage
2366+
summary: Trim tiered storage cache
2367+
description: Invoke trimming on the local cache of tiered storage objects. If no parameters are included, this endpoint by default trims the cache to the maximum cache size given by the cluster config. Use the `bytes` and `objects` parameters to specify the number of bytes and objects to retain in the cache.
2368+
operationId: cloud_storage_cache_trim
2369+
parameters:
2370+
- name: objects
2371+
in: query
2372+
required: false
2373+
schema:
2374+
type: integer
2375+
description: Target number of objects to retain in the cache
2376+
- name: bytes
2377+
in: query
2378+
required: false
2379+
schema:
2380+
type: integer
2381+
description: Target number of bytes to retain in the cache
2382+
responses:
2383+
200:
2384+
description: Success
2385+
content: {}
2386+
/v1/cloud_storage/anomalies/{namespace}/{topic}/{partition}:
2387+
get:
2388+
tags:
2389+
- Tiered Storage
2390+
summary: Get cloud storage anomalies for a partition
2391+
description: Retrieve cloud storage anomalies for a given partition.
2392+
operationId: get_cloud_storage_anomalies
2393+
parameters:
2394+
- name: namespace
2395+
in: path
2396+
required: true
2397+
schema:
2398+
type: string
2399+
- name: topic
2400+
in: path
2401+
required: true
2402+
schema:
2403+
type: string
2404+
- name: partition
2405+
in: path
2406+
required: true
2407+
schema:
2408+
type: integer
2409+
responses:
2410+
200:
2411+
description: Success
2412+
content:
2413+
application/json:
2414+
schema:
2415+
$ref: '#/components/schemas/cloud_storage_partition_anomalies'
2416+
/v1/cloud_storage/unsafe_reset_metadata_from_cloud/{namespace}/{topic}/{partition}:
2417+
post:
2418+
tags:
2419+
- Tiered Storage
2420+
summary: Reset metadata from cloud
2421+
description: Resets the manifest to the one in cloud storage, updating all replicas with the given manifest. The request is refused if applying the change would cause data loss and the force query parameter is unspecified or false.
2422+
operationId: unsafe_reset_metadata_from_cloud
2423+
parameters:
2424+
- name: namespace
2425+
in: path
2426+
required: true
2427+
schema:
2428+
type: string
2429+
- name: topic
2430+
in: path
2431+
required: true
2432+
schema:
2433+
type: string
2434+
- name: partition
2435+
in: path
2436+
required: true
2437+
schema:
2438+
type: integer
2439+
- name: force
2440+
in: query
2441+
required: false
2442+
schema:
2443+
type: boolean
2444+
responses:
2445+
200:
2446+
description: Partition metadata is reset
2447+
content: {}
2448+
/v1/cloud_storage/reset_scrubbing_metadata/{namespace}/{topic}/{partition}:
2449+
post:
2450+
tags:
2451+
- Tiered Storage
2452+
summary: Reset scrubbing metadata
2453+
description: Reset scrubbing related metadata and anomalies for given partition.
2454+
operationId: reset_scrubbing_metadata
2455+
parameters:
2456+
- name: namespace
2457+
in: path
2458+
required: true
2459+
schema:
2460+
type: string
2461+
- name: topic
2462+
in: path
2463+
required: true
2464+
schema:
2465+
type: string
2466+
- name: partition
2467+
in: path
2468+
required: true
2469+
schema:
2470+
type: integer
2471+
responses:
2472+
200:
2473+
description: Success
2474+
content: {}
23332475
components:
23342476
schemas:
23352477
broker_endpoint:
@@ -4859,16 +5001,32 @@ components:
48595001
cloud_log_size_bytes:
48605002
type: integer
48615003
description: Total size of the addressable cloud log for the partition
5004+
stm_region_size_bytes:
5005+
type: integer
5006+
description: Total size of the addressable segments in the STM region of the log
5007+
archive_size_bytes:
5008+
type: integer
5009+
description: Total size of the archive region of the log
48625010
local_log_size_bytes:
48635011
type: integer
48645012
description: Total size of the addressable local log for the partition
5013+
stm_region_segment_count:
5014+
type: integer
5015+
description: Number of segments in the STM region of the cloud log
48655016
cloud_log_segment_count:
5017+
type: integer
5018+
description: Number of segments in the STM region of the cloud log
5019+
local_log_segment_count:
48665020
type: integer
48675021
description: Number of segments in the local log
48685022
cloud_log_start_offset:
48695023
type: integer
48705024
nullable: true
48715025
description: The first Kafka offset accessible from the cloud (inclusive)
5026+
stm_region_start_offset:
5027+
type: integer
5028+
nullable: true
5029+
description: The first Kafka offset accessible from the cloud in the STM region (inclusive)
48725030
cloud_log_last_offset:
48735031
type: integer
48745032
nullable: true
@@ -4899,7 +5057,108 @@ components:
48995057
markers:
49005058
type: array
49015059
items:
4902-
$ref: '#/components/schemas/lifecycle_marker'
5060+
$ref: '#/components/schemas/lifecycle_marker'
5061+
segment_meta:
5062+
type: object
5063+
description: Metadata for an uploaded segment
5064+
properties:
5065+
base_offset:
5066+
type: integer
5067+
format: int64
5068+
committed_offset:
5069+
type: integer
5070+
format: int64
5071+
delta_offset:
5072+
type: integer
5073+
format: int64
5074+
nullable: true
5075+
delta_offset_end:
5076+
type: integer
5077+
format: int64
5078+
nullable: true
5079+
base_timestamp:
5080+
type: integer
5081+
format: int64
5082+
max_timestamp:
5083+
type: integer
5084+
format: int64
5085+
size_bytes:
5086+
type: integer
5087+
format: int64
5088+
is_compacted:
5089+
type: boolean
5090+
archiver_term:
5091+
type: integer
5092+
format: int64
5093+
segment_term:
5094+
type: integer
5095+
format: int64
5096+
ntp_revision:
5097+
type: integer
5098+
format: int64
5099+
metadata_anomaly:
5100+
type: object
5101+
description: Description of a metadata anomaly
5102+
properties:
5103+
type:
5104+
type: string
5105+
explanation:
5106+
type: string
5107+
at_segment:
5108+
$ref: '#/components/schemas/segment_meta'
5109+
previous_segment:
5110+
type: object
5111+
nullable: true
5112+
allOf:
5113+
- $ref: '#/components/schemas/segment_meta'
5114+
cloud_storage_partition_anomalies:
5115+
type: object
5116+
description: Anomalies detected by the cloud storage scrubber
5117+
properties:
5118+
ns:
5119+
type: string
5120+
topic:
5121+
type: string
5122+
partition:
5123+
type: integer
5124+
format: int64
5125+
revision_id:
5126+
type: integer
5127+
format: int64
5128+
missing_partition_manifest:
5129+
type: boolean
5130+
nullable: true
5131+
missing_spillover_manifests:
5132+
type: array
5133+
nullable: true
5134+
items:
5135+
type: string
5136+
missing_segments:
5137+
type: array
5138+
nullable: true
5139+
items:
5140+
type: string
5141+
segment_metadata_anomalies:
5142+
type: array
5143+
nullable: true
5144+
items:
5145+
$ref: '#/components/schemas/metadata_anomaly'
5146+
last_complete_scrub_at:
5147+
type: integer
5148+
format: int64
5149+
nullable: true
5150+
num_discarded_missing_spillover_manifests:
5151+
type: integer
5152+
format: int64
5153+
nullable: true
5154+
num_discarded_missing_segments:
5155+
type: integer
5156+
format: int64
5157+
nullable: true
5158+
num_discarded_metadata_anomalies:
5159+
type: integer
5160+
format: int64
5161+
nullable: true
49035162
cluster_config_property_metadata:
49045163
type: object
49055164
properties:
@@ -5828,6 +6087,13 @@ components:
58286087
type: array
58296088
items:
58306089
$ref: '#/components/schemas/topic_download_counts'
6090+
cluster_recovery_status:
6091+
type: object
6092+
properties:
6093+
state:
6094+
type: string
6095+
error:
6096+
type: string
58316097
cancel_all_partitions_reconfigurations:
58326098
type: object
58336099
description: TBD

0 commit comments

Comments
 (0)