- HTTP-запрос
- Параметры пути
- Параметры запроса
- Тело запроса
- Тело ответа
- Области авторизации
- Изображение
- Миниатюра
- Статус
- Попробуйте!
Перечисляет миниатюры изображений, прикрепленных к шагу.
Может возвращать любой из следующих канонических кодов ошибок: - PERMISSION_DENIED - если пользователь не авторизован для чтения из проекта или любого из изображений - INVALID_ARGUMENT - если запрос имеет неверный формат - NOT_FOUND - если шаг не существует или если какое-либо из изображений не существует
HTTP-запрос
GET https://toolresults.googleapis.com/toolresults/v1beta3/projects/{projectId}/histories/{historyId}/executions/{executionId}/steps/{stepId}/thumbnails
URL-адрес использует синтаксис транскодирования gRPC .
Параметры пути
Параметры | |
---|---|
projectId | Идентификатор проекта. Необходимый. |
historyId | Идентификатор истории. Необходимый. |
executionId | Идентификатор выполнения. Необходимый. |
stepId | Идентификатор шага. Необходимый. |
Параметры запроса
Параметры | |
---|---|
pageToken | Токен продолжения для возобновления запроса со следующего элемента. Необязательный. |
pageSize | Максимальное количество миниатюр для получения. Значение по умолчанию: 50. Сервер будет использовать это значение по умолчанию, если поле не установлено или имеет значение 0. Необязательный. |
Тело запроса
Тело запроса должно быть пустым.
Тело ответа
Ответ, содержащий миниатюры шага.
В случае успеха тело ответа содержит данные следующей структуры:
JSON-представление |
---|
{
"thumbnails": [
{
object ( |
Поля | |
---|---|
thumbnails[] | Список данных изображения. Изображения возвращаются в детерминированном порядке; они упорядочены по этим факторам в порядке важности: * Во-первых, по связанному с ними тестовому примеру. Изображения без тестового примера считаются более важными, чем изображения с одним. * Во-вторых, по времени их создания. Изображения без времени создания более ценны, чем изображения с одним. * В-третьих, по порядку, в котором они были добавлены в шаг (вызовами шагов.создать или шагов.патч). |
nextPageToken | Токен продолжения для возобновления запроса со следующего элемента. Если установлено, указывает, что есть еще миниатюры для чтения, путем повторного вызова list с этим значением в поле pageToken. |
Области авторизации
Требуется следующая область действия OAuth:
-
https://www.googleapis.com/auth/cloud-platform
Для получения дополнительной информации см. Обзор аутентификации .
Изображение
Изображение со ссылкой на основное изображение и миниатюру.
JSON-представление |
---|
{ "stepId": string, "sourceImage": { object ( |
Поля | |
---|---|
stepId | Шаг, к которому прикреплено изображение. Всегда устанавливайте. |
sourceImage | Ссылка на полноразмерное оригинальное изображение. Это то же самое, что и запись ToolOutputs для изображения под его шагом. Всегда устанавливайте. |
Поле объединения thumbnail_or_error . Либо миниатюра изображения, либо ошибка, объясняющая, почему миниатюра не может быть отображена. thumbnail_or_error может быть только одним из следующих: | |
thumbnail | Миниатюра. |
error | Ошибка, объясняющая, почему не удалось отобразить миниатюру. |
Миниатюра
Одна миниатюра с ее размером и форматом.
JSON-представление |
---|
{ "contentType": string, "heightPx": integer, "widthPx": integer, "data": string } |
Поля | |
---|---|
contentType | Тип содержимого миниатюры, т. е. «image/png». Всегда устанавливайте. |
heightPx | Высота миниатюры в пикселях. Всегда устанавливайте. |
widthPx | Ширина миниатюры в пикселях. Всегда устанавливайте. |
data | Сам файл миниатюр. То есть байты здесь — это именно те байты, которые составляют файл миниатюр; они могут быть представлены как изображения «как есть» (с соответствующим типом контента). Всегда устанавливайте. Строка в кодировке Base64. |
Статус
Тип Status
определяет логическую модель ошибок, подходящую для различных сред программирования, включая API REST и API RPC. Он используется gRPC . Каждое сообщение Status
содержит три части данных: код ошибки, сообщение об ошибке и сведения об ошибке.
Подробнее об этой модели ошибок и о том, как с ней работать, можно узнать в API Design Guide .
JSON-представление |
---|
{ "code": integer, "message": string, "details": [ { "@type": string, field1: ..., ... } ] } |
Поля | |
---|---|
code | Код состояния, который должен быть значением перечисления |
message | Сообщение об ошибке для разработчика, которое должно быть на английском языке. Любое сообщение об ошибке, обращенное к пользователю, должно быть локализовано и отправлено в поле |
details[] | Список сообщений, содержащих сведения об ошибке. Существует общий набор типов сообщений для использования API. Объект, содержащий поля произвольного типа. Дополнительное поле |