دریافت لیست ایمیجها
این API لیستی از ایمیجهای موجود در سیستم را برمیگرداند.
🧩 دستور کلی
{{base_url}}/images/list
📥 مشخصات درخواست (Request)
| فیلد | مقدار |
|---|---|
| Method | GET |
| Endpoint | /images/list |
| Query Parameters | بله |
| Content-Type | application/json |
📌 Query Params
| پارامتر | مقدار نمونه | توضیح |
|---|---|---|
| image | nginx | نام ایمیج |
| tag | latest | تگ ایمیج |
روش استفاده (How to Use)
GET http://localhost:4001/images/list?image=nginx&tag=latest
پاسخ نمونه (Sample Response)
{
"meta": {
"shamsiDate": "14040518135210144",
"requestId": "c88d4545-8d08-4564-935c-9240bd1367e0"
},
"data": [
{
"Name": "python",
"Tag": "alpine",
"Size": "15 MB"
},
{
"Name": "python",
"Tag": "v1",
"Size": "42 MB"
}
]
}
توضیح فیلدهای خروجی
| فیلد | نوع داده | توضیح |
|---|---|---|
Name | string | نام ایمیج |
Tag | string | تگ مربوط به ایمیج |
Size | string | اندازه ایمیج |
وضعیت پاسخ (Status Codes)
| کد | معنی |
|---|---|
200 OK | درخواست با موفقیت انجام شد |
⚙️ خطاهای رایج
| خطا | توضیح |
|---|---|
permissionDenied | زمانی که کاربر مجوز دسترسی به لیست ندارد |
🆘 یادداشتها
- اطمینان حاصل کنید که مجوزهای لازم برای مشاهده لیست ایمیجها را دارید.
- پاسخ ممکن است بر اساس موجود بودن ایمیجها در سیستم تغییر کند.