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

جزییات اطلاعات یک نتورک

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

🧩 دستور کلی​

{{baseURL}}/networks/{{networkName}}/inspect

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

فیلدمقدار
MethodGET
Endpoint/networks/{{networkName}}/inspect
Query Parametersخیر
Content-Typeapplication/json

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

بدنه (body)​

ندارد

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

مثال کامل‌تر:​

روش استفاده (How to Use)​

مثال ۱:​

GET {{baseURL}}/networks/kb0/inspect
{
    "meta": {
        "shamsiDate": "14040518134139727",
        "requestId": "bfa9dae1-6caf-4d5f-a0b1-c722e9ab30dd"
    },
    "data": {
        "id": "0d876d2b6234a857",
        "name": "kb0",
        "driver": "bridge",
        "networkIF_name": "kb0",
        "options": {},
        "IPAM": {
            "options": {},
            "configs": {
                "subnet": "192.168.100.0/24",
                "gateway": "192.168.100.254/24"
            }
        },
        "containers": {
            "47cd82f8e285bc86": {
                "name": "cont1",
                "MacAddress": "46:CD:82:F8:E2:85",
                "IPv4Address": "192.168.100.2/24"
            }
        }
    }
}

مثال ۲:​

GET {{baseURL}}/networks/kb2/inspect
{
    "data": {
        "message": "Network interface kb2 doesn't exist"
    },
    "meta": {
        "code": "unknown",
        "sourceType": "unknown",
        "sourceName": "unknown",
        "version": "unknown",
        "shamsiDate": "14040518134257008",
        "requestId": "12808fa8-e442-4c25-aafb-81bf7bff48ca"
    }
}

وضعیت‌ پاسخ (Status Codes)​

کدمعنی
200 OKدرخواست با موفقیت انجام شد
400 BAD REQUESTمثال:‌نتورک داده شده وجود ندارد

نکات مهم​

در حال توسعه:​

استفاده از options

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

  1. Network interface network-name doesn't exist

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