- Yêu cầu HTTP
- Tham số đường dẫn
- Tham số truy vấn
- Nội dung yêu cầu
- Nội dung phản hồi
- Phạm vi ủy quyền
- Hình ảnh
- Hình nhỏ
- Trạng thái
- Thử nó!
Liệt kê hình thu nhỏ của hình ảnh được đính kèm với một bước.
Có thể trả về bất kỳ mã lỗi chính tắc nào sau đây: - PERMISSION_DENIED - nếu người dùng không được phép đọc từ dự án hoặc từ bất kỳ hình ảnh nào - INVALID_ARGUMENT - nếu yêu cầu không đúng định dạng - NOT_FOUND - nếu bước này không tồn tại hoặc nếu bất kỳ hình ảnh nào không tồn tại
Yêu cầu HTTP
GET https://toolresults.googleapis.com/toolresults/v1beta3/projects/{projectId}/histories/{historyId}/executions/{executionId}/steps/{stepId}/thumbnails
URL sử dụng cú pháp Chuyển mã gRPC .
Tham số đường dẫn
Thông số | |
---|---|
projectId | Id dự án. Yêu cầu. |
historyId | Một id lịch sử. Yêu cầu. |
executionId | Id thực thi. Yêu cầu. |
stepId | Id bước. Yêu cầu. |
Tham số truy vấn
Thông số | |
---|---|
pageToken | Mã thông báo tiếp tục để tiếp tục truy vấn ở mục tiếp theo. Không bắt buộc. |
pageSize | Số lượng hình thu nhỏ tối đa cần tìm nạp. Giá trị mặc định: 50. Máy chủ sẽ sử dụng giá trị mặc định này nếu trường này không được đặt hoặc có giá trị là 0. Không bắt buộc. |
Nội dung yêu cầu
Phần thân yêu cầu phải trống.
Nội dung phản hồi
Phản hồi chứa hình thu nhỏ trong một bước.
Nếu thành công, nội dung phản hồi sẽ chứa dữ liệu có cấu trúc sau:
Biểu diễn JSON |
---|
{
"thumbnails": [
{
object ( |
Lĩnh vực | |
---|---|
thumbnails[] | Danh sách dữ liệu hình ảnh Hình ảnh được trả về theo thứ tự xác định; chúng được sắp xếp theo các yếu tố sau, theo thứ tự tầm quan trọng: * Đầu tiên, theo ca kiểm thử liên quan của chúng. Hình ảnh không có trường hợp thử nghiệm được coi là lớn hơn hình ảnh có trường hợp thử nghiệm. * Thứ hai, theo thời gian sáng tạo của họ. Hình ảnh không có thời gian tạo sẽ lớn hơn hình ảnh có thời gian tạo. * Thứ ba, theo thứ tự chúng được thêm vào bước (bằng cách gọi đến step.create hoặc step.patch). |
nextPageToken | Mã thông báo tiếp tục để tiếp tục truy vấn ở mục tiếp theo. Nếu được đặt, hãy biểu thị rằng có nhiều hình thu nhỏ hơn để đọc bằng cách gọi lại danh sách với giá trị này trong trường pageToken. |
Phạm vi ủy quyền
Yêu cầu phạm vi OAuth sau:
-
https://www.googleapis.com/auth/cloud-platform
Để biết thêm thông tin, hãy xem Tổng quan về xác thực .
Hình ảnh
Một hình ảnh có liên kết đến hình ảnh chính và hình thu nhỏ.
Biểu diễn JSON |
---|
{ "stepId": string, "sourceImage": { object ( |
Lĩnh vực | |
---|---|
stepId | Bước mà hình ảnh được đính kèm. Luôn luôn thiết lập. |
sourceImage | Một tham chiếu đến hình ảnh gốc, kích thước đầy đủ. Điều này giống với mục nhập toolOutputs cho hình ảnh trong Bước của nó. Luôn luôn thiết lập. |
Trường liên minh thumbnail_or_error . Hình thu nhỏ của hình ảnh hoặc lỗi giải thích lý do không thể hiển thị hình thu nhỏ. thumbnail_or_error chỉ có thể là một trong những điều sau đây: | |
thumbnail | Hình thu nhỏ. |
error | Lỗi giải thích tại sao không thể hiển thị hình thu nhỏ. |
Hình nhỏ
Một hình thu nhỏ duy nhất có kích thước và định dạng.
Biểu diễn JSON |
---|
{ "contentType": string, "heightPx": integer, "widthPx": integer, "data": string } |
Lĩnh vực | |
---|---|
contentType | Loại nội dung của hình thu nhỏ, tức là "image/png". Luôn luôn thiết lập. |
heightPx | Chiều cao của hình thu nhỏ, tính bằng pixel. Luôn luôn thiết lập. |
widthPx | Chiều rộng của hình thu nhỏ, tính bằng pixel. Luôn luôn thiết lập. |
data | Bản thân tập tin hình thu nhỏ. Nghĩa là, các byte ở đây chính xác là các byte tạo nên tệp hình thu nhỏ; chúng có thể được phục vụ dưới dạng hình ảnh nguyên trạng (với loại nội dung phù hợp.) Luôn luôn thiết lập. Một chuỗi được mã hóa base64. |
Trạng thái
Loại Status
xác định mô hình lỗi logic phù hợp với các môi trường lập trình khác nhau, bao gồm API REST và API RPC. Nó được sử dụng bởi gRPC . Mỗi thông báo Status
chứa ba phần dữ liệu: mã lỗi, thông báo lỗi và chi tiết lỗi.
Bạn có thể tìm hiểu thêm về mô hình lỗi này và cách xử lý nó trong Hướng dẫn thiết kế API .
Biểu diễn JSON |
---|
{ "code": integer, "message": string, "details": [ { "@type": string, field1: ..., ... } ] } |
Lĩnh vực | |
---|---|
code | Mã trạng thái phải là giá trị enum của |
message | Thông báo lỗi dành cho nhà phát triển, phải bằng tiếng Anh. Mọi thông báo lỗi mà người dùng gặp phải phải được bản địa hóa và gửi trong trường |
details[] | Danh sách các thông báo chứa chi tiết lỗi. Có một nhóm loại thông báo chung để API sử dụng. Một đối tượng chứa các trường thuộc loại tùy ý. Trường bổ sung |