Consultar instâncias com base na data e hora de expiração - : Central de Documentação do Alibaba Cloud

Chame a operação DescribeDBInstancesByExpireTime para consultar instâncias do ApsaraDB RDS com base em uma data e hora de expiração específicas.

Nota

Esta operação está disponível apenas para instâncias por assinatura.

Depuração

O OpenAPI Explorer calcula automaticamente o valor da assinatura. Para sua conveniência, recomendamos que você chame esta operação no OpenAPI Explorer. O OpenAPI Explorer gera dinamicamente o código de exemplo da operação para diferentes SDKs.

Parâmetros de solicitação

Parâmetro	Tipo	Obrigatório	Exemplo	Descrição
Action	String	Sim	DescribeDBInstancesByExpireTime	A operação a ser executada. Defina o valor como DescribeDBInstancesByExpireTime.
RegionId	String	Não	cn-hangzhou	ID da região das instâncias. Chame a operação DescribeRegions para consultar a lista de regiões mais recente.
proxyId	String	Não	N/A	Parâmetro obsoleto.
ExpirePeriod	Integer	Não	180	Número de dias restantes de disponibilidade das instâncias. Valores válidos: 0 a 180.
Expired	Boolean	Não	True	Define se a consulta deve retornar instâncias expiradas. Valores válidos: True: consulta instâncias expiradas. False: consulta instâncias não expiradas.
PageSize	Integer	Não	30	Número de entradas a retornar por página. Valores válidos: 1 a 100. Valor padrão: 30.
PageNumber	Integer	Não	1	Número da página a retornar. Valores válidos: qualquer inteiro positivo diferente de zero. Valor padrão: 1.
Tags	String	Não	null	Tags associadas às instâncias. Cada tag é um par chave-valor composto por TagKey e TagValue. Especifique até cinco tags por solicitação no formato: `{"key1":"value1","key2":"value2"...}`.

Parâmetros de resposta

Parâmetro	Tipo	Exemplo	Descrição
RequestId	String	1AD222E9-E606-4A42-BF6D-8A4442913CEF	ID da solicitação.
PageNumber	Integer	1	Número da página retornada. Valores válidos: qualquer inteiro positivo diferente de zero. Valor padrão: 1.
PageRecordCount	Integer	2	Número de instâncias retornadas na página atual.
TotalRecordCount	Integer	200	Número total de entradas.
Items	Array of DBInstanceExpireTime		Matriz com as informações das instâncias retornadas.
DBInstanceExpireTime
ExpireTime	String	2019-03-27T16:00:00Z	Data e hora de expiração da instância. O horário segue o padrão ISO 8601 no formato aaaa-MM-ddTHH:mm:ssZ e é exibido em UTC. Nota Instâncias com pagamento conforme o uso nunca expiram.
PayType	String	Prepaid	Método de faturamento da instância. Valores válidos: Postpaid: pagamento conforme o uso Prepaid: assinatura
DBInstanceId	String	rm-uf6wjk5xxxxxxx	ID da instância.
DBInstanceStatus	String	Running	Status da instância. Para obter mais informações, consulte a Tabela de estados da instância.
DBInstanceDescription	String	Test database	Descrição da instância.
LockMode	String	Unlock	Modo de bloqueio da instância. Valores válidos: Unlock: a instância não está bloqueada. ManualLock: a instância foi bloqueada manualmente. LockByExpiration: a instância foi bloqueada automaticamente após a expiração. LockByRestoration: a instância foi bloqueada automaticamente antes da reversão. LockByDiskQuota: a instância foi bloqueada automaticamente após o esgotamento da capacidade de armazenamento. LockReadInstanceByDiskQuota: trata-se de uma instância somente leitura, bloqueada automaticamente após o esgotamento da capacidade de armazenamento.

Exemplos

Solicitações de exemplo

http(s)://rds.aliyuncs.com/?Action=DescribeDBInstancesByExpireTime
&<Common request parameters>

Respostas de sucesso de exemplo

Formato XML

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

<DescribeDBInstancesByExpireTimeResponse>
    <TotalRecordCount>200</TotalRecordCount>
    <PageRecordCount>2</PageRecordCount>
    <RequestId>1AD222E9-E606-4A42-BF6D-8A4442913CEF</RequestId>
    <PageNumber>1</PageNumber>
    <Items>
        <DBInstanceExpireTime>
            <DBInstanceStatus>Running</DBInstanceStatus>
            <DBInstanceId>rm-uf6wjk5xxxxxxx</DBInstanceId>
            <PayType>Prepaid</PayType>
            <LockMode>Unlock</LockMode>
            <ExpireTime>2019-03-27T16:00:00Z</ExpireTime>
            <DBInstanceDescription>Test database</DBInstanceDescription>
        </DBInstanceExpireTime>
    </Items>
</DescribeDBInstancesByExpireTimeResponse>

Formato JSON

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

{
  "TotalRecordCount" : "200",
  "PageRecordCount" : "2",
  "RequestId" : "1AD222E9-E606-4A42-BF6D-8A4442913CEF",
  "PageNumber" : "1",
  "Items" : {
    "DBInstanceExpireTime" : [ {
      "DBInstanceStatus" : "Running",
      "DBInstanceId" : "rm-uf6wjk5xxxxxxx",
      "PayType" : "Prepaid",
      "LockMode" : "Unlock",
      "ExpireTime" : "2019-03-27T16:00:00Z",
      "DBInstanceDescription": "Test database"
    } ]
  }
}

Códigos de erro

Para obter uma lista de códigos de erro, visite o API Error Center.