DescribeCapacityReservations - Elastic Compute Service: Central de Documentação do Alibaba Cloud

Consulta os detalhes de uma ou mais reservas de capacidade, como o status, a hora de entrada em vigor e de expiração, o modo de pool privado e o número de instâncias consumidas.

Experimente agora

Experimente esta API no OpenAPI Explorer, sem necessidade de assinatura manual. Chamadas bem-sucedidas geram automaticamente código SDK correspondente aos seus parâmetros. Faça o download com segurança de credenciais integrada para uso local.

Testar

Autorização RAM

A tabela abaixo descreve a autorização necessária para chamar esta API. Você pode defini-la em uma política do Resource Access Management (RAM). As colunas da tabela estão detalhadas abaixo:

Ação: As ações que podem ser usadas no elemento Action das instruções de política de permissão do RAM para conceder permissões para executar a operação.
API: A API que você pode chamar para executar a ação.
Nível de acesso: O nível de acesso predefinido concedido para cada API. Valores válidos: create, list, get, update e delete.
Tipo de recurso: O tipo de recurso que suporta autorização para executar a ação. Indica se a ação suporta permissão em nível de recurso. O recurso especificado deve ser compatível com a ação. Caso contrário, a política será ineficaz.
- Para APIs com permissões em nível de recurso, os tipos de recursos obrigatórios são marcados com um asterisco (*). Especifique o Nome de Recurso Alibaba Cloud (ARN) correspondente no elemento Resource da política.
- Para APIs sem permissões em nível de recurso, é exibido como Todos os Recursos. Use um asterisco (*) no elemento Resource da política.
Chave de condição: As chaves de condição definidas pelo serviço. A chave permite controle granular, aplicando-se somente a ações ou a ações associadas a recursos específicos. Além das chaves de condição específicas do serviço, o Alibaba Cloud fornece um conjunto de chaves de condição comuns aplicáveis a todos os serviços compatíveis com RAM.
Ação dependente: As ações dependentes necessárias para executar a ação. Para concluir a ação, o usuário RAM ou a função RAM deve ter permissões para executar todas as ações dependentes.

Ação

Nível de acesso

Tipo de recurso

Chave de condição

Ação dependente

ecs:DescribeCapacityReservations

get

*CapacityReservation.

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

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
RegionId	string	Sim	O ID da região da reserva de capacidade. Você pode chamar DescribeRegions para consultar a lista de regiões mais recente.	cn-hangzhou
ResourceGroupId	string	Não	O ID do grupo de recursos. Ao usar este parâmetro para filtrar recursos, a contagem de recursos não pode exceder 1000. Nota A filtragem pelo grupo de recursos padrão não é suportada.	rg-bp67acfmxazb4p****
Tag	array<object>	Não	As tags vinculadas à reserva de capacidade.
	object	Não	O par de tags.
Key	string	Não	A chave da tag. N especifica que você pode definir várias chaves de tag para filtragem. Valores válidos de N: 1 a 20. Se você usar uma única tag para filtrar recursos, a contagem de recursos com a tag não pode exceder 1000. Se você usar várias tags para filtrar recursos, a contagem de recursos com todas as tags especificadas anexadas não pode exceder 1000. Se a contagem de recursos exceder 1000, chame a operação ListTagResources para consultar os recursos.	TestKey
Value	string	Não	O valor da tag. N especifica que você pode definir vários valores de tag para filtragem. Valores válidos de N: 1 a 20.	TestValue
MaxResults	integer	Não	O número máximo de entradas por página para uma consulta paginada. Valor máximo: 100. Valor padrão: 10.	10
NextToken	string	Não	O token de paginação para a consulta de reserva de capacidade. Obtenha o valor a partir do resultado da solicitação anterior.	caeba0bbb2be03f84eb48b699f0a4883
PrivatePoolOptions.Ids	string	Não	A lista de IDs de reservas de capacidade. O valor pode ser uma matriz JSON que consiste em até 100 IDs, separados por vírgulas (,).	["crp-bp1gubrkqutenqdd**", "crp-bp67acfmxazb5**"]
Platform	string	Não	O sistema operacional da instância. Valores válidos: windows: consulta apenas reservas de capacidade para instâncias Windows. linux: consulta apenas reservas de capacidade para instâncias Linux. all: consulta todas as reservas de capacidade. Valor padrão: all.	linux
InstanceType	string	Não	O tipo de instância. Você pode usar o tipo de instância para consultar apenas reservas de capacidade ativas. As reservas de capacidade liberadas só podem ser consultadas usando PrivatePoolOptions.Ids.	ecs.c6.large
ZoneId	string	Não	O ID da zona da reserva de capacidade.	cn-hangzhou-h
InstanceChargeType	string	Não	O método de cobrança da instância. Valores válidos: PostPaid: pay-as-you-go. PrePaid: assinatura. Valor padrão: PostPaid.	PostPaid
Status	string	Não	O status da reserva de capacidade. Valores válidos: All: todos os estados. Pending: inicializando. Uma reserva de capacidade que entra em vigor em um horário especificado entra primeiro no estado de inicialização. Preparing: sendo preparada. Uma reserva de capacidade que entra em vigor em um horário especificado está no estado de preparação durante a fase de entrega de recursos. Prepared: para entrar em vigor. Uma reserva de capacidade que entra em vigor em um horário especificado está no estado de para entrar em vigor após a conclusão da entrega de recursos, mas antes de o serviço entrar oficialmente em vigor. Active: ativa. Released: liberada, incluindo liberação manual e liberação automática após a expiração. Se você não especificar este parâmetro, as reservas de capacidade em todos os estados, exceto Pending e Released, serão consultadas.	Active

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
NextToken	string	O token de paginação para a próxima consulta.	caeba0bbb2be03f84eb48b699f0a****
RequestId	string	O ID da solicitação.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3****
TotalCount	integer	O número total de entradas que correspondem às condições de consulta.	1
MaxResults	integer	O número máximo de entradas por página.	10
CapacityReservationSet	object
CapacityReservationItem	array<object>	Os detalhes das reservas de capacidade.
	array<object>	Os detalhes da reserva de capacidade.
Status	string	O status da reserva de capacidade. Valores válidos: Pending: inicializando. Preparing: sendo preparada. Prepared: para entrar em vigor. Active: ativa. Released: liberada, incluindo liberação manual e liberação automática após a expiração.	Active
TimeSlot	string	Nota Este parâmetro está em pré-visualização por convite e não está disponível publicamente.	null
PrivatePoolOptionsMatchCriteria	string	O tipo de pool privado gerado após a reserva de capacidade entrar em vigor. Valores válidos: Open: modo aberto. O sistema corresponde automaticamente à capacidade de pools privados abertos quando você inicia uma instância. Se nenhuma capacidade de pool privado correspondente estiver disponível, os recursos do pool público serão usados para iniciar a instância. Target: modo direcionado. A instância é iniciada usando a capacidade do pool privado especificado. Se a capacidade do pool privado especificado não estiver disponível, a instância falhará ao iniciar.	Open
PrivatePoolOptionsId	string	O ID da reserva de capacidade.	crp-bp1gubrkqutenqdd****
PrivatePoolOptionsName	string	O nome do serviço de reserva de capacidade.	crpTestName
RegionId	string	O ID da região da reserva de capacidade.	cn-hangzhou
InstanceChargeType	string	O método de cobrança das instâncias na reserva de capacidade. Valores válidos: PostPaid: pay-as-you-go. PrePaid: assinatura.	PostPaid
EndTime	string	A hora de expiração da reserva de capacidade. A hora segue o padrão ISO 8601 em UTC.	2021-02-19T03:02Z
StartTime	string	A hora de entrada em vigor da reserva de capacidade. A hora segue o padrão ISO 8601 em UTC.	2021-02-19T02:01Z
Description	string	A descrição da reserva de capacidade.	This is description.
EndTimeType	string	O modo de liberação da reserva de capacidade. Valores válidos: Limited: liberada em um horário especificado. Unlimited: liberação manual. Nenhum limite de tempo é imposto.	Unlimited
ResourceGroupId	string	O ID do grupo de recursos da reserva de capacidade.	rg-bp67acfmxazb4p****
Platform	string	O sistema operacional das instâncias correspondentes. Valores válidos: windows. linux.	linux
AllocatedResources	object
AllocatedResource	array<object>	A lista de detalhes de alocação de recursos.
	array<object>	Os detalhes de alocação de recursos.
UsedAmount	integer	O número de instâncias consumidas.	2
TotalAmount	integer	O número total de instâncias a serem reservadas para um tipo de instância específico.	2
AvailableAmount	integer	O número de instâncias disponíveis.	2
FailedAmount	integer	A capacidade com falha.	1
LockedAmount	integer	A capacidade bloqueada.	1
zoneId	string	O ID da zona.	cn-hangzhou-h
InstanceType	string	O tipo de instância.	ecs.c6.large
CapacityReservationUsages	object
CapacityReservationUsage	array<object>	A lista de detalhes de instâncias consumidas.
	object	Os detalhes da instância consumida.
AccountId	string	O ID da conta Alibaba Cloud.	105909559088****
ServiceName	string	O nome do serviço Alibaba Cloud.	maxcompute.aliyuncs.com
UsedAmount	integer	O número de instâncias consumidas pela conta ou serviço Alibaba Cloud.	20
Tags	object
Tag	array<object>	A lista de pares de chave-valor de tag vinculados à reserva de capacidade.
	object	O par de chave-valor de tag vinculado à reserva de capacidade.
TagValue	string	O valor da tag.	TestValue
TagKey	string	A chave da tag.	TestKey
StartTimeType	string	O modo pelo qual a reserva de capacidade entra em vigor. Valores válidos: Now: entra em vigor imediatamente. Later: entra em vigor em um horário especificado.	Now
SavingPlanId	string	O ID do plano de economia associado à reserva de capacidade.	spn-c29b5e18pJMT****
ReservedInstanceId	string	O ID da instância reservada associado à reserva de capacidade.	ri-bpzhex2ulpzf53****
CapacityReservationOwnerId	string	O ID do proprietário do plano de recursos de reserva de capacidade.	100************7
DeliveryTime	string	A hora de entrega. A hora segue o padrão ISO 8601 em UTC.
UnlockedTime	string	A hora de desbloqueio. A hora segue o padrão ISO 8601 em UTC.

Exemplos

Resposta de sucesso

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 é a descrição",
        "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": "TestValue",
              "TagKey": "TestKey"
            }
          ]
        },
        "StartTimeType": "Now",
        "SavingPlanId": "spn-c29b5e18pJMT****",
        "ReservedInstanceId": "ri-bpzhex2ulpzf53****",
        "CapacityReservationOwnerId": "100************7\n",
        "DeliveryTime": "",
        "UnlockedTime": ""
      }
    ]
  }
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	MissingParameter.RegionId	The specified RegionId should not be null.	O parâmetro RegionId não pode estar vazio.
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.	Os pools privados não oferecem suporte a hosts dedicados.
400	SpotNotSupported	Spot is not supported for PrivatePool.	Os pools privados não oferecem suporte a instâncias spot.
400	ClassicNetworkNotSupported	Classic network is not supported for PrivatePool.	Os pools privados não oferecem suporte a instâncias do tipo de rede clássica.
400	Invalid.InstanceId	Instance does not exist.	A instância não corresponde a um pool privado.
400	Invalid.PrivatePoolOptions.MatchCriteria	Target mode does not support this operation.	O parâmetro PrivatePoolOptions.MatchCriteria especificado não corresponde ao pool privado.
400	MissingParameter.PrivatePoolOptions.Id	The specified PrivatePoolOptions.Id should not be null.	O parâmetro PrivatePoolOptions.Id não pode estar vazio.
400	Invalid.PrivatePoolOptions.Id	The PrivatePool does not exist.	O pool privado não existe.
400	Invalid.InstanceType	The InstanceType does not match the PrivatePool.	O tipo de instância não corresponde ao pool privado.
400	Invalid.InstanceChargeType	The InstanceChargeType does not match the PrivatePool.	O parâmetro InstanceChargeType especificado é inválido.
400	Invalid.ZoneId	The ZoneId does not match the PrivatePool.	A zona não corresponde ao pool privado.
400	Invalid.PrivatePoolOptions.status	The PrivatePool has been used up.	O status do pool privado especificado é inválido.
400	InvalidPlatform.ValueNotSupported	The Platform does not match the PrivatePool.	O parâmetro Platform especificado não corresponde ao pool privado.
400	InvalidAliUid	The PrivatePool does not belong to the user of the Instance.	O pool privado não pertence ao usuário que está criando a instância.
400	MissingParameter.PackageType	The specified parameter "PackageType" can not be empty.	O parâmetro PackageType não pode estar vazio.
400	MissingParameter.PrivatePoolOptions.Ids	The specified parameter "PrivatePoolOptions.Ids" can not be empty.	O parâmetro especificado PrivatePoolOptions.ids não pode estar vazio.
400	MissingParameter.InstanceCpuCoreCount	The specified parameter "InstanceCpuCoreCount" can not be empty.	O parâmetro especificado InstanceCpuCocount não pode estar vazio.
400	MissingParameter.InstanceAmount	The specified parameter "InstanceAmount" can not be empty.	O parâmetro especificado InstanceAmount não pode estar vazio.
400	MissingParameter.InstanceCpuCoreCountOrInstanceAmount	The specified parameter "InstanceCpuCoreCount" and "InstanceAmount" must not be empty at the same time.	Os parâmetros InstanceCpuCoreCount e InstanceAmount não podem estar ambos vazios.
400	Invalid.TooManyPrivatePoolOptions.Ids	Too many PrivatePoolOptions.Ids in this request.	O número de PrivatePoolOptions.Ids excede o limite superior.
400	Invalid.TooManyZoneIds	Too many ZoneIds in the request.	O número de ZoneIds excede o limite superior.
400	Invalid.TooManyInstanceTypes	Too many InstanceTypes in the request.	O número de InstanceTypes excede o limite superior.
400	Invalid.TooManyUnpaidPrivatePool	Too many PrivatePools create but still unpaid.	Vários pools privados não foram pagos.
400	Invalid.InstanceCpuCoreCountOrInstanceAmount	Both InstanceCpuCoreCount and InstanceAmount are provided.	Os parâmetros InstanceCpuCoreCount e InstanceAmount não precisam ser especificados ao mesmo tempo.
400	Invalid.PrivatePoolOptions.Ids	The specified parameter "PrivatePoolOptions.Ids" exist invalid element Id.	O ID do pool privado especificado não existe.
400	Invalid.PackageType	The specified parameter "PackageType" is invalid.	O parâmetro PackageType especificado é inválido.
400	Invalid.PrivatePool.Purchase	The PrivatePool has already paid.	O pool privado já foi pago.
400	Invalid.AssuranceTimes.NotSupported	The value of AssuranceTimes is not supported.	O valor do parâmetro AssuranceTimes não é suportado.
400	RepeatStartPrivatePool	PrivatePool has already been started.	O pool privado já foi 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.	O recurso atual está vinculado a um relacionamento de compartilhamento e não pode ser liberado.
500	InternalError	The request processing has failed due to some unknown error, exception or failure.	Ocorreu um erro interno. Tente novamente.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.