OnsInstanceInServiceList - ApsaraMQ for RocketMQ: Central de Documentação do Alibaba Cloud

Consulta as informações sobre todas as instâncias do ApsaraMQ for RocketMQ 4.x em uma região especificada para a conta atual.

Descrição da operação

Importante As operações OpenAPI fornecidas pela Alibaba Cloud são APIs de gerenciamento usadas para gerenciar e consultar recursos dos serviços da Alibaba Cloud. Integre essas APIs apenas em fluxos de trabalho de gerenciamento. Não dependa de operações OpenAPI no link de dados principal para envio e recebimento de mensagens. Caso contrário, podem ocorrer riscos no link.

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

mq:QueryInstanceBaseInfo

list

Instância.

acs:mq:{#regionId}:{#accountId}:{#InstanceId}

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
Tag	array<object>	Não	A lista de tags vinculadas às instâncias. A lista pode conter no máximo 20 elementos.
	object	Não	A tag vinculada à instância.
Key	string	Não	A chave da tag da instância. Key e Value devem ser ambos especificados ou ambos deixados vazios. Se ambos forem especificados, as instâncias serão filtradas com base na tag. Se nenhum for especificado, todas as instâncias serão consultadas. Se este valor for especificado, não poderá ser uma string vazia. O valor pode ter até 128 caracteres. Não pode começar com `aliyun` ou `acs:` e não pode conter `http://` ou `https://`.	CartService
Value	string	Não	O valor da tag do recurso. Key e Value devem ser ambos especificados ou ambos deixados vazios. Se ambos forem especificados, as instâncias serão filtradas com base na tag. Se nenhum for especificado, todas as instâncias serão consultadas. Se este valor for especificado, poderá ser uma string vazia. O valor pode ter até 128 caracteres. Não pode começar com `aliyun` ou `acs:` e não pode conter `http://` ou `https://`.	SericeA
NeedResourceInfo	boolean	Não	Especifica se devem ser retornadas informações de estatísticas de recursos, incluindo o número de tópicos e o número de grupos de consumidores na instância.	true

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
RequestId	string	O parâmetro comum. O ID de cada solicitação é único e pode ser usado para solução de problemas e localização de problemas.	0598E46F-DB06-40E2-AD7B-C45923EE****
Data	object
InstanceVO	array<object>	A lista de informações sobre todas as instâncias.
	array<object>	A lista de informações sobre todas as instâncias.
IndependentNaming	boolean	Indica se a instância possui um namespace. Valores válidos: true: A instância possui um namespace independente. Os nomes dos recursos são exclusivos dentro da instância, mas podem ser duplicados entre instâncias. false: A instância não possui um namespace independente. Os nomes dos recursos devem ser globalmente exclusivos dentro e entre as instâncias.	true
InstanceName	string	O nome da instância.	test1
ReleaseTime	integer	O horário de expiração da instância Enterprise Platinum Edition.	1551024000000
InstanceStatus	integer	O status da instância. Valores válidos: 0: A instância Enterprise Platinum Edition está sendo implantada. 2: A instância padrão possui um pagamento em atraso. 5: A instância padrão ou a instância Enterprise Platinum Edition está em serviço. 7: A instância Enterprise Platinum Edition está sendo atualizada e o serviço está disponível.	5
Tags	object
Tag	array<object>	A tag vinculada à instância.
	object	A tag vinculada à instância.
Key	string	A chave da tag.	CartService
Value	string	O valor da tag.	ServiceA
InstanceId	string	O ID da instância.	MQ_INST_188077086902****_BXSuW61e
InstanceType	integer	O tipo da instância. Valores válidos: 1: Standard Instância Standard 2: Enterprise Platinum Instância Standard Para obter mais informações sobre as especificações e diferenças de cada tipo de instância, consulte Especificações da instância.	2
CreateTime	integer	A hora de criação da instância. O valor deste parâmetro é um timestamp UNIX em milissegundos.	1640847284000
TopicCount	integer	O número de tópicos.	1
GroupCount	integer	O número de grupos de consumidores.	3

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "0598E46F-DB06-40E2-AD7B-C45923EE****",
  "Data": {
    "InstanceVO": [
      {
        "IndependentNaming": true,
        "InstanceName": "test1",
        "ReleaseTime": 1551024000000,
        "InstanceStatus": 5,
        "Tags": {
          "Tag": [
            {
              "Key": "CartService",
              "Value": "ServiceA"
            }
          ]
        },
        "InstanceId": "MQ_INST_188077086902****_BXSuW61e",
        "InstanceType": 2,
        "CreateTime": 1640847284000,
        "TopicCount": 1,
        "GroupCount": 3
      }
    ]
  }
}

Códigos de erro

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.