Line data Source code
1 : use std::collections::HashMap;
2 : use std::error::Error as _;
3 :
4 : use bytes::Bytes;
5 : use detach_ancestor::AncestorDetached;
6 : use http_utils::error::HttpErrorBody;
7 : use pageserver_api::models::*;
8 : use pageserver_api::shard::TenantShardId;
9 : pub use reqwest::Body as ReqwestBody;
10 : use reqwest::{IntoUrl, Method, StatusCode, Url};
11 : use utils::id::{TenantId, TimelineId};
12 : use utils::lsn::Lsn;
13 :
14 : use crate::BlockUnblock;
15 :
16 : pub mod util;
17 :
18 : #[derive(Debug, Clone)]
19 : pub struct Client {
20 : mgmt_api_endpoint: String,
21 : authorization_header: Option<String>,
22 : client: reqwest::Client,
23 : }
24 :
25 : #[derive(thiserror::Error, Debug)]
26 : pub enum Error {
27 0 : #[error("send request: {0}{}", .0.source().map(|e| format!(": {e}")).unwrap_or_default())]
28 : SendRequest(reqwest::Error),
29 :
30 0 : #[error("receive body: {0}{}", .0.source().map(|e| format!(": {e}")).unwrap_or_default())]
31 : ReceiveBody(reqwest::Error),
32 :
33 : #[error("receive error body: {0}")]
34 : ReceiveErrorBody(String),
35 :
36 : #[error("pageserver API: {1}")]
37 : ApiError(StatusCode, String),
38 :
39 : #[error("Cancelled")]
40 : Cancelled,
41 :
42 : #[error("request timed out: {0}")]
43 : Timeout(String),
44 : }
45 :
46 : pub type Result<T> = std::result::Result<T, Error>;
47 :
48 : pub trait ResponseErrorMessageExt: Sized {
49 : fn error_from_body(self) -> impl std::future::Future<Output = Result<Self>> + Send;
50 : }
51 :
52 : impl ResponseErrorMessageExt for reqwest::Response {
53 0 : async fn error_from_body(self) -> Result<Self> {
54 0 : let status = self.status();
55 0 : if !(status.is_client_error() || status.is_server_error()) {
56 0 : return Ok(self);
57 0 : }
58 0 :
59 0 : let url = self.url().to_owned();
60 0 : Err(match self.json::<HttpErrorBody>().await {
61 0 : Ok(HttpErrorBody { msg }) => Error::ApiError(status, msg),
62 : Err(_) => {
63 0 : Error::ReceiveErrorBody(format!("Http error ({}) at {}.", status.as_u16(), url))
64 : }
65 : })
66 0 : }
67 : }
68 :
69 : pub enum ForceAwaitLogicalSize {
70 : Yes,
71 : No,
72 : }
73 :
74 : impl Client {
75 0 : pub fn new(client: reqwest::Client, mgmt_api_endpoint: String, jwt: Option<&str>) -> Self {
76 0 : Self {
77 0 : mgmt_api_endpoint,
78 0 : authorization_header: jwt.map(|jwt| format!("Bearer {jwt}")),
79 0 : client,
80 0 : }
81 0 : }
82 :
83 0 : pub async fn list_tenants(&self) -> Result<Vec<pageserver_api::models::TenantInfo>> {
84 0 : let uri = format!("{}/v1/tenant", self.mgmt_api_endpoint);
85 0 : let resp = self.get(&uri).await?;
86 0 : resp.json().await.map_err(Error::ReceiveBody)
87 0 : }
88 :
89 : /// Get an arbitrary path and returning a streaming Response. This function is suitable
90 : /// for pass-through/proxy use cases where we don't care what the response content looks
91 : /// like.
92 : ///
93 : /// Use/add one of the properly typed methods below if you know aren't proxying, and
94 : /// know what kind of response you expect.
95 0 : pub async fn get_raw(&self, path: String) -> Result<reqwest::Response> {
96 0 : debug_assert!(path.starts_with('/'));
97 0 : let uri = format!("{}{}", self.mgmt_api_endpoint, path);
98 0 :
99 0 : let mut req = self.client.request(Method::GET, uri);
100 0 : if let Some(value) = &self.authorization_header {
101 0 : req = req.header(reqwest::header::AUTHORIZATION, value);
102 0 : }
103 0 : req.send().await.map_err(Error::ReceiveBody)
104 0 : }
105 :
106 0 : pub async fn tenant_details(
107 0 : &self,
108 0 : tenant_shard_id: TenantShardId,
109 0 : ) -> Result<pageserver_api::models::TenantDetails> {
110 0 : let uri = format!("{}/v1/tenant/{tenant_shard_id}", self.mgmt_api_endpoint);
111 0 : self.get(uri)
112 0 : .await?
113 0 : .json()
114 0 : .await
115 0 : .map_err(Error::ReceiveBody)
116 0 : }
117 :
118 0 : pub async fn list_timelines(
119 0 : &self,
120 0 : tenant_shard_id: TenantShardId,
121 0 : ) -> Result<Vec<pageserver_api::models::TimelineInfo>> {
122 0 : let uri = format!(
123 0 : "{}/v1/tenant/{tenant_shard_id}/timeline",
124 0 : self.mgmt_api_endpoint
125 0 : );
126 0 : self.get(&uri)
127 0 : .await?
128 0 : .json()
129 0 : .await
130 0 : .map_err(Error::ReceiveBody)
131 0 : }
132 :
133 0 : pub async fn timeline_info(
134 0 : &self,
135 0 : tenant_shard_id: TenantShardId,
136 0 : timeline_id: TimelineId,
137 0 : force_await_logical_size: ForceAwaitLogicalSize,
138 0 : ) -> Result<pageserver_api::models::TimelineInfo> {
139 0 : let uri = format!(
140 0 : "{}/v1/tenant/{tenant_shard_id}/timeline/{timeline_id}",
141 0 : self.mgmt_api_endpoint
142 0 : );
143 :
144 0 : let uri = match force_await_logical_size {
145 0 : ForceAwaitLogicalSize::Yes => format!("{}?force-await-logical-size={}", uri, true),
146 0 : ForceAwaitLogicalSize::No => uri,
147 : };
148 :
149 0 : self.get(&uri)
150 0 : .await?
151 0 : .json()
152 0 : .await
153 0 : .map_err(Error::ReceiveBody)
154 0 : }
155 :
156 0 : pub async fn keyspace(
157 0 : &self,
158 0 : tenant_shard_id: TenantShardId,
159 0 : timeline_id: TimelineId,
160 0 : ) -> Result<pageserver_api::models::partitioning::Partitioning> {
161 0 : let uri = format!(
162 0 : "{}/v1/tenant/{tenant_shard_id}/timeline/{timeline_id}/keyspace",
163 0 : self.mgmt_api_endpoint
164 0 : );
165 0 : self.get(&uri)
166 0 : .await?
167 0 : .json()
168 0 : .await
169 0 : .map_err(Error::ReceiveBody)
170 0 : }
171 :
172 0 : async fn get<U: IntoUrl>(&self, uri: U) -> Result<reqwest::Response> {
173 0 : self.request(Method::GET, uri, ()).await
174 0 : }
175 :
176 0 : fn start_request<U: reqwest::IntoUrl>(
177 0 : &self,
178 0 : method: Method,
179 0 : uri: U,
180 0 : ) -> reqwest::RequestBuilder {
181 0 : let req = self.client.request(method, uri);
182 0 : if let Some(value) = &self.authorization_header {
183 0 : req.header(reqwest::header::AUTHORIZATION, value)
184 : } else {
185 0 : req
186 : }
187 0 : }
188 :
189 0 : async fn request_noerror<B: serde::Serialize, U: reqwest::IntoUrl>(
190 0 : &self,
191 0 : method: Method,
192 0 : uri: U,
193 0 : body: B,
194 0 : ) -> Result<reqwest::Response> {
195 0 : self.start_request(method, uri)
196 0 : .json(&body)
197 0 : .send()
198 0 : .await
199 0 : .map_err(Error::ReceiveBody)
200 0 : }
201 :
202 0 : async fn request<B: serde::Serialize, U: reqwest::IntoUrl>(
203 0 : &self,
204 0 : method: Method,
205 0 : uri: U,
206 0 : body: B,
207 0 : ) -> Result<reqwest::Response> {
208 0 : let res = self.request_noerror(method, uri, body).await?;
209 0 : let response = res.error_from_body().await?;
210 0 : Ok(response)
211 0 : }
212 :
213 0 : pub async fn status(&self) -> Result<()> {
214 0 : let uri = format!("{}/v1/status", self.mgmt_api_endpoint);
215 0 : self.get(&uri).await?;
216 0 : Ok(())
217 0 : }
218 :
219 : /// The tenant deletion API can return 202 if deletion is incomplete, or
220 : /// 404 if it is complete. Callers are responsible for checking the status
221 : /// code and retrying. Error codes other than 404 will return Err().
222 0 : pub async fn tenant_delete(&self, tenant_shard_id: TenantShardId) -> Result<StatusCode> {
223 0 : let uri = format!("{}/v1/tenant/{tenant_shard_id}", self.mgmt_api_endpoint);
224 0 :
225 0 : match self.request(Method::DELETE, &uri, ()).await {
226 0 : Err(Error::ApiError(status_code, msg)) => {
227 0 : if status_code == StatusCode::NOT_FOUND {
228 0 : Ok(StatusCode::NOT_FOUND)
229 : } else {
230 0 : Err(Error::ApiError(status_code, msg))
231 : }
232 : }
233 0 : Err(e) => Err(e),
234 0 : Ok(response) => Ok(response.status()),
235 : }
236 0 : }
237 :
238 0 : pub async fn tenant_time_travel_remote_storage(
239 0 : &self,
240 0 : tenant_shard_id: TenantShardId,
241 0 : timestamp: &str,
242 0 : done_if_after: &str,
243 0 : ) -> Result<()> {
244 0 : let uri = format!(
245 0 : "{}/v1/tenant/{tenant_shard_id}/time_travel_remote_storage?travel_to={timestamp}&done_if_after={done_if_after}",
246 0 : self.mgmt_api_endpoint
247 0 : );
248 0 : self.request(Method::PUT, &uri, ()).await?;
249 0 : Ok(())
250 0 : }
251 :
252 0 : pub async fn tenant_scan_remote_storage(
253 0 : &self,
254 0 : tenant_id: TenantId,
255 0 : ) -> Result<TenantScanRemoteStorageResponse> {
256 0 : let uri = format!(
257 0 : "{}/v1/tenant/{tenant_id}/scan_remote_storage",
258 0 : self.mgmt_api_endpoint
259 0 : );
260 0 : let response = self.request(Method::GET, &uri, ()).await?;
261 0 : let body = response.json().await.map_err(Error::ReceiveBody)?;
262 0 : Ok(body)
263 0 : }
264 :
265 0 : pub async fn set_tenant_config(&self, req: &TenantConfigRequest) -> Result<()> {
266 0 : let uri = format!("{}/v1/tenant/config", self.mgmt_api_endpoint);
267 0 : self.request(Method::PUT, &uri, req).await?;
268 0 : Ok(())
269 0 : }
270 :
271 0 : pub async fn patch_tenant_config(&self, req: &TenantConfigPatchRequest) -> Result<()> {
272 0 : let uri = format!("{}/v1/tenant/config", self.mgmt_api_endpoint);
273 0 : self.request(Method::PATCH, &uri, req).await?;
274 0 : Ok(())
275 0 : }
276 :
277 0 : pub async fn tenant_secondary_download(
278 0 : &self,
279 0 : tenant_id: TenantShardId,
280 0 : wait: Option<std::time::Duration>,
281 0 : ) -> Result<(StatusCode, SecondaryProgress)> {
282 0 : let mut path = reqwest::Url::parse(&format!(
283 0 : "{}/v1/tenant/{}/secondary/download",
284 0 : self.mgmt_api_endpoint, tenant_id
285 0 : ))
286 0 : .expect("Cannot build URL");
287 :
288 0 : if let Some(wait) = wait {
289 0 : path.query_pairs_mut()
290 0 : .append_pair("wait_ms", &format!("{}", wait.as_millis()));
291 0 : }
292 :
293 0 : let response = self.request(Method::POST, path, ()).await?;
294 0 : let status = response.status();
295 0 : let progress: SecondaryProgress = response.json().await.map_err(Error::ReceiveBody)?;
296 0 : Ok((status, progress))
297 0 : }
298 :
299 0 : pub async fn tenant_secondary_status(
300 0 : &self,
301 0 : tenant_shard_id: TenantShardId,
302 0 : ) -> Result<SecondaryProgress> {
303 0 : let path = reqwest::Url::parse(&format!(
304 0 : "{}/v1/tenant/{}/secondary/status",
305 0 : self.mgmt_api_endpoint, tenant_shard_id
306 0 : ))
307 0 : .expect("Cannot build URL");
308 0 :
309 0 : self.request(Method::GET, path, ())
310 0 : .await?
311 0 : .json()
312 0 : .await
313 0 : .map_err(Error::ReceiveBody)
314 0 : }
315 :
316 0 : pub async fn tenant_heatmap_upload(&self, tenant_id: TenantShardId) -> Result<()> {
317 0 : let path = reqwest::Url::parse(&format!(
318 0 : "{}/v1/tenant/{}/heatmap_upload",
319 0 : self.mgmt_api_endpoint, tenant_id
320 0 : ))
321 0 : .expect("Cannot build URL");
322 0 :
323 0 : self.request(Method::POST, path, ()).await?;
324 0 : Ok(())
325 0 : }
326 :
327 0 : pub async fn location_config(
328 0 : &self,
329 0 : tenant_shard_id: TenantShardId,
330 0 : config: LocationConfig,
331 0 : flush_ms: Option<std::time::Duration>,
332 0 : lazy: bool,
333 0 : ) -> Result<()> {
334 0 : let req_body = TenantLocationConfigRequest { config };
335 0 :
336 0 : let mut path = reqwest::Url::parse(&format!(
337 0 : "{}/v1/tenant/{}/location_config",
338 0 : self.mgmt_api_endpoint, tenant_shard_id
339 0 : ))
340 0 : // Should always work: mgmt_api_endpoint is configuration, not user input.
341 0 : .expect("Cannot build URL");
342 0 :
343 0 : if lazy {
344 0 : path.query_pairs_mut().append_pair("lazy", "true");
345 0 : }
346 :
347 0 : if let Some(flush_ms) = flush_ms {
348 0 : path.query_pairs_mut()
349 0 : .append_pair("flush_ms", &format!("{}", flush_ms.as_millis()));
350 0 : }
351 :
352 0 : self.request(Method::PUT, path, &req_body).await?;
353 0 : Ok(())
354 0 : }
355 :
356 0 : pub async fn list_location_config(&self) -> Result<LocationConfigListResponse> {
357 0 : let path = format!("{}/v1/location_config", self.mgmt_api_endpoint);
358 0 : self.request(Method::GET, &path, ())
359 0 : .await?
360 0 : .json()
361 0 : .await
362 0 : .map_err(Error::ReceiveBody)
363 0 : }
364 :
365 0 : pub async fn get_location_config(
366 0 : &self,
367 0 : tenant_shard_id: TenantShardId,
368 0 : ) -> Result<Option<LocationConfig>> {
369 0 : let path = format!(
370 0 : "{}/v1/location_config/{tenant_shard_id}",
371 0 : self.mgmt_api_endpoint
372 0 : );
373 0 : self.request(Method::GET, &path, ())
374 0 : .await?
375 0 : .json()
376 0 : .await
377 0 : .map_err(Error::ReceiveBody)
378 0 : }
379 :
380 0 : pub async fn timeline_create(
381 0 : &self,
382 0 : tenant_shard_id: TenantShardId,
383 0 : req: &TimelineCreateRequest,
384 0 : ) -> Result<TimelineInfo> {
385 0 : let uri = format!(
386 0 : "{}/v1/tenant/{}/timeline",
387 0 : self.mgmt_api_endpoint, tenant_shard_id
388 0 : );
389 0 : self.request(Method::POST, &uri, req)
390 0 : .await?
391 0 : .json()
392 0 : .await
393 0 : .map_err(Error::ReceiveBody)
394 0 : }
395 :
396 : /// The timeline deletion API can return 201 if deletion is incomplete, or
397 : /// 403 if it is complete. Callers are responsible for checking the status
398 : /// code and retrying. Error codes other than 403 will return Err().
399 0 : pub async fn timeline_delete(
400 0 : &self,
401 0 : tenant_shard_id: TenantShardId,
402 0 : timeline_id: TimelineId,
403 0 : ) -> Result<StatusCode> {
404 0 : let uri = format!(
405 0 : "{}/v1/tenant/{tenant_shard_id}/timeline/{timeline_id}",
406 0 : self.mgmt_api_endpoint
407 0 : );
408 0 :
409 0 : match self.request(Method::DELETE, &uri, ()).await {
410 0 : Err(Error::ApiError(status_code, msg)) => {
411 0 : if status_code == StatusCode::NOT_FOUND {
412 0 : Ok(StatusCode::NOT_FOUND)
413 : } else {
414 0 : Err(Error::ApiError(status_code, msg))
415 : }
416 : }
417 0 : Err(e) => Err(e),
418 0 : Ok(response) => Ok(response.status()),
419 : }
420 0 : }
421 :
422 0 : pub async fn timeline_archival_config(
423 0 : &self,
424 0 : tenant_shard_id: TenantShardId,
425 0 : timeline_id: TimelineId,
426 0 : req: &TimelineArchivalConfigRequest,
427 0 : ) -> Result<()> {
428 0 : let uri = format!(
429 0 : "{}/v1/tenant/{tenant_shard_id}/timeline/{timeline_id}/archival_config",
430 0 : self.mgmt_api_endpoint
431 0 : );
432 0 :
433 0 : self.request(Method::PUT, &uri, req)
434 0 : .await?
435 0 : .json()
436 0 : .await
437 0 : .map_err(Error::ReceiveBody)
438 0 : }
439 :
440 0 : pub async fn timeline_detach_ancestor(
441 0 : &self,
442 0 : tenant_shard_id: TenantShardId,
443 0 : timeline_id: TimelineId,
444 0 : behavior: Option<DetachBehavior>,
445 0 : ) -> Result<AncestorDetached> {
446 0 : let uri = format!(
447 0 : "{}/v1/tenant/{tenant_shard_id}/timeline/{timeline_id}/detach_ancestor",
448 0 : self.mgmt_api_endpoint
449 0 : );
450 0 : let mut uri = Url::parse(&uri)
451 0 : .map_err(|e| Error::ApiError(StatusCode::INTERNAL_SERVER_ERROR, format!("{e}")))?;
452 :
453 0 : if let Some(behavior) = behavior {
454 0 : uri.query_pairs_mut()
455 0 : .append_pair("detach_behavior", &behavior.to_string());
456 0 : }
457 :
458 0 : self.request(Method::PUT, uri, ())
459 0 : .await?
460 0 : .json()
461 0 : .await
462 0 : .map_err(Error::ReceiveBody)
463 0 : }
464 :
465 0 : pub async fn timeline_block_unblock_gc(
466 0 : &self,
467 0 : tenant_shard_id: TenantShardId,
468 0 : timeline_id: TimelineId,
469 0 : dir: BlockUnblock,
470 0 : ) -> Result<()> {
471 0 : let uri = format!(
472 0 : "{}/v1/tenant/{tenant_shard_id}/timeline/{timeline_id}/{dir}_gc",
473 0 : self.mgmt_api_endpoint,
474 0 : );
475 0 :
476 0 : self.request(Method::POST, &uri, ()).await.map(|_| ())
477 0 : }
478 :
479 0 : pub async fn timeline_download_heatmap_layers(
480 0 : &self,
481 0 : tenant_shard_id: TenantShardId,
482 0 : timeline_id: TimelineId,
483 0 : concurrency: Option<usize>,
484 0 : recurse: bool,
485 0 : ) -> Result<()> {
486 0 : let mut path = reqwest::Url::parse(&format!(
487 0 : "{}/v1/tenant/{}/timeline/{}/download_heatmap_layers",
488 0 : self.mgmt_api_endpoint, tenant_shard_id, timeline_id
489 0 : ))
490 0 : .expect("Cannot build URL");
491 0 :
492 0 : path.query_pairs_mut()
493 0 : .append_pair("recurse", &format!("{}", recurse));
494 :
495 0 : if let Some(concurrency) = concurrency {
496 0 : path.query_pairs_mut()
497 0 : .append_pair("concurrency", &format!("{}", concurrency));
498 0 : }
499 :
500 0 : self.request(Method::POST, path, ()).await.map(|_| ())
501 0 : }
502 :
503 0 : pub async fn tenant_reset(&self, tenant_shard_id: TenantShardId) -> Result<()> {
504 0 : let uri = format!(
505 0 : "{}/v1/tenant/{}/reset",
506 0 : self.mgmt_api_endpoint, tenant_shard_id
507 0 : );
508 0 : self.request(Method::POST, &uri, ())
509 0 : .await?
510 0 : .json()
511 0 : .await
512 0 : .map_err(Error::ReceiveBody)
513 0 : }
514 :
515 0 : pub async fn tenant_shard_split(
516 0 : &self,
517 0 : tenant_shard_id: TenantShardId,
518 0 : req: TenantShardSplitRequest,
519 0 : ) -> Result<TenantShardSplitResponse> {
520 0 : let uri = format!(
521 0 : "{}/v1/tenant/{}/shard_split",
522 0 : self.mgmt_api_endpoint, tenant_shard_id
523 0 : );
524 0 : self.request(Method::PUT, &uri, req)
525 0 : .await?
526 0 : .json()
527 0 : .await
528 0 : .map_err(Error::ReceiveBody)
529 0 : }
530 :
531 0 : pub async fn timeline_list(
532 0 : &self,
533 0 : tenant_shard_id: &TenantShardId,
534 0 : ) -> Result<Vec<TimelineInfo>> {
535 0 : let uri = format!(
536 0 : "{}/v1/tenant/{}/timeline",
537 0 : self.mgmt_api_endpoint, tenant_shard_id
538 0 : );
539 0 : self.get(&uri)
540 0 : .await?
541 0 : .json()
542 0 : .await
543 0 : .map_err(Error::ReceiveBody)
544 0 : }
545 :
546 0 : pub async fn tenant_synthetic_size(
547 0 : &self,
548 0 : tenant_shard_id: TenantShardId,
549 0 : ) -> Result<TenantHistorySize> {
550 0 : let uri = format!(
551 0 : "{}/v1/tenant/{}/synthetic_size",
552 0 : self.mgmt_api_endpoint, tenant_shard_id
553 0 : );
554 0 : self.get(&uri)
555 0 : .await?
556 0 : .json()
557 0 : .await
558 0 : .map_err(Error::ReceiveBody)
559 0 : }
560 :
561 0 : pub async fn put_io_engine(
562 0 : &self,
563 0 : engine: &pageserver_api::models::virtual_file::IoEngineKind,
564 0 : ) -> Result<()> {
565 0 : let uri = format!("{}/v1/io_engine", self.mgmt_api_endpoint);
566 0 : self.request(Method::PUT, uri, engine)
567 0 : .await?
568 0 : .json()
569 0 : .await
570 0 : .map_err(Error::ReceiveBody)
571 0 : }
572 :
573 : /// Configs io mode at runtime.
574 0 : pub async fn put_io_mode(
575 0 : &self,
576 0 : mode: &pageserver_api::models::virtual_file::IoMode,
577 0 : ) -> Result<()> {
578 0 : let uri = format!("{}/v1/io_mode", self.mgmt_api_endpoint);
579 0 : self.request(Method::PUT, uri, mode)
580 0 : .await?
581 0 : .json()
582 0 : .await
583 0 : .map_err(Error::ReceiveBody)
584 0 : }
585 :
586 0 : pub async fn get_utilization(&self) -> Result<PageserverUtilization> {
587 0 : let uri = format!("{}/v1/utilization", self.mgmt_api_endpoint);
588 0 : self.get(uri)
589 0 : .await?
590 0 : .json()
591 0 : .await
592 0 : .map_err(Error::ReceiveBody)
593 0 : }
594 :
595 0 : pub async fn top_tenant_shards(
596 0 : &self,
597 0 : request: TopTenantShardsRequest,
598 0 : ) -> Result<TopTenantShardsResponse> {
599 0 : let uri = format!("{}/v1/top_tenants", self.mgmt_api_endpoint);
600 0 : self.request(Method::POST, uri, request)
601 0 : .await?
602 0 : .json()
603 0 : .await
604 0 : .map_err(Error::ReceiveBody)
605 0 : }
606 :
607 0 : pub async fn layer_map_info(
608 0 : &self,
609 0 : tenant_shard_id: TenantShardId,
610 0 : timeline_id: TimelineId,
611 0 : ) -> Result<LayerMapInfo> {
612 0 : let uri = format!(
613 0 : "{}/v1/tenant/{}/timeline/{}/layer",
614 0 : self.mgmt_api_endpoint, tenant_shard_id, timeline_id,
615 0 : );
616 0 : self.get(&uri)
617 0 : .await?
618 0 : .json()
619 0 : .await
620 0 : .map_err(Error::ReceiveBody)
621 0 : }
622 :
623 0 : pub async fn layer_evict(
624 0 : &self,
625 0 : tenant_shard_id: TenantShardId,
626 0 : timeline_id: TimelineId,
627 0 : layer_file_name: &str,
628 0 : ) -> Result<bool> {
629 0 : let uri = format!(
630 0 : "{}/v1/tenant/{}/timeline/{}/layer/{}",
631 0 : self.mgmt_api_endpoint, tenant_shard_id, timeline_id, layer_file_name
632 0 : );
633 0 : let resp = self.request_noerror(Method::DELETE, &uri, ()).await?;
634 0 : match resp.status() {
635 0 : StatusCode::OK => Ok(true),
636 0 : StatusCode::NOT_MODIFIED => Ok(false),
637 : // TODO: dedupe this pattern / introduce separate error variant?
638 0 : status => Err(match resp.json::<HttpErrorBody>().await {
639 0 : Ok(HttpErrorBody { msg }) => Error::ApiError(status, msg),
640 : Err(_) => {
641 0 : Error::ReceiveErrorBody(format!("Http error ({}) at {}.", status.as_u16(), uri))
642 : }
643 : }),
644 : }
645 0 : }
646 :
647 0 : pub async fn layer_ondemand_download(
648 0 : &self,
649 0 : tenant_shard_id: TenantShardId,
650 0 : timeline_id: TimelineId,
651 0 : layer_file_name: &str,
652 0 : ) -> Result<bool> {
653 0 : let uri = format!(
654 0 : "{}/v1/tenant/{}/timeline/{}/layer/{}",
655 0 : self.mgmt_api_endpoint, tenant_shard_id, timeline_id, layer_file_name
656 0 : );
657 0 : let resp = self.request_noerror(Method::GET, &uri, ()).await?;
658 0 : match resp.status() {
659 0 : StatusCode::OK => Ok(true),
660 0 : StatusCode::NOT_MODIFIED => Ok(false),
661 : // TODO: dedupe this pattern / introduce separate error variant?
662 0 : status => Err(match resp.json::<HttpErrorBody>().await {
663 0 : Ok(HttpErrorBody { msg }) => Error::ApiError(status, msg),
664 : Err(_) => {
665 0 : Error::ReceiveErrorBody(format!("Http error ({}) at {}.", status.as_u16(), uri))
666 : }
667 : }),
668 : }
669 0 : }
670 :
671 0 : pub async fn ingest_aux_files(
672 0 : &self,
673 0 : tenant_shard_id: TenantShardId,
674 0 : timeline_id: TimelineId,
675 0 : aux_files: HashMap<String, String>,
676 0 : ) -> Result<bool> {
677 0 : let uri = format!(
678 0 : "{}/v1/tenant/{}/timeline/{}/ingest_aux_files",
679 0 : self.mgmt_api_endpoint, tenant_shard_id, timeline_id
680 0 : );
681 0 : let resp = self
682 0 : .request_noerror(Method::POST, &uri, IngestAuxFilesRequest { aux_files })
683 0 : .await?;
684 0 : match resp.status() {
685 0 : StatusCode::OK => Ok(true),
686 0 : status => Err(match resp.json::<HttpErrorBody>().await {
687 0 : Ok(HttpErrorBody { msg }) => Error::ApiError(status, msg),
688 : Err(_) => {
689 0 : Error::ReceiveErrorBody(format!("Http error ({}) at {}.", status.as_u16(), uri))
690 : }
691 : }),
692 : }
693 0 : }
694 :
695 0 : pub async fn list_aux_files(
696 0 : &self,
697 0 : tenant_shard_id: TenantShardId,
698 0 : timeline_id: TimelineId,
699 0 : lsn: Lsn,
700 0 : ) -> Result<HashMap<String, Bytes>> {
701 0 : let uri = format!(
702 0 : "{}/v1/tenant/{}/timeline/{}/list_aux_files",
703 0 : self.mgmt_api_endpoint, tenant_shard_id, timeline_id
704 0 : );
705 0 : let resp = self
706 0 : .request_noerror(Method::POST, &uri, ListAuxFilesRequest { lsn })
707 0 : .await?;
708 0 : match resp.status() {
709 : StatusCode::OK => {
710 0 : let resp: HashMap<String, Bytes> = resp.json().await.map_err(|e| {
711 0 : Error::ApiError(StatusCode::INTERNAL_SERVER_ERROR, format!("{e}"))
712 0 : })?;
713 0 : Ok(resp)
714 : }
715 0 : status => Err(match resp.json::<HttpErrorBody>().await {
716 0 : Ok(HttpErrorBody { msg }) => Error::ApiError(status, msg),
717 : Err(_) => {
718 0 : Error::ReceiveErrorBody(format!("Http error ({}) at {}.", status.as_u16(), uri))
719 : }
720 : }),
721 : }
722 0 : }
723 :
724 0 : pub async fn import_basebackup(
725 0 : &self,
726 0 : tenant_id: TenantId,
727 0 : timeline_id: TimelineId,
728 0 : base_lsn: Lsn,
729 0 : end_lsn: Lsn,
730 0 : pg_version: u32,
731 0 : basebackup_tarball: ReqwestBody,
732 0 : ) -> Result<()> {
733 0 : let uri = format!(
734 0 : "{}/v1/tenant/{tenant_id}/timeline/{timeline_id}/import_basebackup?base_lsn={base_lsn}&end_lsn={end_lsn}&pg_version={pg_version}",
735 0 : self.mgmt_api_endpoint,
736 0 : );
737 0 : self.start_request(Method::PUT, uri)
738 0 : .body(basebackup_tarball)
739 0 : .send()
740 0 : .await
741 0 : .map_err(Error::SendRequest)?
742 0 : .error_from_body()
743 0 : .await?
744 0 : .json()
745 0 : .await
746 0 : .map_err(Error::ReceiveBody)
747 0 : }
748 :
749 0 : pub async fn import_wal(
750 0 : &self,
751 0 : tenant_id: TenantId,
752 0 : timeline_id: TimelineId,
753 0 : start_lsn: Lsn,
754 0 : end_lsn: Lsn,
755 0 : wal_tarball: ReqwestBody,
756 0 : ) -> Result<()> {
757 0 : let uri = format!(
758 0 : "{}/v1/tenant/{tenant_id}/timeline/{timeline_id}/import_wal?start_lsn={start_lsn}&end_lsn={end_lsn}",
759 0 : self.mgmt_api_endpoint,
760 0 : );
761 0 : self.start_request(Method::PUT, uri)
762 0 : .body(wal_tarball)
763 0 : .send()
764 0 : .await
765 0 : .map_err(Error::SendRequest)?
766 0 : .error_from_body()
767 0 : .await?
768 0 : .json()
769 0 : .await
770 0 : .map_err(Error::ReceiveBody)
771 0 : }
772 :
773 0 : pub async fn timeline_init_lsn_lease(
774 0 : &self,
775 0 : tenant_shard_id: TenantShardId,
776 0 : timeline_id: TimelineId,
777 0 : lsn: Lsn,
778 0 : ) -> Result<LsnLease> {
779 0 : let uri = format!(
780 0 : "{}/v1/tenant/{tenant_shard_id}/timeline/{timeline_id}/lsn_lease",
781 0 : self.mgmt_api_endpoint,
782 0 : );
783 0 :
784 0 : self.request(Method::POST, &uri, LsnLeaseRequest { lsn })
785 0 : .await?
786 0 : .json()
787 0 : .await
788 0 : .map_err(Error::ReceiveBody)
789 0 : }
790 :
791 0 : pub async fn wait_lsn(
792 0 : &self,
793 0 : tenant_shard_id: TenantShardId,
794 0 : request: TenantWaitLsnRequest,
795 0 : ) -> Result<StatusCode> {
796 0 : let uri = format!(
797 0 : "{}/v1/tenant/{tenant_shard_id}/wait_lsn",
798 0 : self.mgmt_api_endpoint,
799 0 : );
800 0 :
801 0 : self.request_noerror(Method::POST, uri, request)
802 0 : .await
803 0 : .map(|resp| resp.status())
804 0 : }
805 : }
|
