Floating IP'ler

Projenin floating IP'leri

GET /floating_ips

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 adresin bir parçası veya label:key, label:key=value (en kısa uzunluk 2, en uzun uzunluk 100)

Yanıtlar

Durum	Açıklama
200	Floating IP'ler
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
floating_ips	FloatingIp dizisi	Evet
meta	Meta	Evet

Floating IP oluştur

POST /floating_ips

floating_ips kotasından düşer. location ya da server verilir.

Parametreler

Ad	Yer	Tür	Zorunlu	Açıklama
Idempotency-Key	başlık	string	Hayır	16-128 görünür ASCII karakter; 24 saat boyunca aynı yanıt döner (desen ^[\x21-\x7e]{16,128}$)

İstek gövdesi

Alan	Tür	Zorunlu	Açıklama
type	ipv4, ipv6	Evet
location	Reference	Hayır
server	Reference	Hayır
name	string	Hayır	@ içermeyen 1-64 yazdırılabilir karakter (en kısa uzunluk 1, en uzun uzunluk 64)
description	string	Hayır	(en uzun uzunluk 200)
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
201	Floating IP ve eylemi
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)
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)
429	Anahtarın istek hakkı bitti

Yanıt gövdesi

Alan	Tür	Zorunlu	Açıklama
floating_ip	FloatingIp	Evet
action	Action	Evet

Tek floating IP

GET /floating_ips/{id}

Parametreler

Ad	Yer	Tür	Zorunlu	Açıklama
id	yol	string (uuid)	Evet

Yanıtlar

Durum	Açıklama
200	Floating IP
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
floating_ip	FloatingIp	Evet

Floating IP'yi yeniden adlandır, açıkla ya da etiketle

PUT /floating_ips/{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)
description	string	Hayır	(en uzun uzunluk 200)
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	Floating IP
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
floating_ip	FloatingIp	Evet

Floating IP'yi bırak

DELETE /floating_ips/{id}

Atanmışken ya da protection.delete açıkken reddedilir (409).

Parametreler

Ad	Yer	Tür	Zorunlu	Açıklama
id	yol	string (uuid)	Evet

Yanıtlar

Durum	Açıklama
204	Bırakıldı
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)
423	Kaynağın çalışan bir eylemi var
429	Anahtarın istek hakkı bitti

Floating IP'nin eylemleri

GET /floating_ips/{id}/actions

Parametreler

Ad	Yer	Tür	Zorunlu	Açıklama
id	yol	string (uuid)	Evet
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)
status	sorgu	running, success, error	Hayır
sort	sorgu	string	Hayır	<field>:asc|desc; alanlar id, command, status, started, finished; varsayılan started:desc (desen ^(id|command|status|started|finished):(asc|desc)$)

Yanıtlar

Durum	Açıklama
200	Eylemler
401	Geçerli API anahtarı yok
404	Bu projede böyle bir kaynak yok
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
actions	Action dizisi	Evet
meta	Meta	Evet

Floating IP'nin tek eylemi

GET /floating_ips/{id}/actions/{action_id}

Parametreler

Ad	Yer	Tür	Zorunlu	Açıklama
id	yol	string (uuid)	Evet
action_id	yol	string (uuid)	Evet

Yanıtlar

Durum	Açıklama
200	Eylem
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
action	Action	Evet

Floating IP'yi sunucuya ata

POST /floating_ips/{id}/actions/assign

Parametreler

Ad	Yer	Tür	Zorunlu	Açıklama
id	yol	string (uuid)	Evet
Idempotency-Key	başlık	string	Hayır	16-128 görünür ASCII karakter; 24 saat boyunca aynı yanıt döner (desen ^[\x21-\x7e]{16,128}$)

İstek gövdesi

Alan	Tür	Zorunlu	Açıklama
server	Reference	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
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
action	Action	Evet

Floating IP atamasını kaldır

POST /floating_ips/{id}/actions/unassign

Parametreler

Ad	Yer	Tür	Zorunlu	Açıklama
id	yol	string (uuid)	Evet
Idempotency-Key	başlık	string	Hayır	16-128 görünür ASCII karakter; 24 saat boyunca aynı yanıt döner (desen ^[\x21-\x7e]{16,128}$)

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
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
action	Action	Evet

Ters DNS adını ayarla ya da temizle

POST /floating_ips/{id}/actions/change_dns_ptr

Parametreler

Ad	Yer	Tür	Zorunlu	Açıklama
id	yol	string (uuid)	Evet
Idempotency-Key	başlık	string	Hayır	16-128 görünür ASCII karakter; 24 saat boyunca aynı yanıt döner (desen ^[\x21-\x7e]{16,128}$)

İstek gövdesi

Alan	Tür	Zorunlu	Açıklama
ip	string	Evet	(en uzun uzunluk 45)
dns_ptr	string ya da null	Evet	Bir ana makine adı; temizlemek için null (en uzun uzunluk 253)

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
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
action	Action	Evet

Floating IP'yi silinmeye karşı koru

POST /floating_ips/{id}/actions/change_protection

Parametreler

Ad	Yer	Tür	Zorunlu	Açıklama
id	yol	string (uuid)	Evet
Idempotency-Key	başlık	string	Hayır	16-128 görünür ASCII karakter; 24 saat boyunca aynı yanıt döner (desen ^[\x21-\x7e]{16,128}$)

İstek gövdesi

Alan	Tür	Zorunlu	Açıklama
delete	boolean	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
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
action	Action	Evet