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

Async Operations - AsyncOperations Get

  • Ссылка
Служба:
Azure Sphere Public API
Версия API:
v2

Возвращает сведения об указанной операции в пределах области клиента.

GET https://prod.core.sphere.azure.net/v2/tenants/{tenantId}/operations/{operationId}

Параметры URI

Имя В Обязательно Тип Описание
operationId
 path True

string

uuid

Уникальный идентификатор операции.
tenantId
 path True

string

uuid

Идентификатор клиента Azure Sphere.

Ответы

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

Operation

Объект, представляющий сведения об операции.
400 Bad Request

PublicApiErrorDetails[]

Коллекция сведений об ошибке.
404 Not Found

PublicApiErrorDetails[]

Коллекция сведений об ошибке.
500 Internal Server Error

PublicApiErrorDetails[]

Коллекция сведений об ошибке.

Определения

Имя Описание
ErrorResponse
Operation
PublicApiErrorDetails

ErrorResponse

Имя Тип Описание
Code enum:
  • 0 - OperationFailed
  • 1 - TenantInMigration
  • 2 - TenantMigrationRequired
  • 3 - ClientUpdateRequired
  • 4 - InternalServerError
  • 5 - BadRequest
  • 6 - Forbidden
  • 7 - Conflict
  • 8 - NotFound

Возвращает код.
Message

string

Возвращает сообщение об ошибке, доступное для чтения пользователем.

Operation

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

string

Возвращает дату выполнения операции в формате UTC.
CreatedDateUTC

string

Возвращает дату создания операции в формате UTC.
DetailsLocation

string

Возвращает расположение для получения сведений об операции.
Error

ErrorResponse

OperationId

string

Возвращает уникальный идентификатор операции.
OperationType enum:
  • 0 - DeviceClaim
  • 1 - DeviceUnclaim
  • 10 - DeleteProduct
  • 11 - BulkDeviceClaim
  • 2 - DeviceUpdateDeviceGroup
  • 3 - MigrateTenant
  • 4 - CreateProduct
  • 5 - DeployToDeviceGroup
  • 6 - DeployToOSFeed
  • 7 - ImageUpload
  • 8 - TenantCreation
  • 9 - DeleteDeviceGroup

Возвращает идентификатор типа операции.
ResourceLocation

string

Возвращает расположение ресурсов, созданных во время выполнения операции.
StartedDateUTC

string

Возвращает дату в формате UTC, которую операция начала обработку.
State enum:
  • 0 - NotStarted
  • 1 - InProgress
  • 2 - Complete
  • 3 - Failed
  • 4 - CompleteWithErrors

Возвращает состояние операции.
TenantId

string

Возвращает идентификатор клиента.

PublicApiErrorDetails

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

string

Понятное для человека объяснение, конкретное для этого возникновения проблемы.
ErrorCode

string

Строковое представление PublicApiErrorCode, определяющее ошибку.
Extensions

Возвращает словарь для членов расширения. Определения типов проблем МОГУТ расширить объект сведений о проблеме с дополнительными элементами. Члены расширения отображаются в том же пространстве имен, что и другие члены типа проблемы.
Instance

string

Ссылка на универсальный код ресурса (URI), определяющая конкретное вхождения проблемы. Мэр может не дать дополнительных сведений, если разоменовыватель.
Status

integer

Код состояния HTTP([RFC7231], раздел 6, созданный сервером-источником, выполняется при возникновении проблемы.
Title

string

Краткая, читаемая человеком сводка по типу проблемы. Он НЕ ДОЛЖЕН изменяться от вхождения к возникновению проблемы, за исключением целей локализации (например, с использованием упреждающего согласования содержимого; см. [RFC7231], раздел 3.4).
Type

string

Ссылка на универсальный код ресурса (URI) [RFC3986], которая определяет тип проблемы. Эта спецификация призывает к тому, что при расшифровке она предоставляет удобочитаемую для человека документацию по типу проблемы (например, с помощью HTML [W3C). REC-html5-20141028]). Если этот элемент отсутствует, предполагается, что его значение является пустым.