Snapshot'lar
Projenin snapshot'ları
GET /snapshots
Parametreler
| Ad | Yer | Tür | Zorunlu | Açıklama |
|---|---|---|---|---|
page | sorgu | integer | Hayır | (en az 1, varsayılan 1) |
per_page | sorgu | integer | Hayır | (en az 1, en çok 100, varsayılan 25) |
name | sorgu | string | Hayır | Tam ad (en uzun uzunluk 64) |
label_selector | sorgu | string | Hayır | key, !key, key==v, key=v, key!=v, key in (a,b), key notin (a,b); virgülle ayrılır (ve) (en uzun uzunluk 1024) |
sort | sorgu | string | Hayır | <field>:asc|desc; alanlar id, name, created; varsayılan created:desc (desen ^(id|name|created):(asc|desc)$) |
q | sorgu | string | Hayır | Her sözcük, büyük-küçük harf gözetmeden eşleşmelidir: adın ya da sunucu adının bir parçası veya label:key, label:key=value (en kısa uzunluk 2, en uzun uzunluk 100) |
status | sorgu | creating, available, deleting | Hayır |
Yanıtlar
| Durum | Açıklama |
|---|---|
200 | Snapshot'lar |
401 | Geçerli API anahtarı yok |
403 | Anahtarın kapsamı ya da kuruluşun aboneliği isteğe izin vermiyor (forbidden) veya kota doldu (resource_limit_exceeded) |
422 | Bir alan eksik ya da hatalı (invalid_input, details.fields) veya bir Idempotency-Key farklı bir istekle yeniden kullanıldı (idempotency_key_mismatch) |
429 | Anahtarın istek hakkı bitti |
Yanıt gövdesi
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
snapshots | Snapshot dizisi | Evet | |
meta | Meta | Evet |
Tek snapshot
GET /snapshots/{id}
Parametreler
| Ad | Yer | Tür | Zorunlu | Açıklama |
|---|---|---|---|---|
id | yol | string (uuid) | Evet |
Yanıtlar
| Durum | Açıklama |
|---|---|
200 | Snapshot |
401 | Geçerli API anahtarı yok |
404 | Bu projede böyle bir kaynak yok |
429 | Anahtarın istek hakkı bitti |
Yanıt gövdesi
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
snapshot | Snapshot | Evet |
Snapshot'ı yeniden adlandır ya da etiketle
PUT /snapshots/{id}
Parametreler
| Ad | Yer | Tür | Zorunlu | Açıklama |
|---|---|---|---|---|
id | yol | string (uuid) | Evet |
İstek gövdesi
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
name | string | Hayır | @ içermeyen 1-64 yazdırılabilir karakter (en kısa uzunluk 1, en uzun uzunluk 64) |
labels | string eşlemesi | Hayır | En çok 32 anahtar; anahtarlar ve değerler 1-63 karakter (değerler boş olabilir): harf, rakam, ., _, -; harf ya da rakamla başlar ve biter |
Yanıtlar
| Durum | Açıklama |
|---|---|
200 | Snapshot |
401 | Geçerli API anahtarı yok |
403 | Anahtarın kapsamı ya da kuruluşun aboneliği isteğe izin vermiyor (forbidden) veya kota doldu (resource_limit_exceeded) |
404 | Bu projede böyle bir kaynak yok |
409 | İstek kaynağın durumuyla çakışıyor (conflict) ya da bir Idempotency-Key hâlâ işleniyor (idempotency_in_progress) |
422 | Bir alan eksik ya da hatalı (invalid_input, details.fields) veya bir Idempotency-Key farklı bir istekle yeniden kullanıldı (idempotency_key_mismatch) |
423 | Kaynağın çalışan bir eylemi var |
429 | Anahtarın istek hakkı bitti |
Yanıt gövdesi
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
snapshot | Snapshot | Evet |
Snapshot'ı sil
DELETE /snapshots/{id}
Eylem başarılı olunca snapshot kotası serbest kalır.
Parametreler
| Ad | Yer | Tür | Zorunlu | Açıklama |
|---|---|---|---|---|
id | yol | string (uuid) | Evet |
Yanıtlar
| Durum | Açıklama |
|---|---|
201 | Eylem |
401 | Geçerli API anahtarı yok |
403 | Anahtarın kapsamı ya da kuruluşun aboneliği isteğe izin vermiyor (forbidden) veya kota doldu (resource_limit_exceeded) |
404 | Bu projede böyle bir kaynak yok |
423 | Kaynağın çalışan bir eylemi var |
429 | Anahtarın istek hakkı bitti |
Yanıt gövdesi
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
action | Action | Evet |