ساخت نتورک
دستور create برای ساخت یک نتورک استفاده میشود.
🧩 دستور کلی
{{baseURL}}/networks/create
📥 مشخصات درخواست (Request)
| فیلد | مقدار |
|---|---|
| Method | POST |
| Endpoint | /networks/create |
| Query Parameters | خیر |
| Content-Type | application/json |
⚙️ پارامترها (params)
بدنه (body)
{
"driver": "bridge",
"name": "my-br3",
"gateway": "192.167.210.14",
"subnet": "192.167.110.14/16"
}
فیلدهای ورودی (Options)
| فیلد | نوع داده | توضیح |
|---|---|---|
driver | string | نوع درایور نتورک.(bridge, macvlan, none, host), required |
name | string | نام نتورک. required |
gateway | string | گیتوی مختص نتورک. optional |
subnet | string | سابنت مختص نتورک. optional |
options | json | آپشن های نتورک (با توجه به نوع درایور میتواند key های متفاوتی داشته باشد . optional |
مثال کاملتر:
روش استفاده (How to Use)
POST {{baseURL}}/networks/create
{
"driver": "bridge",
"name": "my-br3",
"gateway": "192.167.210.14",
"subnet": "192.167.110.14/16"
}
نمونه response:
{
"meta": {
"shamsiDate": "14040518110114925",
"requestId": "8a3bf151-51b4-40fd-ae34-1e499a9cf3c2"
},
"data": {
"message": "Network macnet1 created successfully",
"data": {
"id": "a294dc4a4e6f7f94",
"name": "macnet1",
"driver": "macvlan"
}
}
}
وضعیت پاسخ (Status Codes)
| کد | معنی |
|---|---|
200 OK | درخواست با موفقیت انجام شد |
400 BAD REQUEST | مقادیر لازم ورودی داده نشده اند یا اشتباه اند |
نکات مهم
در حالتی که نوع driver ما macvlan است حتما باید options داده شود و key های زیر را داشته باشد
parent, vlanId
مثال:
{
"driver": "macvlan",
"name": "macnet1",
"options": {
"parent": "ens33",
"vlanId": 15
}
}