Получение подписки для уведомления

Статья
08/24/2015

Область применения: Windows Azure Pack

Используется API управления службами для получения сведений о подписке.

Запрос

Замените <NotificationEndpoint> адресом конечной точки для Windows REST API уведомлений пользовательского поставщика ресурсов Azure Pack. Замените <идентификатор> идентификатором извлекаемой подписки.

Метод	Универсальный код ресурса (URI) запроса	параметр "Версия HTTP"
GET	<http:// NotificationEndpoint>/subscriptions/<Id>	HTTP/1.1

Параметры URI

Отсутствует.

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

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

Заголовок запроса	Описание
Авторизация: базовый	Обязательный. Базовый маркер авторизации.
x-ms-principal-id	Обязательный. Идентификатор участника.
x-ms-client-request-id	Необязательный элемент. Идентификатор запроса клиента.
x-ms-client-session-id	Необязательный элемент. Идентификатор сеанса клиента.
x-ms-principal-liveid	Необязательный элемент. Идентификатор основной динамической трансляции.

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

Отсутствует.

Ответ

Ответ включает код состояния HTTP, набор заголовков ответа и текст ответа.

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

Возвращает код состояния 200 (ОК), если операция выполнена успешно.

Сведения о кодах состояния см. в разделе "Коды состояния" и "Коды ошибок" (Windows управления пакетом обновления Azure).

Заголовки откликов

Ответ для этой операции включает стандартные заголовки HTTP. Все стандартные заголовки соответствуют спецификации протокола HTTP/1.1.

Текст ответа

В следующей таблице описываются ключевые элементы текста ответа.

Имя элемента	Описание
Подписка	Полученная подписка. Дополнительные сведения см. в разделе "Подписка " (объект конечной точки уведомления)".

Пример

В следующем примере показано получение подписки для запроса на уведомление .

GET https://<NotificationEndpoint>:30010/subscriptions/ec66ec96-8edd-4916-be45-607959155c2a HTTP/1.1
Referer: https://<Computer>:30004/subscriptions/ec66ec96-8edd-4916-be45-607959155c2a
Accept-Language: en-US
x-ms-client-request-id: ef2c5d93-a957-439b-9210-de52107322c1-2014-07-09 23:45:22Z
x-ms-client-session-id: a519f0aa-53e9-4522-94fd-3c55607a6b65
x-ms-principal-id: <Computer>%5cAdministrator
x-ms-request-id: 684b6822d29e4aac96fe45110881e525.2014-07-09T23:45:24.2267567Z
Authorization: Basic <encoded username and password>
Content-Type: application/json; charset=utf-8
Host: <Computer>:30010
Content-Length: 0
Expect: 100-continue

В следующем примере кода показан ответ JSON для получения подписки для уведомления.

{
  "SubscriptionId": "ec66ec96-8edd-4916-be45-607959155c2a",
  "SubscriptionName": null,
  "State": 1,
  "LifecycleState": 0,
  "LastErrorMessage": null,
  "QuotaSettings": [
    {
      "Key": "Editions",
      "Value": "[{\"displayName\":\"Default\",\"groupName\":\"Default\",\"resourceCount\":\"10\",\"resourceSize\":\"1024\",\"resourceSizeLimit\":\"0\",\"offerEditionId\":\"32814080310\",\"groupType\":\"Shared\"}]"
    }
  ],
  "AdminId": "notauser@contoso.com",
  "CoAdminIds": [

  ]
}

Примечания

Свойство QuotaSettings должно быть заполнено в ответе.

Если поставщик ресурсов использует асинхронную операцию подписки, поставщик ресурсов возвращает 202 из асинхронной операции, ТО TBD вызывается каждые 10 секунд API управления службами, чтобы определить, завершена ли операция.

TBD используется во время обновления системы с Windows Azure Pack версии 1.

См. также:

Справочник по REST API уведомлений пользовательского поставщика ресурсов Windows Пакета Azure

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