Todos os produtos
Search
Central de documentação

:ListInstances

Última atualização: Jul 08, 2026

Consulta todas as instâncias do ApsaraMQ for RabbitMQ em uma região específica. O resultado inclui detalhes de cada instância, como endpoints e limites de especificação.

Parâmetros da solicitação

Parâmetro

Tipo

Obrigatório

Exemplo

Descrição

Action

String

Sim

ListInstances

Operação a executar. Defina este parâmetro como ListInstances.

NextToken

String

Não

caeba0bbb2be03f84eb48b699f0a****

Token que marca a posição final da página anterior. Para obter o próximo lote de dados, chame a operação novamente usando o valor de NextToken retornado na solicitação anterior. Na primeira chamada ou ao consultar todos os resultados, defina NextToken como uma string vazia.

MaxResults

Integer

Sim

1

Número máximo de entradas a retornar. Valores válidos: 1 a 100.

Parâmetros de resposta

Parâmetro

Tipo

Exemplo

Descrição

RequestId String CCBB1225-C392-480E-8C7F-D09AB2CD2***

ID da solicitação.

Data Object

Dados retornados.

NextToken String caebacccb2be03f84eb48b699f0a****

Token que marca o fim da página atual. Se estiver vazio, todos os dados foram recuperados.

MaxResults Integer 1

Número máximo de entradas retornadas.

Instances Array of InstanceVO

Lista de instâncias.

Status String SERVING

Status da instância. Valores válidos:

  • DEPLOYING: A instância está sendo implantada.
  • EXPIRED: A instância expirou.
  • SERVING: A instância está em execução.
  • RELEASED: A instância foi liberada.
SupportEIP Boolean true

Indica se a instância oferece suporte a endereços IP elásticos (EIPs).

ExpireTime Long 1651507200000

Timestamp de expiração da instância. Unidade: milissegundos.

OrderCreateTime Long 1572441939000

Timestamp de criação do pedido. Unidade: milissegundos.

PrivateEndpoint String amqp-cn-st21x7kv****.mq-amqp.cn-hangzhou-a.aliyuncs.com

Endpoint da Virtual Private Cloud (VPC) da instância.

StorageSize Integer 200

Tamanho do disco. Unidade: GB.

Nota Para instâncias Professional Edition ou Enterprise Edition, este parâmetro não está disponível e retorna -1.
MaxEipTps Integer 24832

Número máximo de transações por segundo (TPS) via Internet para a instância.

InstanceId String amqp-cn-st21x7kv****

ID da instância.

InstanceType String professional

Edição da instância. Valores válidos:

  • PROFESSIONAL: Professional Edition
  • ENTERPRISE: Enterprise Edition
  • VIP: Enterprise Platinum Edition
PublicEndpoint String amqp-cn-st21x7kv****.mq-amqp.cn-hangzhou-a.aliyuncs.com

Endpoint público da instância.

ClassicEndpoint String amqp-cn-st21x7kv****.not-support

Endpoint de acesso à instância pela rede clássica. Este parâmetro foi descontinuado.

MaxVhost Integer 50

Limite de vhosts criáveis na instância.

MaxTps Integer 5000

Número máximo de TPS via VPC na instância.

AutoRenewInstance Boolean false

Indica se a renovação automática da instância está ativada.

InstanceName String amqp-cn-st21x7kv****

Nome da instância.

MaxQueue Integer 50

Limite de filas na instância.

OrderType String PRE_PAID

Método de faturamento. Valores válidos:

  • PRE_PAID: assinatura
  • POST_PAID: pagamento conforme o uso
Tags Array of tags

Tags associadas.

Key String region

Chave da tag.

Value String hangzhou

Valor da tag.

Exemplos

Exemplo de solicitação

http(s)://amqp-open.cn-hangzhou.aliyuncs.com/?Action=ListInstances
&MaxResults=1
&RegionId=cn-hangzhou
&<Common request parameters>

Exemplos de respostas de sucesso

Formato XML

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

<ListInstancesResponse>
      <RequestId>CCBB1225-C392-480E-8C7F-D09AB2CD2***</RequestId>
      <Data>
            <Instances>
                  <Status>SERVING</Status>
                  <MaxTps>5000</MaxTps>
                  <MaxEipTps>24832</MaxEipTps>
                  <ClassicEndpoint>amqp-cn-st21x7kv****.not-support</ClassicEndpoint>
                  <InstanceId>amqp-cn-st21x7kv****</InstanceId>
                  <MaxQueue>50</MaxQueue>
                  <SupportEIP>true</SupportEIP>
                  <StorageSize>200</StorageSize>
                  <InstanceName>amqp-cn-st21x7kv****</InstanceName>
                  <OrderType>PRE_PAID</OrderType>
                  <OrderCreateTime>1572441939000</OrderCreateTime>
                  <MaxVhost>50</MaxVhost>
                  <PublicEndpoint>amqp-cn-st21x7kv****.mq-amqp.cn-hangzhou-a.aliyuncs.com</PublicEndpoint>
                  <InstanceType>professional</InstanceType>
                  <ExpireTime>1651507200000</ExpireTime>
                  <AutoRenewInstance>false</AutoRenewInstance>
                  <PrivateEndpoint>amqp-cn-st21x7kv****.mq-amqp.cn-hangzhou-a.aliyuncs.com</PrivateEndpoint>
            </Instances>
            <NextToken></NextToken>
            <MaxResults>1</MaxResults>
      </Data>
</ListInstancesResponse>

Formato JSON

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

{
  "RequestId" : "CCBB1225-C392-480E-8C7F-D09AB2CD2***",
  "Data" : {
    "Instances" : {
      "Status" : "SERVING",
      "MaxTps" : 5000,
      "MaxEipTps" : 24832,
      "ClassicEndpoint" : "amqp-cn-st21x7kv****.not-support",
      "InstanceId" : "amqp-cn-st21x7kv****",
      "MaxQueue" : 50,
      "SupportEIP" : true,
      "StorageSize" : 200,
      "InstanceName" : "amqp-cn-st21x7kv****",
      "OrderType" : "PRE_PAID",
      "OrderCreateTime" : 1572441939000,
      "MaxVhost" : 50,
      "PublicEndpoint" : "amqp-cn-st21x7kv****.mq-amqp.cn-hangzhou-a.aliyuncs.com",
      "InstanceType" : "professional",
      "ExpireTime" : 1651507200000,
      "AutoRenewInstance" : false,
      "PrivateEndpoint" : "amqp-cn-st21x7kv****.mq-amqp.cn-hangzhou-a.aliyuncs.com"
    },
    "NextToken" : "",
    "MaxResults" : 1
  }
}

Códigos de erro

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