Long Running Operations - Get Operation State

Служба:: Core

Версия API:: v1

Возвращает текущее состояние длительной операции.
Вы получаете идентификатор операции из заголовка x-ms-operation-id, возвращаемого API, который инициировал операцию. После того как состояние операции будет "Успешно выполнено", используйте API результатов получения результата.

Разрешения

То же, что и разрешения, необходимые для API, инициирующего операцию.

Требуемая делегированная область

То же, что и области, необходимые для API, инициирующего операцию.

Идентификаторы, поддерживаемые Microsoft Entra

Этот API поддерживает идентичности Microsoft, перечисленные в этом разделе.

Идентичность	Поддержка
Пользователь	Да
Представитель службы и управляемые удостоверения	Да

Интерфейс

GET https://api.fabric.microsoft.com/v1/operations/{operationId}

Параметры URI

Имя	В	Обязательно	Тип	Описание
operationId	path	True	string (uuid)	Идентификатор операции

Ответы

Имя Тип Описание

200 OK

Имя	Тип	Описание
200 OK	OperationState	Запрос успешно завершен. Заголовки Location: string Retry-After: integer x-ms-operation-id: string
429 Too Many Requests	ErrorResponse	Превышено ограничение скорости обслуживания. Сервер возвращает заголовок, указывающий `Retry-After` в секундах, сколько времени клиент должен ждать перед отправкой дополнительных запросов. Заголовки Retry-After: integer
Other Status Codes	ErrorResponse	Распространенные коды ошибок: UnknownError — произошла ошибка.

OperationState

Запрос успешно завершен.

Заголовки

Location: string
Retry-After: integer
x-ms-operation-id: string

429 Too Many Requests

ErrorResponse

Превышено ограничение скорости обслуживания. Сервер возвращает заголовок, указывающий Retry-After в секундах, сколько времени клиент должен ждать перед отправкой дополнительных запросов.

Заголовки

Retry-After: integer

Other Status Codes

ErrorResponse

Распространенные коды ошибок:

UnknownError — произошла ошибка.

Примеры

Get active long running operation example

Get completed long running operation example

Get active long running operation example

Образец запроса

HTTP

GET https://api.fabric.microsoft.com/v1/operations/cfafbeb1-8037-4d0c-896e-a46fb27ff227

Пример ответа

Код состояния:: 200

Location: https://api.fabric.microsoft.com/operations/cfafbeb1-8037-4d0c-896e-a46fb27ff227
x-ms-operation-id: cfafbeb1-8037-4d0c-896e-a46fb27ff227
Retry-After: 20

{
  "status": "Running",
  "createdTimeUtc": "2023-09-13T14:56:18.477Z",
  "lastUpdatedTimeUtc": "2023-09-13T15:01:10.532Z",
  "percentComplete": 25
}

Get completed long running operation example

Образец запроса

HTTP

GET https://api.fabric.microsoft.com/v1/operations/cfafbeb1-8037-4d0c-896e-a46fb27ff227

Пример ответа

Код состояния:: 200

Location: https://api.fabric.microsoft.com/operations/cfafbeb1-8037-4d0c-896e-a46fb27ff227/result
x-ms-operation-id: cfafbeb1-8037-4d0c-896e-a46fb27ff227

{
  "status": "Succeeded",
  "createdTimeUtc": "2023-09-13T14:56:18.477Z",
  "lastUpdatedTimeUtc": "2023-09-13T15:01:10.532Z",
  "percentComplete": 100
}

Определения

Имя	Описание
ErrorRelatedResource	Объект сведений об ошибках, связанных с ресурсом.
ErrorResponse	Ответ на ошибку.
ErrorResponseDetails	Сведения об ответе на ошибку.
LongRunningOperationStatus	Текущее состояние операции. С течением времени могут добавляться дополнительные состояния операций.
OperationState	Объект, описывающий сведения и текущее состояние длительной операции

ErrorRelatedResource

Объект

Объект сведений об ошибках, связанных с ресурсом.

Имя	Тип	Описание
resourceId	string	Идентификатор ресурса, участвующий в ошибке.
resourceType	string	Тип ресурса, который участвует в ошибке.

ErrorResponse

Объект

Ответ на ошибку.

Имя	Тип	Описание
errorCode	string	Определенный идентификатор, предоставляющий сведения об условии ошибки, что позволяет стандартизировать обмен данными между службой и ее пользователями.
message	string	Удобочитаемое представление ошибки.
moreDetails	ErrorResponseDetails[]	Список дополнительных сведений об ошибке.
relatedResource	ErrorRelatedResource	Сведения об ошибках, связанных с ресурсом.
requestId	string (uuid)	Идентификатор запроса, связанного с ошибкой.

ErrorResponseDetails

Объект

Сведения об ответе на ошибку.

Имя	Тип	Описание
errorCode	string	Определенный идентификатор, предоставляющий сведения об условии ошибки, что позволяет стандартизировать обмен данными между службой и ее пользователями.
message	string	Удобочитаемое представление ошибки.
relatedResource	ErrorRelatedResource	Сведения об ошибках, связанных с ресурсом.

LongRunningOperationStatus

Перечисление

Текущее состояние операции. С течением времени могут добавляться дополнительные состояния операций.

Значение	Описание
Undefined	Состояние операции не определено
NotStarted	Операция не запущена
Running	Операция выполняется
Succeeded	Операция успешно завершена
Failed	Сбой операции

OperationState

Объект

Объект, описывающий сведения и текущее состояние длительной операции

Имя	Тип	Описание
createdTimeUtc	string (date-time)	Дата начала и время операции
error	ErrorResponse	Сведения об ошибке в случае сбоя операции
lastUpdatedTimeUtc	string (date-time)	Дата и время последнего изменения операции
percentComplete	integer (int32) minimum: 0 maximum: 100	Ход выполнения операции в процентах
status	LongRunningOperationStatus	Текущее состояние операции. С течением времени могут добавляться дополнительные состояния операций.