Получение надстройки (надстройка клиента)

Статья
08/24/2015

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

Извлекает надстройку.

Запрос

Замените <ServiceMgmt> адресом конечной точки API управления службами. Замените <AddonId> идентификатором надстройки.

Метод	Универсальный код ресурса (URI) запроса	параметр "Версия HTTP"
GET	<https:// ServiceMgmt>:30005/addons/<AddonId>	HTTP/1.1

Параметры URI

Нет.

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

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

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

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

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

Имя элемента	Описание
includePrice	Необязательный элемент. Надстройка включает цену.
region	Необязательный элемент. Регион надстройки.
subscriptionId	Необязательный элемент. Идентификатор подписки.
username	Необязательный параметр. Имя пользователя надстройки.

Существует 4 варианта вызова. Если используется какое-либо другое сочетание параметров, операция не будет содержать текст запроса.

Параметр	Требование
AddonID только в URI вызова	Текст запроса отсутствует.
includeprice, region, username & SubscriptionId.	Указанные имя пользователя и идентификатор подписки.
Includeprice, регион & имя пользователя	Указанное имя пользователя.
includeprice, region и subscriptionId	Указанный идентификатор подписки.

Ответ

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

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

Успешная операция возвращает код состояния 200 (ОК).

Дополнительные сведения о кодах состояний см. в статье Status and Error Codes (Windows Azure Pack Service Management).

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

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

Текст ответа

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

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

Пример

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

GET https://<computer>:30004/addons/MyTeshixk1xiz HTTP/1.1
Authorization: Bearer 
x-ms-client-request-id: 5f7abeba-03fd-41ab-92f1-1ef4ee5507f3-2013-07-09 22:02:35Z
x-ms-client-session-id: 4d317dde-d7c1-495e-a819-9802dc021e2f
x-ms-principal-id: <computer>\Administrator
Accept-Language: en-US
x-ms-principal-liveid: <computer>\Administrator
Host: <computer>:30004

В следующем примере кода показан ответ Get Add-on .

{
  "Id": "MyTeshixk1xiz",
  "DisplayName": "My Test Addon",
  "State": 0,
  "ConfigState": 1,
  "QuotaSyncState": 0,
  "LastErrorMessage": null,
  "Advertisements": [
    {
      "LanguageCode": "en-us",
      "DisplayName": "My Test Addon",
      "Description": null
    }
  ],
  "ServiceQuotas": [
    {
      "ServiceName": "sqlservers",
      "ServiceInstanceId": "85D94D4A-6ADF-47A6-BAEF-A01975742308",
      "ServiceDisplayName": "SQL Servers",
      "ServiceInstanceDisplayName": "SQL Servers",
      "ConfigState": 1,
      "QuotaSyncState": 0,
      "Settings": [
        {
          "Key": "Editions",
          "Value": "[{\"groupName\":\"Default\",\"resourceCount\":\"1\",\"resourceSize\":\"10\",\"offerEditionId\":\"1373402022182\"}]"
        }
      ]
    }
  ],
  "SubscriptionCount": 0,
  "AssociatedPlans": [

  ],
  "MaxOccurrencesPerPlan": 1,
  "Price": null
}

См. также:

Интерфейсы плана администратора

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