Получение списка состояний развертывания создания

Статья
07/19/2023

Возвращает список развертываний Compose, созданных в кластере Service Fabric.

Возвращает состояние развертываний Compose, которые были созданы или в процессе создания в кластере Service Fabric. Ответ содержит имя, состояние и другие сведения о развертывании Compose. Если список развертываний не помещается на странице, возвращается одна страница результатов и маркер продолжения, который можно использовать для получения следующей страницы.

Запрос

Метод	Универсальный код ресурса (URI) запроса
GET	`/ComposeDeployments?api-version=6.0-preview&ContinuationToken={ContinuationToken}&MaxResults={MaxResults}&timeout={timeout}`

Параметры

Имя	Тип	Обязательно	Расположение
`api-version`	строка	Да	Запрос
`ContinuationToken`	строка	Нет	Запрос
`MaxResults`	целое число (int64)	Нет	Запрос
`timeout`	целое число (int64)	Нет	Запрос

`api-version`

Тип: строка
Обязательный: да
По умолчанию: 6.0-preview

Версия API. Этот параметр является обязательным и его значение должно иметь значение "6.0-preview".

`ContinuationToken`

Тип: строка
Обязательный: нет

Параметр маркера продолжения используется для получения следующего набора результатов. Маркер продолжения с непустым значением добавляется в ответ API, когда результаты из системы не помещаются в один ответ. Когда это значение передается в следующем вызове API, API возвращает следующий набор результатов. Если результаты отсутствуют, маркер продолжения не будет содержать значение. Значение этого параметра не должно быть указано в формате URL-адреса.

`MaxResults`

Тип: integer (int64)
Обязательный: нет
По умолчанию: 0
InclusiveMinimum: 0

Максимальное количество результатов, возвращаемых в результате страничного запроса. Этот параметр определяет максимальное число возвращаемых результатов. Возвращаемых результатов может быть меньше, чем указанное максимальное количество результатов, если они не помещаются в сообщении согласно ограничениям максимального размера сообщения, определенным в конфигурации. Если этот параметр равен нулю или не указан, то результат страничного запроса содержит максимальное число результатов, помещающееся в возвращаемом сообщении.

`timeout`

Тип: integer (int64)
Обязательный: нет
По умолчанию: 60
InclusiveMaximum: 4294967295
InclusiveMinimum: 1

Время ожидания сервера до выполнения операции в секундах. Время ожидания — промежуток времени, в течение которого клиент готов ждать выполнения запрошенной операции. Значение по умолчанию для этого параметра — 60 секунд.

Ответы

Код состояния HTTP	Описание	схеме ответа.
200 OK;	Список состояний развертываний создания в кластере.	PagedComposeDeploymentStatusInfoList
Все остальные коды состояния	Подробный ответ об ошибке.	FabricError

Поделиться через