پرش به مطلب اصلی

ساخت نتورک

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

🧩 دستور کلی


📥 مشخصات درخواست (Request)

فیلدمقدار
MethodPOST
Endpoint/networks/create
Query Parametersخیر
Content-Typeapplication/json

⚙️ پارامترها (params)


بدنه (body)

{
"driver": "bridge",
"name": "my-br3",
"gateway": "192.167.210.14",
"subnet": "192.167.110.14/16"
}

فیلدهای ورودی (Options)

فیلدنوع دادهتوضیح
driverstringنوع درایور نتورک.(bridge, macvlan, none, host), required
namestringنام نتورک. required
gatewaystringگیتوی مختص نتورک. optional
subnetstringسابنت مختص نتورک. optional
optionsjsonآپشن های نتورک (با توجه به نوع درایور میتواند 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
}
}

⚙️ خطاهای رایج


🆘 دریافت راهنما