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

Consulta los detalles de una o más reservas de capacidad, como el estado, la hora de entrada en vigor y de vencimiento, el modo de pool privado y el número de instancias consumidas.

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:DescribeCapacityReservations

get

*CapacityReservation.

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

Ninguna

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
RegionId	string	Sí	El ID de la región de la reserva de capacidad. Puede llamar a DescribeRegions para consultar la lista de regiones más reciente.	cn-hangzhou
ResourceGroupId	string	No	El ID del grupo de recursos. Cuando utiliza este parámetro para filtrar recursos, el recuento de recursos no puede superar los 1000. Nota No se admite el filtrado por el grupo de recursos predeterminado.	rg-bp67acfmxazb4p****
Tag	array<object>	No	Las etiquetas vinculadas a la reserva de capacidad.
	object	No	El par de etiquetas.
Key	string	No	La clave de la etiqueta. N especifica que puede configurar varias claves de etiqueta para el filtrado. Valores válidos de N: 1 a 20. Si utiliza una sola etiqueta para filtrar recursos, el recuento de recursos con dicha etiqueta no puede superar los 1000. Si utiliza varias etiquetas para filtrar recursos, el recuento de recursos con todas las etiquetas especificadas adjuntas no puede superar los 1000. Si el recuento de recursos supera los 1000, llame a la operación ListTagResources para consultar los recursos.	TestKey
Value	string	No	El valor de la etiqueta. N especifica que puede configurar varios valores de etiqueta para el filtrado. Valores válidos de N: 1 a 20.	TestValue
MaxResults	integer	No	El número máximo de entradas por página para una consulta paginada. Valor máximo: 100. Valor predeterminado: 10.	10
NextToken	string	No	El token de paginación para la consulta de reservas de capacidad. Obtenga el valor del resultado de la solicitud anterior.	caeba0bbb2be03f84eb48b699f0a4883
PrivatePoolOptions.Ids	string	No	La lista de ID de reservas de capacidad. El valor puede ser una matriz JSON que conste de hasta 100 ID, separados por comas (,).	["crp-bp1gubrkqutenqdd**", "crp-bp67acfmxazb5**"]
Platform	string	No	El sistema operativo de la instancia. Valores válidos: windows: consulta solo las reservas de capacidad para instancias Windows. linux: consulta solo las reservas de capacidad para instancias Linux. all: consulta todas las reservas de capacidad. Valor predeterminado: all.	linux
InstanceType	string	No	El tipo de instancia. Puede utilizar el tipo de instancia para consultar solo las reservas de capacidad activas. Las reservas de capacidad liberadas solo se pueden consultar mediante PrivatePoolOptions.Ids.	ecs.c6.large
ZoneId	string	No	El ID de la zona de la reserva de capacidad.	cn-hangzhou-h
InstanceChargeType	string	No	El método de facturación de la instancia. Valores válidos: PostPaid: pago por uso. PrePaid: suscripción. Valor predeterminado: PostPaid.	PostPaid
Status	string	No	El estado de la reserva de capacidad. Valores válidos: All: todos los estados. Pending: inicializando. Una reserva de capacidad que entra en vigor en una hora especificada entra primero en el estado de inicialización. Preparing: en preparación. Una reserva de capacidad que entra en vigor en una hora especificada se encuentra en el estado de preparación durante la fase de entrega de recursos. Prepared: por entrar en vigor. Una reserva de capacidad que entra en vigor en una hora especificada se encuentra en el estado de por entrar en vigor después de que se completa la entrega de recursos, pero antes de que el servicio entre en vigor oficialmente. Active: activa. Released: liberada, incluida la liberación manual y la liberación automática al vencer. Si no especifica este parámetro, se consultan las reservas de capacidad en todos los estados excepto Pending y Released.	Active

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object
NextToken	string	El token de paginación para la siguiente consulta.	caeba0bbb2be03f84eb48b699f0a****
RequestId	string	El ID de la solicitud.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3****
TotalCount	integer	El número total de entradas que coinciden con las condiciones de la consulta.	1
MaxResults	integer	El número máximo de entradas por página.	10
CapacityReservationSet	object
CapacityReservationItem	array<object>	Los detalles de las reservas de capacidad.
	array<object>	Los detalles de la reserva de capacidad.
Status	string	El estado de la reserva de capacidad. Valores válidos: Pending: inicializando. Preparing: en preparación. Prepared: por entrar en vigor. Active: activa. Released: liberada, incluida la liberación manual y la liberación automática al vencer.	Active
TimeSlot	string	Nota Este parámetro se encuentra en versión preliminar por invitación y no está disponible públicamente.	null
PrivatePoolOptionsMatchCriteria	string	El tipo de pool privado generado después de que la reserva de capacidad entra en vigor. Valores válidos: Open: modo abierto. El sistema asocia automáticamente la capacidad de los pools privados abiertos cuando inicia una instancia. Si no hay capacidad de pool privado coincidente disponible, se utilizan recursos del pool público para iniciar la instancia. Target: modo dirigido. La instancia se inicia utilizando la capacidad del pool privado especificado. Si la capacidad del pool privado especificado no está disponible, la instancia no se inicia.	Open
PrivatePoolOptionsId	string	El ID de la reserva de capacidad.	crp-bp1gubrkqutenqdd****
PrivatePoolOptionsName	string	El nombre del servicio de reserva de capacidad.	crpTestName
RegionId	string	El ID de la región de la reserva de capacidad.	cn-hangzhou
InstanceChargeType	string	El método de facturación de las instancias en la reserva de capacidad. Valores válidos: PostPaid: pago por uso. PrePaid: suscripción.	PostPaid
EndTime	string	La hora de vencimiento de la reserva de capacidad. La hora sigue el estándar ISO 8601 en formato UTC.	2021-02-19T03:02Z
StartTime	string	La hora de entrada en vigor de la reserva de capacidad. La hora sigue el estándar ISO 8601 en formato UTC.	2021-02-19T02:01Z
Description	string	La descripción de la reserva de capacidad.	This is description.
EndTimeType	string	El modo de liberación de la reserva de capacidad. Valores válidos: Limited: liberada en una hora especificada. Unlimited: liberación manual. No se impone ningún límite de tiempo.	Unlimited
ResourceGroupId	string	El ID del grupo de recursos de la reserva de capacidad.	rg-bp67acfmxazb4p****
Platform	string	El sistema operativo de las instancias coincidentes. Valores válidos: windows. linux.	linux
AllocatedResources	object
AllocatedResource	array<object>	La lista de detalles de asignación de recursos.
	array<object>	Los detalles de asignación de recursos.
UsedAmount	integer	El número de instancias consumidas.	2
TotalAmount	integer	El número total de instancias que se reservarán para un tipo de instancia específico.	2
AvailableAmount	integer	El número de instancias disponibles.	2
FailedAmount	integer	La capacidad fallida.	1
LockedAmount	integer	La capacidad bloqueada.	1
zoneId	string	El ID de la zona.	cn-hangzhou-h
InstanceType	string	El tipo de instancia.	ecs.c6.large
CapacityReservationUsages	object
CapacityReservationUsage	array<object>	La lista de detalles de instancias consumidas.
	object	Los detalles de las instancias consumidas.
AccountId	string	El ID de la cuenta de Alibaba Cloud.	105909559088****
ServiceName	string	El nombre del servicio de Alibaba Cloud.	maxcompute.aliyuncs.com
UsedAmount	integer	El número de instancias consumidas por la cuenta o el servicio de Alibaba Cloud.	20
Tags	object
Tag	array<object>	La lista de pares clave-valor de etiqueta vinculados a la reserva de capacidad.
	object	El par clave-valor de etiqueta vinculado a la reserva de capacidad.
TagValue	string	El valor de la etiqueta.	TestValue
TagKey	string	La clave de la etiqueta.	TestKey
StartTimeType	string	El modo en el que la reserva de capacidad entra en vigor. Valores válidos: Now: entra en vigor inmediatamente. Later: entra en vigor en una hora especificada.	Now
SavingPlanId	string	El ID del plan de ahorro asociado con la reserva de capacidad.	spn-c29b5e18pJMT****
ReservedInstanceId	string	El ID de la instancia reservada asociado con la reserva de capacidad.	ri-bpzhex2ulpzf53****
CapacityReservationOwnerId	string	El ID del propietario del plan de recursos de reserva de capacidad.	100************7
DeliveryTime	string	La hora de entrega. La hora sigue el estándar ISO 8601 en formato UTC.
UnlockedTime	string	La hora de desbloqueo. La hora sigue el estándar ISO 8601 en formato UTC.

Ejemplos

Respuesta exitosa

JSON Formato

{
  "NextToken": "caeba0bbb2be03f84eb48b699f0a****",
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****",
  "TotalCount": 1,
  "MaxResults": 10,
  "CapacityReservationSet": {
    "CapacityReservationItem": [
      {
        "Status": "Active",
        "TimeSlot": "null",
        "PrivatePoolOptionsMatchCriteria": "Open",
        "PrivatePoolOptionsId": "crp-bp1gubrkqutenqdd****",
        "PrivatePoolOptionsName": "crpTestName",
        "RegionId": "cn-hangzhou",
        "InstanceChargeType": "PostPaid",
        "EndTime": "2021-02-19T03:02Z",
        "StartTime": "2021-02-19T02:01Z",
        "Description": "Esta es la descripción",
        "EndTimeType": "Unlimited",
        "ResourceGroupId": "rg-bp67acfmxazb4p****",
        "Platform": "linux",
        "AllocatedResources": {
          "AllocatedResource": [
            {
              "UsedAmount": 2,
              "TotalAmount": 2,
              "AvailableAmount": 2,
              "FailedAmount": 1,
              "LockedAmount": 1,
              "zoneId": "cn-hangzhou-h",
              "InstanceType": "ecs.c6.large",
              "CapacityReservationUsages": {
                "CapacityReservationUsage": [
                  {
                    "AccountId": "105909559088****",
                    "ServiceName": "maxcompute.aliyuncs.com",
                    "UsedAmount": 20
                  }
                ]
              }
            }
          ]
        },
        "Tags": {
          "Tag": [
            {
              "TagValue": "ValorDePrueba",
              "TagKey": "ClaveDePrueba"
            }
          ]
        },
        "StartTimeType": "Now",
        "SavingPlanId": "spn-c29b5e18pJMT****",
        "ReservedInstanceId": "ri-bpzhex2ulpzf53****",
        "CapacityReservationOwnerId": "100************7\n",
        "DeliveryTime": "",
        "UnlockedTime": ""
      }
    ]
  }
}

Códigos de error

Código de estado HTTP	Código de error	Mensaje de error	Descripción
400	MissingParameter.RegionId	The specified RegionId should not be null.	El parámetro RegionId no puede estar vacío.
400	InvalidParameter.Name	The specified PrivatePoolOptions.Name is invalid.
400	InvalidParameter.PrivatePoolOptions.Ids	The specified PrivatePoolOptions.Ids is invalid.
400	DedicatedHostNotSupported	DedicatedHost is not supported for PrivatePool.	Los pools privados no admiten hosts dedicados.
400	SpotNotSupported	Spot is not supported for PrivatePool.	Los pools privados no admiten instancias spot.
400	ClassicNetworkNotSupported	Classic network is not supported for PrivatePool.	Los pools privados no admiten instancias de tipo de red clásica.
400	Invalid.InstanceId	Instance does not exist.	La instancia no coincide con ningún pool privado.
400	Invalid.PrivatePoolOptions.MatchCriteria	Target mode does not support this operation.	El parámetro PrivatePoolOptions.MatchCriteria especificado no coincide con el pool privado.
400	MissingParameter.PrivatePoolOptions.Id	The specified PrivatePoolOptions.Id should not be null.	El parámetro PrivatePoolOptions.Id no puede estar vacío.
400	Invalid.PrivatePoolOptions.Id	The PrivatePool does not exist.	El pool privado no existe.
400	Invalid.InstanceType	The InstanceType does not match the PrivatePool.	El tipo de instancia no coincide con el pool privado.
400	Invalid.InstanceChargeType	The InstanceChargeType does not match the PrivatePool.	El parámetro InstanceChargeType especificado no es válido.
400	Invalid.ZoneId	The ZoneId does not match the PrivatePool.	La zona no coincide con el pool privado.
400	Invalid.PrivatePoolOptions.status	The PrivatePool has been used up.	El estado del pool privado especificado no es válido.
400	InvalidPlatform.ValueNotSupported	The Platform does not match the PrivatePool.	El parámetro Platform especificado no coincide con el pool privado.
400	InvalidAliUid	The PrivatePool does not belong to the user of the Instance.	El pool privado no pertenece al usuario que está creando la instancia.
400	MissingParameter.PackageType	The specified parameter "PackageType" can not be empty.	El parámetro PackageType no puede estar vacío.
400	MissingParameter.PrivatePoolOptions.Ids	The specified parameter "PrivatePoolOptions.Ids" can not be empty.	El parámetro especificado PrivatePoolOptions.ids no puede estar vacío.
400	MissingParameter.InstanceCpuCoreCount	The specified parameter "InstanceCpuCoreCount" can not be empty.	El parámetro especificado InstanceCpuCocount no puede estar vacío.
400	MissingParameter.InstanceAmount	The specified parameter "InstanceAmount" can not be empty.	El parámetro especificado InstanceAmount no puede estar vacío.
400	MissingParameter.InstanceCpuCoreCountOrInstanceAmount	The specified parameter "InstanceCpuCoreCount" and "InstanceAmount" must not be empty at the same time.	Los parámetros InstanceCpuCoreCount e InstanceAmount no pueden estar ambos vacíos.
400	Invalid.TooManyPrivatePoolOptions.Ids	Too many PrivatePoolOptions.Ids in this request.	El número de valores de PrivatePoolOptions.Ids supera el límite superior.
400	Invalid.TooManyZoneIds	Too many ZoneIds in the request.	El número de valores de ZoneIds supera el límite superior.
400	Invalid.TooManyInstanceTypes	Too many InstanceTypes in the request.	El número de valores de InstanceTypes supera el límite superior.
400	Invalid.TooManyUnpaidPrivatePool	Too many PrivatePools create but still unpaid.	Varios pools privados no están pagados.
400	Invalid.InstanceCpuCoreCountOrInstanceAmount	Both InstanceCpuCoreCount and InstanceAmount are provided.	No es necesario especificar los parámetros InstanceCpuCoreCount e InstanceAmount al mismo tiempo.
400	Invalid.PrivatePoolOptions.Ids	The specified parameter "PrivatePoolOptions.Ids" exist invalid element Id.	El ID del pool privado especificado no existe.
400	Invalid.PackageType	The specified parameter "PackageType" is invalid.	El parámetro PackageType especificado no es válido.
400	Invalid.PrivatePool.Purchase	The PrivatePool has already paid.	El pool privado ya está pagado.
400	Invalid.AssuranceTimes.NotSupported	The value of AssuranceTimes is not supported.	El valor del parámetro AssuranceTimes no se admite.
400	RepeatStartPrivatePool	PrivatePool has already been started.	El pool privado ya está iniciado.
400	InvalidParameter.RegionId	The specified RegionId is not exist.
400	InvalidPermission.ResourceShareAssocoated	The current resource is associated to a shared relationship and cannot be released.	El recurso actual está vinculado a una relación de uso compartido y no se puede liberar.
500	InternalError	The request processing has failed due to some unknown error, exception or failure.	Se produjo un error interno. Vuelva a intentarlo.

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.