Recuperar un complemento (complemento de inquilino)
Se aplica a: Windows Azure Pack
Recupera un complemento.
Solicitud
Reemplace <ServiceMgmt> por la dirección del punto de conexión de la API de Service Management. Reemplace <AddonId> por el identificador de complemento del complemento.
Método |
URI de solicitud |
Versión de HTTP |
|---|---|---|
GET |
<https:// ServiceMgmt>:30005/addons/<AddonId> |
HTTP/1.1 |
Parámetros de identificador URI
Ninguno.
Encabezados de solicitud
En la tabla siguiente se describen los encabezados de solicitud requeridos y opcionales.
Encabezado de solicitud |
Descripción |
|---|---|
Autorización: Portador |
Necesario. Token de portador de autorización. |
x-ms-principal-id |
Necesario. El identificador de la entidad de seguridad. |
x-ms-client-request-id |
Opcional. Identificador de solicitud de cliente. |
x-ms-client-session-id |
Opcional. Identificador de sesión de cliente. |
x-ms-principal-liveid |
Opcional. Identificador activo principal. |
Cuerpo de la solicitud
En la tabla siguiente se describen los elementos del cuerpo de la solicitud.
Nombre del elemento |
Descripción |
|---|---|
includePrice |
Opcional. El complemento incluye el precio. |
region |
Opcional. Región del complemento. |
subscriptionId |
Opcional. Identificador de la suscripción. |
username |
Opcional. Nombre de usuario del complemento. |
Hay 4 opciones de llamada. Si se usa cualquier otra combinación de opciones, la operación no tendrá un cuerpo de solicitud.
Opción |
Requisito |
|---|---|
AddonID solo en el URI de llamada |
No hay cuerpo de solicitud. |
includeprice, region, username & SubscriptionId. |
Nombre de usuario y subscriptionId proporcionado. |
Includeprice, nombre de usuario de & región |
Nombre de usuario proporcionado. |
includeprice, region y subscriptionId |
SubscriptionId proporcionado. |
Response
La respuesta incluye un código de estado HTTP, un conjunto de encabezados de respuesta y un cuerpo de respuesta.
Código de estado
Una operación correcta devuelve el código de estado 200 Correcto.
Para obtener información sobre los códigos de estado, consulte Códigos de estado y error (Administración de servicios de Windows Azure Pack).
Encabezados de respuesta
La respuesta de esta operación incluye encabezados HTTP estándar. Todos los encabezados estándar se ajustan a la especificación del protocolo HTTP/1.1.
Cuerpo de la respuesta
La tabla siguiente describe los elementos clave del cuerpo de la respuesta:
Nombre del elemento |
Descripción |
|---|---|
PlanAddOn |
Complemento que se recuperó. Para obtener más información, vea PlanAddon (objeto Administrator). |
Ejemplo
En el ejemplo de código siguiente se muestra una solicitud Obtener 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
En el ejemplo de código siguiente se muestra una respuesta Obtener 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
}