API: شبکه‌های خصوصی

ساخت شبکه‌های خصوصی و مدیریت اعضای آن‌ها.

تغییرات شبکه‌ها و عضویت‌ها ناهمگام است. پاسخ از قبل وضعیت در جریان را دارد؛ فهرست را تا پایان کار بپرسید.

فهرست شبکه‌های خصوصی

GET /private-networks

شبکه‌های خصوصی شما را همراه اعضای هرکدام برمی‌گرداند.

احراز هویت: کلید API یا توکن خود را به‌صورت Bearer بفرستید.

پاسخ‌ها

200 موفق. برمی‌گرداند: data (فهرستی از PrivateNetwork).

نمونه

curl -X GET https://veneshcloud.ir/api/private-networks \
  -H "Authorization: Bearer $VENESH_API_KEY" \
  -H "Accept: application/json"

ساخت شبکهٔ خصوصی

POST /private-networks

یک شبکه روی یک ارائه‌دهنده و منطقه می‌سازد. با pending شروع می‌شود.

احراز هویت: کلید API یا توکن خود را به‌صورت Bearer بفرستید.

بدنهٔ درخواست (application/json)

فیلد	نوع	الزامی	مقادیر
`provider`	string	بله	`aws`, `ovh`, `alibaba`
`region`	string	بله
`name`	string	خیر

پاسخ‌ها

202 پذیرفته شد، کار در پس‌زمینه ادامه دارد. برمی‌گرداند PrivateNetwork.
422 خطای اعتبارسنجی یا مجاز نبودن در وضعیت فعلی

نمونه

curl -X POST https://veneshcloud.ir/api/private-networks \
  -H "Authorization: Bearer $VENESH_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{"provider":"aws","region":"REGION"}'

دریافت یک شبکهٔ خصوصی

GET /private-networks/{privateNetwork}

یک شبکه را همراه اعضایش برمی‌گرداند.

احراز هویت: کلید API یا توکن خود را به‌صورت Bearer بفرستید.

پارامترهای مسیر

فیلد	نوع
`privateNetwork`	integer

پاسخ‌ها

200 موفق. برمی‌گرداند PrivateNetwork.
403 مجاز نیست، این منبع متعلق به شما نیست

نمونه

curl -X GET https://veneshcloud.ir/api/private-networks/NETWORK_ID \
  -H "Authorization: Bearer $VENESH_API_KEY" \
  -H "Accept: application/json"

حذف شبکهٔ خصوصی

DELETE /private-networks/{privateNetwork}

شبکهٔ فعالِ بدون عضو را حذف می‌کند.

احراز هویت: کلید API یا توکن خود را به‌صورت Bearer بفرستید.

پارامترهای مسیر

فیلد	نوع
`privateNetwork`	integer

پاسخ‌ها

202 پذیرفته شد، کار در پس‌زمینه ادامه دارد. برمی‌گرداند PrivateNetwork.
403 مجاز نیست، این منبع متعلق به شما نیست
422 خطای اعتبارسنجی یا مجاز نبودن در وضعیت فعلی

نمونه

curl -X DELETE https://veneshcloud.ir/api/private-networks/NETWORK_ID \
  -H "Authorization: Bearer $VENESH_API_KEY" \
  -H "Accept: application/json"

افزودن ماشین به شبکه

POST /private-networks/{privateNetwork}/members

ماشین در حال اجرا روی همان ارائه‌دهنده را به شبکه می‌پیوندد.

احراز هویت: کلید API یا توکن خود را به‌صورت Bearer بفرستید.

پارامترهای مسیر

فیلد	نوع
`privateNetwork`	integer

بدنهٔ درخواست (application/json)

فیلد	نوع	الزامی	مقادیر
`order_id`	integer	بله

پاسخ‌ها

202 پذیرفته شد، کار در پس‌زمینه ادامه دارد. برمی‌گرداند PrivateNetworkMembership.
403 مجاز نیست، این منبع متعلق به شما نیست
422 خطای اعتبارسنجی یا مجاز نبودن در وضعیت فعلی

نمونه

curl -X POST https://veneshcloud.ir/api/private-networks/NETWORK_ID/members \
  -H "Authorization: Bearer $VENESH_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{"order_id":1}'

خارج کردن ماشین از شبکه

DELETE /private-networks/{privateNetwork}/members/{membership}

ماشین پیوسته را از شبکه خارج می‌کند.

احراز هویت: کلید API یا توکن خود را به‌صورت Bearer بفرستید.

پارامترهای مسیر

فیلد	نوع
`privateNetwork`	integer
`membership`	integer

پاسخ‌ها

202 پذیرفته شد، کار در پس‌زمینه ادامه دارد. برمی‌گرداند PrivateNetworkMembership.
403 مجاز نیست، این منبع متعلق به شما نیست
404 پیدا نشد
422 خطای اعتبارسنجی یا مجاز نبودن در وضعیت فعلی

نمونه

curl -X DELETE https://veneshcloud.ir/api/private-networks/NETWORK_ID/members/MEMBERSHIP_ID \
  -H "Authorization: Bearer $VENESH_API_KEY" \
  -H "Accept: application/json"

اشیاء

فهرست فیلدهای اشیایی که در بالا برگردانده می‌شوند.

PrivateNetwork

فیلد	نوع	مقادیر
`id`	integer
`provider`	string	`aws`, `ovh`, `alibaba`
`region`	string
`name`	string
`external_network_id`	string
`status`	string	`pending`, `active`, `failed`, `deleting`, `deleted`
`failure_reason`	string
`members`	فهرستی از `PrivateNetworkMembership`
`created_at`	string

PrivateNetworkMembership

فیلد	نوع	مقادیر
`id`	integer
`private_network_id`	integer
`order_id`	integer
`hostname`	string
`status`	string	`pending`, `joined`, `leaving`, `left`, `failed`
`failure_reason`	string
`joined_at`	string