Obter um Suplemento (Suplemento de Inquilino)
Aplica-se a: Windows Azure Pack
Obtém um suplemento.
Pedir
Substitua <ServiceMgmt> pelo endereço do ponto final da API de Gestão de Serviços. Substitua <AddonId> pelo identificador de suplemento do suplemento.
Método |
URI do pedido |
Versão HTTP |
|---|---|---|
GET |
<https:// ServiceMgmt>:30005/addons/<AddonId> |
HTTP/1.1 |
Parâmetros do URI
Nenhum.
Cabeçalhos do Pedido
A tabela seguinte descreve os cabeçalhos de pedido obrigatórios e opcionais.
Cabeçalho do pedido |
Description |
|---|---|
Autorização: Portador |
Obrigatório. O token do portador de autorização. |
x-ms-principal-id |
Obrigatório. O identificador principal. |
x-ms-client-request-id |
Opcional. O identificador do pedido de cliente. |
x-ms-client-session-id |
Opcional. O identificador da sessão do cliente. |
x-ms-principal-liveid |
Opcional. O principal identificador em direto. |
Corpo do Pedido
A tabela seguinte descreve os elementos do corpo do pedido.
Nome do elemento |
Descrição |
|---|---|
includePrice |
Opcional. O suplemento inclui o preço. |
region |
Opcional. A região do suplemento. |
subscriptionId |
Opcional. O identificador da subscrição. |
nome de utilizador |
Opcional. O nome de utilizador do suplemento. |
Existem quatro opções de chamadas. Se for utilizada outra combinação de opções, a operação não terá um corpo de pedido.
Opção |
Requisito |
|---|---|
AddonID apenas no URI de chamada |
Sem corpo do pedido. |
includeprice, region, username & SubscriptionId. |
O nome de utilizador e o subscriptionId fornecidos. |
Includeprice, region & username |
O nome de utilizador fornecido. |
includeprice, region e subscriptionId |
O subscriptionId fornecido. |
Resposta
A resposta inclui um código de estado HTTP, um conjunto de cabeçalhos de resposta e um corpo de resposta.
Código de Estado
Uma operação bem-sucedida devolve o código de estado 200 (OK).
Para obter informações sobre códigos de estado, veja Códigos de Estado e Erro (Windows Azure Pack Service Management).
Cabeçalhos de Resposta
A resposta para esta operação inclui cabeçalhos HTTP padrão. Todos os cabeçalhos padrão estão em conformidade com a especificação do protocolo HTTP/1.1.
Corpo da Resposta
A tabela seguinte descreve os elementos-chave do corpo da resposta:
Nome do elemento |
Descrição |
|---|---|
PlanAddOn |
O suplemento que foi obtido. Para obter mais informações, veja PlanAddon (objeto administrador). |
Exemplo
O seguinte exemplo de código mostra um pedido Obter Suplemento .
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
O seguinte exemplo de código mostra uma resposta Obter Suplemento .
{
"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
}