Recuperar um complemento (complemento de locatário)
Aplica-se a: Windows Azure Pack
Recupera um complemento.
Solicitação
Substitua <ServiceMgmt> pelo endereço do ponto de extremidade da API de Gerenciamento de Serviços. Substitua <AddonId> pelo identificador de complemento do complemento.
Método |
URI da solicitação |
Versão HTTP |
|---|---|---|
GET |
<https:// ServiceMgmt>:30005/addons/<AddonId> |
HTTP/1.1 |
Parâmetros de URI
Nenhum.
Cabeçalhos de solicitação
A tabela a seguir descreve os cabeçalhos de solicitação obrigatórios e opcionais.
Cabeçalho da solicitação |
Descrição |
|---|---|
Autorização: Portador |
Obrigatórios. O token de portador de autorização. |
x-ms-principal-id |
Obrigatórios. O identificador principal. |
x-ms-client-request-id |
Opcional. O identificador de solicitação do cliente. |
x-ms-client-session-id |
Opcional. O identificador de sessão do cliente. |
x-ms-principal-liveid |
Opcional. O principal identificador ao vivo. |
Corpo da solicitação
A tabela a seguir descreve os elementos do corpo da solicitação.
Nome do elemento |
Descrição |
|---|---|
includePrice |
Opcional. O complemento inclui o preço. |
region |
Opcional. A região do complemento. |
subscriptionId |
Opcional. O identificador da assinatura. |
Nome de Usuário |
Opcional. O nome de usuário do complemento. |
Há 4 opções de chamada. Se qualquer outra combinação de opções for usada, a operação não terá um corpo da solicitação.
Opção |
Requisito |
|---|---|
AddonID somente no URI de chamada |
Nenhum corpo da solicitação. |
includeprice, region, username & SubscriptionId. |
O nome de usuário e subscriptionId fornecidos. |
Includeprice, nome de usuário & região |
O nome de usuário fornecido. |
includeprice, region e subscriptionId |
A subscriptionId fornecida. |
Resposta
A resposta inclui um código de status HTTP, um conjunto de cabeçalhos de resposta e um corpo de resposta.
Código de status
Uma operação bem-sucedida retorna o código de status 200 (OK).
Para obter informações sobre códigos status, consulte Códigos de status e de erro (Gerenciamento de Serviços do Windows Azure Pack).
Cabeçalhos de resposta
A resposta para essa 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 a seguir descreve os principais elementos do corpo da resposta:
Nome do elemento |
Descrição |
|---|---|
PlanAddOn |
O complemento que foi recuperado. Para obter mais informações, consulte PlanAddon (objeto Administrator). |
Exemplo
O exemplo de código a seguir mostra uma solicitação Obter Complemento .
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 exemplo de código a seguir mostra uma resposta Obter Complemento .
{
"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
}