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

لیست کانتینرها

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

🧩 دستور کلی


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

فیلدمقدار
MethodGET
Endpoint/containers/json
Query Parametersبله
Content-Typeapplication/json

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

نام پارامترنوعتوضیح
statusstringوضعیت کانتینر (مثل: running, paused, stopped, created )
idstringشناسه یا نام کانتینر خاص
imagestringفیلتر بر اساس ایمیج (مثلاً: ubuntu:latest) (درحال توسعه)
createdstring (YYYY-MM-DD)فقط کانتینرهایی که در این تاریخ ساخته شده‌اند
allbooleanاگر true باشد، تمام کانتینرها (شامل متوقف‌شده‌ها) را برمی‌گرداند

بدنه (body)


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

GET {{base_url}}/containers/json?status=paused&id=cont1&image=ubuntu:latest&created=2025-07-02&all=true
{
"meta": {
"shamsiDate": "14040511125546345",
"requestId": "6d947e0c-0225-44e9-970b-57679721235d"
},
"data": [
{
"id": "10f069e4",
"pid": 3742,
"status": "running",
"created": "2025-08-02T08:18:15.264Z",
"owner": "root",
"name": "cont"
}
]
}

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

کدمعنی
200 OKدرخواست با موفقیت انجام شد
400 Bad Requestپارامترها اشتباه هستند یا ناقص
500 Internal Server Errorخطای داخلی سرور در پردازش درخواست

نکات مهم

  • استفاده از all به‌طور همزمان با گزینه‌هایی مانند status, image, created یا containerId مجاز نیست.

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

خطاتوضیح
Error: all cannot be used with status, created, or imageپارامترهای متداخل با هم استفاده شده
Unknown statusمقدار status یکی از وضعیت‌های معتبر نیست
Date format errorcreated باید با فرمت YYYY-MM-DD باشد

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