- 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 uỷ quyền
- Hình ảnh
- Hình thu nhỏ
- Trạng thái
- Hãy dùng thử!
Liệt kê hình thu nhỏ của các hình ảnh đính kèm với một bước.
Có thể trả về bất kỳ mã lỗi chuẩn 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 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 |
Mã dự án. Bắt buộc. |
historyId |
Mã Nhật ký. Bắt buộc. |
executionId |
Mã thực thi. Bắt buộc. |
stepId |
Mã bước. Bắt buộc. |
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 bạn không đặt trường này hoặc có giá trị bằng 0. Không bắt buộc. |
Nội dung yêu cầu
Nội dung 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 dưới dạng JSON |
---|
{
"thumbnails": [
{
object ( |
Trường | |
---|---|
thumbnails[] |
Danh sách dữ liệu hình ảnh. Hình ảnh được trả về theo thứ tự tất định; các yếu tố này được sắp xếp theo mức độ quan trọng: * Trước tiên, theo trường hợp kiểm thử liên quan. Hình ảnh không có trường hợp kiểm thử được coi là lớn hơn hình ảnh có một trường hợp kiểm thử. * Thứ hai, theo thời gian sáng tạo. Những hình ảnh không có thời gian tạo sẽ lớn hơn hình ảnh có một thời gian tạo. * Thứ ba, theo thứ tự mà chúng được thêm vào bước (theo lệnh gọi đến steps.create hoặc steps.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 chỉ ra rằng có nhiều hình thu nhỏ khác để đọ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 uỷ quyền
Yêu cầu phạm vi OAuth sau đây:
https://www.googleapis.com/auth/cloud-platform
Để biết thêm thông tin, hãy xem bài viết Tổng quan về việc xác thực.
Hình ảnh
Một hình ảnh, kèm theo đường liên kết đến hình ảnh chính và một hình thu nhỏ.
Biểu diễn dưới dạng JSON |
---|
{ "stepId": string, "sourceImage": { object ( |
Trường | |
---|---|
stepId |
Bước đính kèm hình ảnh. Luôn đặt. |
sourceImage |
Nội dung tham chiếu đến hình ảnh gốc, có kích thước đầy đủ. Mục này giống với mục toolOutputs (Kết quả) cho hình ảnh ở phần Step (Bước). Luôn đặt. |
Trường kết hợp 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 trạng thái sau đây: |
|
thumbnail |
Hình thu nhỏ. |
error |
Lỗi giải thích lý do không thể hiển thị hình thu nhỏ. |
Hình thu nhỏ
Một hình thu nhỏ duy nhất có kích thước và định dạng.
Biểu diễn dưới dạng JSON |
---|
{ "contentType": string, "heightPx": integer, "widthPx": integer, "data": string } |
Trường | |
---|---|
contentType |
Loại nội dung của hình thu nhỏ, tức là "image/png". Luôn đặt. |
heightPx |
Chiều cao của hình thu nhỏ, tính bằng pixel. Luôn đặt. |
widthPx |
Chiều rộng của hình thu nhỏ, tính bằng pixel. Luôn đặt. |
data |
Chính tệp hình thu nhỏ. Tức 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ân phát dưới dạng hình ảnh nguyên trạng (với loại nội dung thích hợp). Luôn đặt. Chuỗi được mã hoá base64. |
Trạng thái
Loại Status
xác định mô hình lỗi logic phù hợp với nhiều môi trường lập trình, bao gồm cả API REST và API RPC. Hàm này được gRPC sử dụng. Mỗi thông báo Status
chứa 3 phần dữ liệu: mã lỗi, thông báo lỗi và thông tin chi tiết về lỗi.
Bạn có thể tìm hiểu thêm về mô hình lỗi này cũng như cách xử lý trong Hướng dẫn thiết kế API.
Biểu diễn dưới dạng JSON |
---|
{ "code": integer, "message": string, "details": [ { "@type": string, field1: ..., ... } ] } |
Trường | |
---|---|
code |
Mã trạng thái, phải là một 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 dành cho người dùng đều phải được bản địa hoá và gửi trong trường |
details[] |
Danh sách các thông báo chứa thông tin chi tiết về lỗi. Có một nhóm loại thông báo phổ biến để API sử dụng. Một đối tượng có chứa các trường thuộc loại tuỳ ý. Trường bổ sung |