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

Consulta os detalhes das instâncias reservadas que você comprou em uma região especificada. Você pode filtrar os resultados por tags, atributos da instância reservada e outros parâmetros.

Descrição da operação

Cenários

Consulta todas as instâncias reservadas em uma região especificada.
Consulta os detalhes de uma instância reservada por seu ID ou nome.
Filtra instâncias reservadas por tipo de instância ou família de instâncias.
Filtra instâncias reservadas por escopo ou status.

Exemplos de solicitação

Exemplo: Consultar todas as instâncias reservadas compradas na região China (Hangzhou)

"Region":"cn-hangzhou" // Define a região como China (Hangzhou).

Exemplo: Consultar os detalhes da instância reservada cujo ID é ecsri-bp129enntoynwwj5**** na região China (Hangzhou)

"Region":"cn-hangzhou", // Define a região como China (Hangzhou).
"ReservedInstanceId":"ecsri-bp129enntoynwwj5****" // Define o ID da instância reservada.

Exemplo: Consultar instâncias reservadas que podem ser aplicadas a instâncias ecs.c5.2xlarge na região China (Hangzhou)

"Region":"cn-hangzhou", // Define a região como China (Hangzhou).
"InstanceType":"ecs.c5.2xlarge" // Define o tipo de instância.

Exemplo: Consultar instâncias reservadas regionais ativas na região China (Hangzhou)

"Region":"cn-hangzhou", // Define a região como China (Hangzhou).
"Scope":"Region", // Define o escopo da instância reservada.
"Status":["Active"] // Define o status como Active.

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

get

ReservedInstance.

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

ReservedInstance.

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

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
RegionId	string	Sim	O ID da região da instância reservada. Você pode chamar a operação DescribeRegions para consultar a lista de regiões mais recente.	cn-hangzhou
PageNumber	integer	Não	O número da página da lista de instâncias reservadas. As páginas começam em 1. Valor padrão: 1.	1
PageSize	integer	Não	O número de entradas por página para uma consulta paginada. Valor máximo: 100. Valor padrão: 10.	50
Tag	array<object>	Não	As tags. Comprimento do array: 1 a 20.
	object	Não	A tag.
Key	string	Não	A chave da tag da instância reservada. A chave da tag não pode ser uma string vazia e pode ter até 128 caracteres. Não pode começar com aliyun ou acs: e não pode conter http:// ou https://. Nota Se você usar uma única tag para filtrar recursos, a contagem de recursos retornada não pode exceder 1.000. Se você usar várias tags para filtrar recursos, a contagem de recursos que possuem várias tags anexadas não pode exceder 1.000. Se a contagem de recursos exceder 1.000, chame a operação ListTagResources para consultar os recursos.	TestKey
Value	string	Não	O valor da tag da instância reservada. O valor da tag não pode ser uma string vazia e pode ter até 128 caracteres. Não pode começar com `acs:` e não pode conter `http://` ou `https://`.	TestValue
ZoneId	string	Não	O ID da zona da instância. Este parâmetro é obrigatório e só entra em vigor quando Scope é definido como Zone. Você pode chamar a operação DescribeZones para consultar a lista de zonas.	cn-hangzhou-z
ReservedInstanceName	string	Não	O nome da instância reservada. Nota A correspondência exata é usada. A correspondência aproximada não é suportada.	testReservedInstanceName
LockReason	string	Não	O tipo de bloqueio. Valores válidos: financial: A conta possui pagamentos em atraso ou o serviço expirou. security: A instância está bloqueada por motivos de segurança.	security
InstanceType	string	Não	O tipo de instância que corresponde à instância reservada. Para mais informações, consulte Famílias de instâncias. Nota Este é o tipo de instância selecionado quando você compra a instância reservada. Quando a instância reservada é aplicada, uma instância reservada regional pode ser aplicada a diferentes tipos de instância dentro da mesma família de instâncias com base no cálculo de equivalência.	ecs.g5.large
InstanceTypeFamily	string	Não	A família de instâncias que corresponde à instância reservada. Para mais informações, consulte Famílias de instâncias.	ecs.g5
Scope	string	Não	O escopo da instância reservada. Valores válidos: Region: regional. Zone: zonal.	Region
OfferingType	string	Não	O tipo de pagamento da instância reservada. Valores válidos: No Upfront: sem pagamento antecipado. Partial Upfront: pagamento antecipado parcial. All Upfront: pagamento antecipado total.	All Upfront
AllocationType	string	Não	O tipo de alocação. Valores válidos: Normal: consulta as instâncias reservadas na conta atual. Shared: consulta as instâncias reservadas que são compartilhadas entre a conta principal e as contas vinculadas na conta atual. Valor padrão: Normal.	Normal
ReservedInstanceId	array	Não	Os IDs das instâncias reservadas. Comprimento do array: 1 a 100.	ri-bpzhex2ulpzf53****
	string	Não	O ID da instância reservada.	ri-bpzhex2ulpzf53****
Status	array	Não	Os status das instâncias reservadas.	Active
	string	Não	O status da instância reservada. Valores válidos: Creating: A instância reservada está sendo criada. Active: A instância reservada está ativa. Retired: A instância reservada está desativada. Updating: Os atributos da instância reservada estão sendo modificados. Expired: A instância reservada expirou. Uma instância reservada se torna inválida imediatamente após a expiração. Este valor foi descontinuado e será removido no futuro.	Active

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
PageSize	integer	O número de entradas por página.	1
RequestId	string	O ID da solicitação.	E572643C-6A29-49D6-9D4E-6CFA4E063A3E
PageNumber	integer	O número da página da lista de instâncias reservadas.	1
TotalCount	integer	O número total de instâncias reservadas.	1
ReservedInstances	object
ReservedInstance	array<object>	Os detalhes das instâncias reservadas.
	array<object>	Os detalhes da instância reservada.
Status	string	O status.	Active
CreationTime	string	A hora de criação. A hora segue o padrão ISO 8601 e é exibida em UTC.	2018-12-10T12:07Z
ReservedInstanceName	string	O nome.	riZbpzhex2ulpzf53****
ReservedInstanceId	string	O ID da instância reservada.	ri-bpzhex2ulpzf53****
InstanceType	string	O tipo de instância da instância pay-as-you-go correspondente.	ecs.g5.large
InstanceAmount	integer	O número de instâncias pay-as-you-go do mesmo tipo de instância que podem ser correspondidas.	10
RegionId	string	O ID da região.	cn-hangzhou
OfferingType	string	O tipo de pagamento.	All Upfront
StartTime	string	O período de vigência. O formato é ISO 8601 e o fuso horário é UTC.	2018-12-10T12:00Z
Description	string	A descrição.	testDescription
AllocationStatus	string	O status de alocação da instância reservada. Este parâmetro é retornado apenas quando AllocationType é definido como Shared. Valores válidos: allocated: A instância reservada está alocada para outros usuários. beAllocated: A instância reservada está alocada por outros usuários.	allocated
ExpiredTime	string	A hora de expiração. A hora segue o padrão ISO 8601 e é exibida em UTC.	2019-12-10T12:07Z
ResourceGroupId	string	O grupo de recursos.	EcsDocTest
ZoneId	string	O ID da zona.	cn-hangzhou-z
Platform	string	O tipo de sistema operacional da imagem usada pela instância. Valores válidos: Windows: Sistemas operacionais Windows Server. Linux: Sistemas operacionais Linux e do tipo Unix.	Linux
Scope	string	O escopo.	region
OperationLocks	object
OperationLock	array<object>	Indica se a instância está bloqueada.
	object	Indica se a instância está bloqueada.
LockReason	string	O motivo do bloqueio.	security
Tags	object
Tag	array<object>	As tags da instância reservada.
	object	A tag da instância reservada.
TagValue	string	O valor da tag da instância reservada.	TestValue
TagKey	string	A chave da tag da instância reservada.	TestKey

Exemplos

Resposta de sucesso

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 erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	MissingParamter.RegionId	The regionId should not be null.	O parâmetro RegionId não pode estar vazio.
400	InvalidRegion.NotFound	The specified parameter RegionId is not valid.	O parâmetro RegionId é inválido.
400	InvalidZone.NotFound	The specified parameter ZoneId is not valid.	O ZoneId especificado é invá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.	O parâmetro EndTime é invá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.	O tipo de alocação especificado é inválido.
403	RAM.ApiNotSupported	This call is not supported from ram accessing.	O usuário RAM não tem permissão para realizar esta operação.
404	InvalidRegionId.NotFound	The specified RegionId does not exist in our records.	O RegionId especificado não existe. Verifique se o produto está disponível nesta região.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.