DescribeReservedInstances - - Centro de documentación de Alibaba Cloud

Consulta las reserved instances adquiridas.

Depuración

OpenAPI Explorer calcula automáticamente el valor de la firma. Para su comodidad, le recomendamos que ejecute esta operación en OpenAPI Explorer. OpenAPI Explorer genera dinámicamente el código de ejemplo de la operación para diferentes SDKs.

Parámetros de solicitud

Parámetro	Tipo	Obligatorio	Ejemplo	Descripción
Action	String	Sí	DescribeReservedInstances	La operación que desea ejecutar. Establezca el valor en DescribeReservedInstances.
RegionId	String	Sí	cn-hangzhou	El ID de región de las reserved instances. Puede llamar a la operación DescribeRegions para consultar la lista de regiones más reciente.
PageNumber	Integer	No	1	El número de página. Las páginas comienzan desde la página 1. Valor predeterminado: 1.
PageSize	Integer	No	50	El número de entradas por página. Valor máximo: 100. Valor predeterminado: 10.
Tag.N.Key	String	No	TestKey	La clave de la etiqueta N de la reserved instance. Valores válidos de N: 1 a 20. La clave de la etiqueta no puede ser una cadena vacía. La clave de la etiqueta puede tener hasta 128 caracteres y no puede comenzar con acs: ni aliyun. No puede contener http:// ni https://. Si especifica una sola etiqueta para consultar recursos, se devuelven hasta 1,000 recursos con dicha etiqueta. Si especifica varias etiquetas, se devuelven hasta 1,000 recursos que contienen todas las etiquetas especificadas. Para consultar más de 1,000 recursos con las etiquetas indicadas, llame a la operación ListTagResources.
Tag.N.Value	String	No	TestValue	El valor de la etiqueta N de la reserved instance. Valores válidos de N: 1 a 20. El valor de la etiqueta puede ser una cadena vacía. El valor de la etiqueta puede tener hasta 128 caracteres y no puede contener http:// ni https://. El valor de la etiqueta no puede comenzar con acs:.
ZoneId	String	No	cn-hangzhou-z	El ID de zona de la reserved instance. Este parámetro es obligatorio cuando Scope se establece en Zone. Puede llamar a la operación DescribeZones para consultar la lista de zonas más reciente.
ReservedInstanceName	String	No	testReservedInstanceName	El nombre de la reserved instance.
LockReason	String	No	security	El motivo por el que la reserved instance está bloqueada. Valores válidos: financial: bloquea la reserved instance porque la cuenta tiene pagos pendientes o el servicio ha caducado. security: bloquea la reserved instance por motivos de seguridad.
InstanceType	String	No	ecs.g5.large	El tipo de instancia de la reserved instance. Para obtener información sobre los valores, consulte Overview of instance families.
InstanceTypeFamily	String	No	ecs.g5	La familia de instancias de la reserved instance. Para obtener información sobre los valores, consulte Overview of instance families.
Scope	String	No	Region	El alcance de la reserved instance. Valores válidos: Region Zone Valor predeterminado: Region.
OfferingType	String	No	All Upfront	El método de facturación de la reserved instance. Valores válidos: No Upfront Partial Upfront All Upfront
AllocationType	String	No	Normal	El tipo de asignación de las reserved instances. Valores válidos: Normal: consulta todas las reserved instances que pertenecen a la cuenta actual. Shared: consulta las reserved instances compartidas entre la cuenta principal actual y las cuentas vinculadas. Valor predeterminado: Normal.
ReservedInstanceId.N	String	No	ri-bpzhex2ulpzf53****	El ID de la reserved instance N. Valores válidos de N: 1 a 100.
Status.N	String	No	Active	El estado de la reserved instance N. Valores válidos de N: 1 a 100. Valores válidos: Creating: La reserved instance se está creando. Active: La reserved instance está activa. Expired: La reserved instance ha caducado. Updating: Se están modificando las propiedades de la reserved instance.

Parámetros de respuesta

Parámetro	Tipo	Ejemplo	Descripción
PageSize	Integer	1	El número de entradas por página.
RequestId	String	E572643C-6A29-49D6-9D4E-6CFA4E063A3E	El ID de la solicitud.
PageNumber	Integer	1	El número de página.
TotalCount	Integer	1	El número total de reserved instances.
ReservedInstances	Array of ReservedInstance		Detalles sobre las reserved instances.
ReservedInstance
Status	String	Active	El estado de la reserved instance.
CreationTime	String	2018-12-10T12:07Z	La hora en que se creó la reserved instance.
ReservedInstanceName	String	riZbpzhex2ulpzf53****	El nombre de la reserved instance.
ReservedInstanceId	String	ri-bpzhex2ulpzf53****	El ID de la reserved instance.
InstanceType	String	ecs.g5.large	El tipo de instancia de las instancias pay-as-you-go que coinciden con cada reserved instance.
InstanceAmount	Integer	10	El número de instancias pay-as-you-go del mismo tipo que la reserved instance y que pueden coincidir con ella.
RegionId	String	cn-hangzhou	El ID de región de la reserved instance.
OfferingType	String	All Upfront	El método de facturación de la reserved instance.
StartTime	String	2018-12-10T12:00Z	La hora en que entraron en vigor las reserved instances.
Description	String	testDescription	La descripción de la reserved instance.
AllocationStatus	String	allocated	El estado de asignación de la reserved instance cuando el parámetro AllocationType se establece en Shared. Valores válidos: allocated: La reserved instance está asignada a otra cuenta. beAllocated: Otra cuenta tiene asignada la reserved instance.
ExpiredTime	String	2019-12-10T12:07Z	La hora en que caduca la reserved instance.
ResourceGroupId	String	EcsDocTest	El ID del resource group.
ZoneId	String	cn-hangzhou-z	El ID de la zona.
Platform	String	Linux	El tipo de sistema operativo. Valores válidos: Windows Linux
Scope	String	region	El alcance de la reserved instance.
OperationLocks	Array of OperationLock		Detalles sobre el estado de bloqueo de las reserved instances.
OperationLock
LockReason	String	security	El motivo por el que se bloqueó la reserved instance.
Tags	Array of Tag		Las etiquetas de la reserved instance.
Tag
TagValue	String	TestValue	El valor de la etiqueta de la reserved instance.
TagKey	String	TestKey	La clave de la etiqueta de la reserved instance.

Ejemplos

Solicitudes de ejemplo

https://ecs.aliyuncs.com/?Action=DescribeReservedInstances
&RegionId=cn-hangzhou
&Scope=Region
&<Common request parameters>

Respuestas exitosas de ejemplo

XML formato

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeReservedInstancesResponse>
    <ReservedInstances>
        <ReservedInstance>
            <CreationTime>2018-12-10T12:07Z</CreationTime>
            <ExpiredTime>2019-12-10T16:00Z</ExpiredTime>
            <InstanceAmount>1</InstanceAmount>
            <ReservedInstanceId>ri-0xzhex2ulpzf53****</ReservedInstanceId>
            <InstanceType>ecs.g5.large</InstanceType>
            <OfferingType>All Upfront</OfferingType>
            <RegionId>cn-hangzhou-test-307</RegionId>
            <ReservedInstanceName>riZ0xzhex2ulpzf53****</ReservedInstanceName>
            <Scope>region</Scope>
            <StartTime>2018-12-10T12:00Z</StartTime>
            <Status>Active</Status>
            <Tags>
                <Tag>
                    <TagKey>TestKey</TagKey>
                    <TagValue>TestValue</TagValue>
                </Tag>
            </Tags>
        </ReservedInstance>
    </ReservedInstances>
    <RequestId>E572643C-6A29-49D6-9D4E-6CFA4E063A3E</RequestId>
    <PageNumber>1</PageNumber>
    <PageSize>50</PageSize>
    <Total>1</Total>
</DescribeReservedInstancesResponse>

JSON formato

HTTP/1.1 200 OK
Content-Type:application/json

{
  "ReservedInstances" : {
    "ReservedInstance" : [ {
      "CreationTime" : "2018-12-10T12:07Z",
      "ExpiredTime" : "2019-12-10T16:00Z",
      "InstanceAmount" : 1,
      "ReservedInstanceId" : "ri-0xzhex2ulpzf53****",
      "InstanceType" : "ecs.g5.large",
      "OfferingType" : "All Upfront",
      "RegionId" : "cn-hangzhou-test-307",
      "ReservedInstanceName" : "riZ0xzhex2ulpzf53****",
      "Scope" : "region",
      "StartTime" : "2018-12-10T12:00Z",
      "Status" : "Active",
      "Tags" : {
        "Tag" : [ {
          "TagKey" : "TestKey",
          "TagValue" : "TestValue"
        } ]
      }
    } ]
  },
  "RequestId" : "E572643C-6A29-49D6-9D4E-6CFA4E063A3E",
  "PageNumber" : 1,
  "PageSize" : 50,
  "Total" : 1
}

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.	RegionId es obligatorio.
400	InvalidRegion.NotFound	The specified parameter RegionId is not valid.	Valor de RegionId no válido.
400	InvalidZone.NotFound	The specified parameter ZoneId is not valid.	Valor de ZoneId no válido.
400	InvalidEndTime.ValueNotSupported	The specified endTime is out of the permitted range.	Valor de EndTime no válido.
400	InvalidAllocationType.ValueNotSupported	The specified AllocationType is not supported.	Valor de AllocationType no válido.
404	InvalidRegionId.NotFound	The specified RegionId does not exist in our records.	No se encuentra el valor de RegionId. Compruebe si el servicio está disponible en la región especificada.

Para obtener una lista de códigos de error, consulte Códigos de error del servicio.