DescribeReservedInstances - Elastic Compute Service - Centro de documentación de Alibaba Cloud

Consulta los detalles de las instancias reservadas que ha comprado en una región especificada. Puede filtrar los resultados por etiquetas, atributos de instancia reservada y otros parámetros.

Descripción de la operación

Escenarios

Consultar todas las instancias reservadas en una región especificada.
Consultar los detalles de una instancia reservada por su ID o nombre.
Filtrar instancias reservadas por tipo de instancia o familia de instancias.
Filtrar instancias reservadas por ámbito o estado.

Ejemplos de solicitud

Ejemplo: Consultar todas las instancias reservadas compradas en la región China (Hangzhou)

"Region":"cn-hangzhou" // Establezca la región en China (Hangzhou).

Ejemplo: Consultar los detalles de la instancia reservada cuyo ID es ecsri-bp129enntoynwwj5**** en la región China (Hangzhou)

"Region":"cn-hangzhou", // Establezca la región en China (Hangzhou).
"ReservedInstanceId":"ecsri-bp129enntoynwwj5****" // Establezca el ID de la instancia reservada.

Ejemplo: Consultar las instancias reservadas que se pueden aplicar a instancias ecs.c5.2xlarge en la región China (Hangzhou)

"Region":"cn-hangzhou", // Establezca la región en China (Hangzhou).
"InstanceType":"ecs.c5.2xlarge" // Establezca el tipo de instancia.

Ejemplo: Consultar las instancias reservadas regionales activas en la región China (Hangzhou)

"Region":"cn-hangzhou", // Establezca la región en China (Hangzhou).
"Scope":"Region", // Establezca el ámbito de la instancia reservada.
"Status":["Active"] // Establezca el estado en Active.

Pruébelo ahora

Pruebe esta API en OpenAPI Explorer sin necesidad de firma manual. Las llamadas exitosas generan automáticamente código SDK acorde a sus parámetros. Descárguelo con seguridad de credenciales integrada para uso local.

Test

Autorización de RAM

La siguiente tabla describe la autorización necesaria para invocar esta API. Puede definirla en una directiva de Resource Access Management (RAM). A continuación, se detallan las columnas de la tabla:

Action: Estas acciones se utilizan en el elemento Action de las declaraciones de directivas de permisos de RAM para otorgar permisos que permitan realizar la operación.
API: La API que debe invocarse para llevar a cabo la acción.
Nivel de acceso: Nivel de acceso predefinido que se concede para cada API. Valores válidos: create, list, get, update y delete.
Tipo de recurso: Tipo de recurso que admite autorización para ejecutar la acción. Indica si la acción es compatible con permisos a nivel de recurso. El recurso especificado debe ser compatible con la acción; de lo contrario, la directiva no surtirá efecto.
- En las API con permisos a nivel de recurso, los tipos de recursos obligatorios se marcan con un asterisco (*). Especifique el Alibaba Cloud Resource Name (ARN) correspondiente en el elemento Resource de la directiva.
- Para las API sin permisos a nivel de recurso, se muestra All Resources. Utilice un asterisco (*) en el elemento Resource de la directiva.
Clave de condición: Claves de condición definidas por el servicio. Permiten un control granular y se aplican ya sea solo a acciones o a acciones asociadas con recursos específicos. Además de las claves de condición específicas del servicio, Alibaba Cloud proporciona un conjunto de common condition keys aplicables a todos los servicios compatibles con RAM.
Acción dependiente: Acciones dependientes necesarias para ejecutar la acción principal. Para completar la operación, el usuario de RAM o el rol de RAM debe contar con permisos para realizar todas las acciones dependientes.

Action

Nivel de acceso

Tipo de recurso

Clave de condición

Acción dependiente

ecs:DescribeReservedInstances

get

ReservedInstance.

acs:ecs:{#regionId}:{#accountId}:reservedinstance/*

ReservedInstance.

acs:ecs:{#regionId}:{#accountId}:reservedinstance/{#reservedinstanceId}

Ninguna

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
RegionId	string	Sí	El ID de región de la instancia reservada. Puede llamar a la operación DescribeRegions para consultar la lista de regiones más reciente.	cn-hangzhou
PageNumber	integer	No	El número de página de la lista de instancias reservadas. Las páginas comienzan desde 1. Valor predeterminado: 1.	1
PageSize	integer	No	El número de entradas por página para una consulta paginada. Valor máximo: 100. Valor predeterminado: 10.	50
Tag	array<object>	No	Las etiquetas. Longitud de la matriz: 1 a 20.
	object	No	La etiqueta.
Key	string	No	La clave de etiqueta de la instancia reservada. La clave de etiqueta no puede ser una cadena vacía y puede tener hasta 128 caracteres de longitud. No puede comenzar con aliyun o acs: y no puede contener http:// o https://. Nota Si utiliza una sola etiqueta para filtrar recursos, el recuento de recursos devuelto no puede superar los 1,000. Si utiliza varias etiquetas para filtrar recursos, el recuento de recursos que tienen varias etiquetas adjuntas no puede superar los 1,000. Si el recuento de recursos supera los 1,000, llame a la operación ListTagResources para consultar los recursos.	TestKey
Value	string	No	El valor de etiqueta de la instancia reservada. El valor de etiqueta no puede ser una cadena vacía y puede tener hasta 128 caracteres de longitud. No puede comenzar con `acs:` y no puede contener `http://` o `https://`.	TestValue
ZoneId	string	No	El ID de zona de la instancia. Este parámetro es obligatorio y solo surte efecto cuando Scope se establece en Zone. Puede llamar a la operación DescribeZones para consultar la lista de zonas.	cn-hangzhou-z
ReservedInstanceName	string	No	El nombre de la instancia reservada. Nota Se utiliza la coincidencia exacta. No se admite la coincidencia aproximada.	testReservedInstanceName
LockReason	string	No	El tipo de bloqueo. Valores válidos: financial: La cuenta tiene pagos vencidos o el servicio ha caducado. security: La instancia está bloqueada por motivos de seguridad.	security
InstanceType	string	No	El tipo de instancia que coincide con la instancia reservada. Para obtener más información, consulte Familias de instancias. Nota Este es el tipo de instancia seleccionado cuando compra la instancia reservada. Cuando se aplica la instancia reservada, una instancia reservada regional se puede aplicar a diferentes tipos de instancia dentro de la misma familia de instancias según el cálculo de equivalencia.	ecs.g5.large
InstanceTypeFamily	string	No	La familia de instancias que coincide con la instancia reservada. Para obtener más información, consulte Familias de instancias.	ecs.g5
Scope	string	No	El ámbito de la instancia reservada. Valores válidos: Region: regional. Zone: zonal.	Region
OfferingType	string	No	El tipo de pago de la instancia reservada. Valores válidos: No Upfront: sin pago por adelantado. Partial Upfront: pago parcial por adelantado. All Upfront: pago total por adelantado.	All Upfront
AllocationType	string	No	El tipo de asignación. Valores válidos: Normal: consulta las instancias reservadas en la cuenta actual. Shared: consulta las instancias reservadas que se comparten entre la cuenta principal y las cuentas vinculadas en la cuenta actual. Valor predeterminado: Normal.	Normal
ReservedInstanceId	array	No	Los ID de las instancias reservadas. Longitud de la matriz: 1 a 100.	ri-bpzhex2ulpzf53****
	string	No	El ID de la instancia reservada.	ri-bpzhex2ulpzf53****
Status	array	No	Los estados de las instancias reservadas.	Active
	string	No	El estado de la instancia reservada. Valores válidos: Creating: La instancia reservada se está creando. Active: La instancia reservada está activa. Retired: La instancia reservada está retirada. Updating: Los atributos de la instancia reservada se están modificando. Expired: La instancia reservada ha caducado. Una instancia reservada deja de ser válida inmediatamente después de caducar. Este valor está obsoleto y se eliminará en el futuro.	Active

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object
PageSize	integer	El número de entradas por página.	1
RequestId	string	El ID de la solicitud.	E572643C-6A29-49D6-9D4E-6CFA4E063A3E
PageNumber	integer	El número de página de la lista de instancias reservadas.	1
TotalCount	integer	El número total de instancias reservadas.	1
ReservedInstances	object
ReservedInstance	array<object>	Los detalles de las instancias reservadas.
	array<object>	Los detalles de la instancia reservada.
Status	string	El estado.	Active
CreationTime	string	La hora de creación. La hora sigue el estándar ISO 8601 y se muestra en UTC.	2018-12-10T12:07Z
ReservedInstanceName	string	El nombre.	riZbpzhex2ulpzf53****
ReservedInstanceId	string	El ID de la instancia reservada.	ri-bpzhex2ulpzf53****
InstanceType	string	El tipo de instancia de la instancia de pago por uso coincidente.	ecs.g5.large
InstanceAmount	integer	El número de instancias de pago por uso del mismo tipo de instancia que se pueden hacer coincidir.	10
RegionId	string	El ID de la región.	cn-hangzhou
OfferingType	string	El tipo de pago.	All Upfront
StartTime	string	El período de vigencia. El formato es ISO 8601 y la zona horaria es UTC.	2018-12-10T12:00Z
Description	string	La descripción.	testDescription
AllocationStatus	string	El estado de asignación de la instancia reservada. Este parámetro se devuelve solo cuando AllocationType se establece en Shared. Valores válidos: allocated: La instancia reservada se asigna a otros usuarios. beAllocated: La instancia reservada es asignada por otros usuarios.	allocated
ExpiredTime	string	La hora de caducidad. La hora sigue el estándar ISO 8601 y se muestra en UTC.	2019-12-10T12:07Z
ResourceGroupId	string	El grupo de recursos.	EcsDocTest
ZoneId	string	El ID de la zona.	cn-hangzhou-z
Platform	string	El tipo de sistema operativo de la imagen que utiliza la instancia. Valores válidos: Windows: Sistemas operativos Windows Server. Linux: Sistemas operativos Linux y tipo Unix.	Linux
Scope	string	El ámbito.	region
OperationLocks	object
OperationLock	array<object>	Indica si la instancia está bloqueada.
	object	Indica si la instancia está bloqueada.
LockReason	string	El motivo del bloqueo.	security
Tags	object
Tag	array<object>	Las etiquetas de la instancia reservada.
	object	La etiqueta de la instancia reservada.
TagValue	string	El valor de etiqueta de la instancia reservada.	TestValue
TagKey	string	La clave de etiqueta de la instancia reservada.	TestKey

Ejemplos

Respuesta exitosa

JSON Formato

{
  "PageSize": 1,
  "RequestId": "E572643C-6A29-49D6-9D4E-6CFA4E063A3E",
  "PageNumber": 1,
  "TotalCount": 1,
  "ReservedInstances": {
    "ReservedInstance": [
      {
        "Status": "Active",
        "CreationTime": "2018-12-10T12:07Z",
        "ReservedInstanceName": "riZbpzhex2ulpzf53****",
        "ReservedInstanceId": "ri-bpzhex2ulpzf53****",
        "InstanceType": "ecs.g5.large",
        "InstanceAmount": 10,
        "RegionId": "cn-hangzhou",
        "OfferingType": "All Upfront",
        "StartTime": "2018-12-10T12:00Z",
        "Description": "testDescription",
        "AllocationStatus": "allocated",
        "ExpiredTime": "2019-12-10T12:07Z",
        "ResourceGroupId": "EcsDocTest",
        "ZoneId": "cn-hangzhou-z",
        "Platform": "Linux",
        "Scope": "region",
        "OperationLocks": {
          "OperationLock": [
            {
              "LockReason": "security"
            }
          ]
        },
        "Tags": {
          "Tag": [
            {
              "TagValue": "TestValue",
              "TagKey": "TestKey"
            }
          ]
        }
      }
    ]
  }
}

Códigos de error

Código de estado HTTP	Código de error	Mensaje de error	Descripción
400	MissingParamter.RegionId	The regionId should not be null.	El parámetro RegionId no puede estar vacío.
400	InvalidRegion.NotFound	The specified parameter RegionId is not valid.	El parámetro RegionId no es válido.
400	InvalidZone.NotFound	The specified parameter ZoneId is not valid.	El ZoneId especificado no es válido.
400	InvalidReservedInstanceOfferingType.ValueNotSupported	the OfferingType is not supported
400	InvalidReservedInstanceOfferingClass.ValueNotSupported	the OfferingClass is not supported
400	OperationDenied	The specified InstanceType or Zone is not authorized for current user.
400	InvalidEndTime.ValueNotSupported	The specified endTime is out of the permitted range.	El parámetro EndTime no es válido.
400	InvalidReservedInstanceLockReason.ValueNotSupported	The specified LockReason is not supported.
400	InvalidReservedInstanceStatus.ValueNotSupported	The specified Status is not supported.
400	InvalidAllocationType.ValueNotSupported	The specified AllocationType is not supported.	El tipo de asignación especificado no es válido.
403	RAM.ApiNotSupported	This call is not supported from ram accessing.	El usuario RAM no tiene permiso para realizar esta operación.
404	InvalidRegionId.NotFound	The specified RegionId does not exist in our records.	El RegionId especificado no existe. Verifique si el producto está disponible en esta región.

Consulte Códigos de error para ver la lista completa.

Notas de la versión

Consulte Notas de la versión para ver la lista completa.