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

Depuração

O OpenAPI Explorer calcula automaticamente o valor da assinatura. Recomendamos chamar esta operação no OpenAPI Explorer para maior conveniência. A ferramenta gera dinamicamente códigos de exemplo da operação para diferentes SDKs.

Parâmetros de solicitação

Parâmetro	Tipo	Obrigatório	Exemplo	Descrição
Action	String	Sim	DescribeReservedInstances	Operação a ser executada. Defina o valor como DescribeReservedInstances.
RegionId	String	Sim	cn-hangzhou	ID da região das instâncias reservadas. Chame a operação DescribeRegions para consultar a lista de regiões mais recente.
PageNumber	Integer	Não	1	Número da página. A numeração começa em 1. Valor padrão: 1.
PageSize	Integer	Não	50	Quantidade de entradas por página. Valor máximo: 100. Valor padrão: 10.
Tag.N.Key	String	Não	TestKey	Chave da tag N da instância reservada. Valores válidos de N: 1 a 20. A chave da tag não pode ser uma string vazia, deve ter até 128 caracteres e não pode começar com acs: ou aliyun. Também não pode conter http:// ou https://. Ao especificar uma única tag para consulta, o sistema retorna até 1.000 recursos associados a ela. Se houver múltiplas tags definidas, o retorno inclui até 1.000 recursos que possuam todas as tags especificadas. Para consultar mais de 1.000 recursos com as tags indicadas, chame a operação ListTagResources.
Tag.N.Value	String	Não	TestValue	Valor da tag N da instância reservada. Valores válidos de N: 1 a 20. O valor da tag pode ser uma string vazia, ter até 128 caracteres e não pode conter http:// ou https://. Não deve começar com acs:.
ZoneId	String	Não	cn-hangzhou-z	ID da zona da instância reservada. Este parâmetro é obrigatório quando Scope está definido como Zone. Chame a operação DescribeZones para obter a lista de zonas mais recente.
ReservedInstanceName	String	Não	testReservedInstanceName	Nome da instância reservada.
LockReason	String	Não	security	Motivo do bloqueio da instância reservada. Valores válidos: financial: bloqueia a instância reservada devido a pagamentos atrasados na conta ou expiração do serviço. security: bloqueia a instância reservada por motivos de segurança.
InstanceType	String	Não	ecs.g5.large	Tipo da instância reservada. Para obter informações sobre os valores, consulte Visão geral das famílias de instâncias.
InstanceTypeFamily	String	Não	ecs.g5	Família da instância reservada. Para obter detalhes sobre os valores, consulte Visão geral das famílias de instâncias.
Scope	String	Não	Region	Escopo da instância reservada. Valores válidos: Region Zone Valor padrão: Region.
OfferingType	String	Não	All Upfront	Método de faturamento da instância reservada. Valores válidos: No Upfront Partial Upfront All Upfront
AllocationType	String	Não	Normal	Tipo de alocação das instâncias reservadas. Valores válidos: Normal: consulta todas as instâncias reservadas pertencentes à conta atual. Shared: consulta as instâncias reservadas compartilhadas entre a conta principal atual e as contas vinculadas. Valor padrão: Normal.
ReservedInstanceId.N	String	Não	ri-bpzhex2ulpzf53****	ID da instância reservada N. Valores válidos de N: 1 a 100.
Status.N	String	Não	Active	Status da instância reservada N. Valores válidos de N: 1 a 100. Valores válidos: Creating: a instância reservada está sendo criada. Active: a instância reservada está ativa. Expired: a instância reservada expirou. Updating: as propriedades da instância reservada estão sendo modificadas.

Parâmetros de resposta

Parâmetro	Tipo	Exemplo	Descrição
PageSize	Integer	1	Número de entradas por página.
RequestId	String	E572643C-6A29-49D6-9D4E-6CFA4E063A3E	ID da solicitação.
PageNumber	Integer	1	Número da página.
TotalCount	Integer	1	Número total de instâncias reservadas.
ReservedInstances	Array of ReservedInstance		Detalhes sobre as instâncias reservadas.
ReservedInstance
Status	String	Active	Estado da instância reservada.
CreationTime	String	2018-12-10T12:07Z	Horário de criação da instância reservada.
ReservedInstanceName	String	riZbpzhex2ulpzf53****	Nome da instância reservada.
ReservedInstanceId	String	ri-bpzhex2ulpzf53****	ID da instância reservada.
InstanceType	String	ecs.g5.large	Tipo das instâncias de pagamento conforme o uso correspondentes a cada instância reservada.
InstanceAmount	Integer	10	Quantidade de instâncias de pagamento conforme o uso com o mesmo tipo da instância reservada que podem ser associadas a ela.
RegionId	String	cn-hangzhou	ID da região da instância reservada.
OfferingType	String	All Upfront	Método de faturamento da instância reservada.
StartTime	String	2018-12-10T12:00Z	Horário em que as instâncias reservadas entraram em vigor.
Description	String	testDescription	Descrição da instância reservada.
AllocationStatus	String	allocated	Status de alocação da instância reservada quando o parâmetro AllocationType está definido como Shared. Valores válidos: allocated: a instância reservada foi alocada para outra conta. beAllocated: a instância reservada foi recebida de outra conta via alocação.
ExpiredTime	String	2019-12-10T12:07Z	Data de expiração da instância reservada.
ResourceGroupId	String	EcsDocTest	ID do grupo de recursos.
ZoneId	String	cn-hangzhou-z	ID da zona.
Platform	String	Linux	Tipo de sistema operacional. Valores válidos: Windows Linux
Scope	String	region	Escopo da instância reservada.
OperationLocks	Array of OperationLock		Detalhes sobre o status de bloqueio das instâncias reservadas.
OperationLock
LockReason	String	security	Motivo do bloqueio da instância reservada.
Tags	Array of Tag		Tags da instância reservada.
Tag
TagValue	String	TestValue	Valor da tag da instância reservada.
TagKey	String	TestKey	Chave da tag da instância reservada.

Exemplos

Exemplos de solicitações

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

Exemplos de respostas de sucesso

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 erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	MissingParamter.RegionId	The regionId should not be null.	RegionId é obrigatório.
400	InvalidRegion.NotFound	The specified parameter RegionId is not valid.	Valor de RegionId inválido.
400	InvalidZone.NotFound	The specified parameter ZoneId is not valid.	Valor de ZoneId inválido.
400	InvalidEndTime.ValueNotSupported	The specified endTime is out of the permitted range.	Valor de EndTime inválido.
400	InvalidAllocationType.ValueNotSupported	The specified AllocationType is not supported.	Valor de AllocationType inválido.
404	InvalidRegionId.NotFound	The specified RegionId does not exist in our records.	Valor de RegionId não encontrado. Verifique se o serviço está disponível na região especificada.

Para obter uma lista de códigos de erro, consulte Códigos de erro do serviço.