یک تصویر در اندازه کامل یا مقیاس‌بندی شده را با توجه به URI آن برمی‌گرداند. پارامترهای ورودی شامل وضوح است. این تنها دستوری است که باید برگردد، Content-Type: image/jpeg . همه دستورات دیگر Content-Type: application/json;charset=utf-8 را برمی گرداند. این دستور در سطح 2 API منسوخ شد.
مولفه های
- fileUri: URI فایل مورد نظر. تولیدکنندگان تصمیم می گیرند که از URI های مطلق یا نسبی استفاده کنند. مشتریان ممکن است این را به عنوان یک شناسه غیر شفاف تلقی کنند.
- maxSize: (اختیاری) حداکثر اندازه تصویر درخواستی. حداکثر (عرض_تصویر، اندازه_ارتفاع). اگر
maxSizeحذف شود یا بزرگتر از تصویر با اندازه کامل باشد، تصویر در اندازه کامل برگردانده می شود.
نتایج
- محتوا: داده های باینری تصویر، از جمله ابرداده متناظر (به عنوان مثال، مقیاس شده) در سرصفحه تصویر.
خطاها
- missingParameter:
fileUriمورد نیاز مشخص نشده است. - invalidParameterName: نام پارامتر ورودی شناسایی نشده است.
- invalidParameterValue: نام پارامتر ورودی شناسایی می شود، اما مقدار آن نامعتبر است. به عنوان مثال، مقدار
fileUriوجود ندارد، نوع داده آن نادرست است، یاmaxSizeدارای نوع داده اشتباه است.
دستور I/O | |
|---|---|
| ورودی فرمان | {
"parameters": {
"fileUri": "file URI",
"maxSize": 400
}
} | خروجی فرمان | Image binary data |
| خروجی فرمان (خطا) | {
"error": {
"code": "invalidParameterValue",
"message": "Parameter fileUri doesn't exist."
}
} |