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

Статья
08/02/2023

Область применения: Центр партнеров

Как получить состояние пакетной отправки устройства для указанного клиента.

Соответствующие роли: глобальный администратор | Агент администрирования | Агент продаж

Предварительные требования

Учетные данные, описанные в статье о проверке подлинности в Центре партнеров. Этот сценарий поддерживает проверку подлинности с помощью автономных учетных данных приложения и приложения и пользователя.
Идентификатор клиента (customer-tenant-id). Если вы не знаете идентификатор клиента, его можно найти в Центре партнеров, выбрав рабочую область "Клиенты" , затем клиент из списка клиентов, а затем учетная запись. На странице учетной записи клиента найдите Идентификатор Майкрософт в разделе Сведения об учетной записи клиента. Идентификатор Майкрософт совпадает с идентификатором клиента (customer-tenant-id).
Идентификатор отслеживания пакетной службы, возвращенный в заголовке location при отправке пакета устройства. Дополнительные сведения см. в разделе "Отправка списка устройств для указанного клиента".

C#

Чтобы получить состояние пакетной отправки устройства, сначала вызовите метод IAggregatePartner.Customers.ById с идентификатором клиента, чтобы получить интерфейс для операций с указанным клиентом. Затем вызовите метод BatchUploadStatus.ById с идентификатором отслеживания пакетной службы, чтобы получить интерфейс для операций пакетной отправки состояния. Наконец, вызовите метод Get или GetAsync , чтобы получить состояние.

// IAggregatePartner partnerOperations;
// string selectedCustomerId;
// string selectedTrackingId;

var status =
    partnerOperations.Customers.ById(selectedCustomerId).BatchUploadStatus.ById(selectedTrackingId).Get();

Пример: тестовое приложение консоли. Проект: Класс примеров пакета SDK Центра партнеров: GetBatchUploadStatus.cs

Запрос REST

Синтаксис запроса

Метод	URI запроса
GET	{baseURL}/v1/customers/{customer-id}/batchJobStatus/{batchtracking-id} HTTP/1.1

Параметр универсального кода ресурса

При создании запроса используйте следующие параметры пути.

Имя	Тип	Обязательно	Описание
customer-id	строка	Да	Строка в формате GUID, определяющая клиент.
batchtracking-id	строка	Да	Идентификатор с форматом GUID, используемый для получения состояния пакетной отправки устройства. Этот идентификатор возвращается в заголовке location, когда пакет устройства успешно отправлен.

Заголовки запросов

Дополнительные сведения см. в статье о заголовках REST Центра партнеров.

Текст запроса

Отсутствуют

Пример запроса

GET https://api.partnercenter.microsoft.com/v1/customers/47021739-3426-40bf-9601-61b4b6d7c793/batchjobstatus/0127ed8e-ff72-4983-a3d8-e8d8bd378932 HTTP/1.1
Authorization: Bearer <token>
Accept: application/json
MS-RequestId: e88d014d-ab70-41de-90a0-f7fd1797267d
MS-CorrelationId: de894e18-f027-4ac0-8b5a-34f0c222af0c
X-Locale: en-US
Host: api.partnercenter.microsoft.com

Ответ REST

В случае успешного выполнения ответ содержит ресурс BatchUploadDetails .

Коды успешного выполнения и ошибок в ответе

Каждый ответ сопровождается кодом состояния HTTP, обозначающим успешное или неудачное выполнение, и дополнительными сведениями для отладки. Используйте средство трассировки сети, чтобы просматривать этот код, тип ошибки и дополнительные параметры. Полный список ответов есть в статье Коды ошибок REST в Центре партнеров.

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

HTTP/1.1 200 OK
Content-Length: 400
MS-CorrelationId: 4a5002a2-0c1b-4e57-b491-dbcf19c0e7b8
MS-RequestId: 7b3e2e00-b330-4480-9d84-59ace713427f
MS-CV: YrLe3w6BbUSMt1fi.0
MS-ServerId: 030020344
Date: Tue, 25 Jul 2017 17:52:41 GMT

{
    "batchTrackingId": "0127ed8e-ff72-4983-a3d8-e8d8bd378932",
    "status": "finished",
    "startedTime": "2017-07-25T10:00:00",
    "completedTime": "2017-07-25T10:10:00",
    "devicesStatus": [{
            "serialNumber": "1234567890",
            "productKey": "12345-67890-09876-54321-13579",
            "status": "finished_with_errors",
            "errorCode": "808",
            "errorDescription": "ZtdDeviceAssignedToOtherTenant",
            "attributes": {
                "objectType": "DeviceUploadDetails"
            }
        }
    ],
    "attributes": {
        "objectType": "BatchUploadDetails"
    }
}

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