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

Consulta todas as instâncias do ApsaraMQ for RocketMQ 4.x em uma região especificada.

Descrição da operação

Importante

A OpenAPI fornecida pela Alibaba Cloud é uma Interface de Programação de Aplicativos (API) de gerenciamento. Use esta API para gerenciar e consultar recursos dos serviços da Alibaba Cloud. Integre a API apenas para fins de gerenciamento. Não dependa da API para links de dados principais que enviam e recebem mensagens. Isso pode introduzir ameaças aos seus links de dados.

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

Instance

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

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
Tag	array<object>	Não	Uma lista de tags anexadas à instância. A lista pode conter até 20 elementos.
	object	Não	Uma tag anexada à instância.
Key	string	Não	A chave da tag. Especifique Key e Value para filtrar instâncias por tag. Omita ambos para consultar todas as instâncias. Este parâmetro não pode ser uma string vazia. A chave da tag pode ter até 128 caracteres. Não pode começar com `aliyun` ou `acs:`. Não pode conter `http://` ou `https://`.	CartService
Value	string	Não	O valor da tag. Especifique Key e Value para filtrar instâncias por tag. Omita ambos para consultar todas as instâncias. Este parâmetro pode ser uma string vazia. O valor da tag pode ter até 128 caracteres. Não pode começar com `aliyun` ou `acs:`. Não pode conter `http://` ou `https://`.	SericeA
NeedResourceInfo	boolean	Não	Especifica se as estatísticas de recursos devem ser retornadas. As estatísticas incluem o número de tópicos e grupos na instância.	true

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
RequestId	string	O ID da solicitação. Este é um parâmetro comum. Cada solicitação tem um ID exclusivo. Use este ID para solucionar e localizar problemas.	0598E46F-DB06-40E2-AD7B-C45923EE****
Data	object
InstanceVO	array<object>	Uma lista de todas as instâncias publicadas.
	array<object>	Uma lista de todas as instâncias publicadas.
IndependentNaming	boolean	Indicates whether the instance has a namespace. Valid values: true: The instance has an independent namespace. Resource names must be unique within the instance, but can be the same as resource names in other instances. false: The instance does not have an independent namespace. Resource names must be globally unique within the instance and across all instances.	true
InstanceName	string	The name of the instance.	test1
ReleaseTime	integer	The expiration time of the Platinum instance.	1551024000000
InstanceStatus	integer	The status of the instance. Valid values: 0: The Platinum instance is being deployed. 2: The payment for the standard instance is overdue. 5: The standard or Platinum instance is in service. 7: The Platinum instance is being upgraded and is available.	5
Tags	object
Tag	array<object>	The tags attached to the instance.
	object	The tags attached to the instance.
Key	string	The tag key.	CartService
Value	string	The tag value.	ServiceA
InstanceId	string	The ID of the instance.	MQ_INST_188077086902****_BXSuW61e
InstanceType	integer	The type of the instance. Valid values: 1: Standard instance 2: Platinum instance For information about the specifications and differences between instance types, see Instance types.	2
CreateTime	integer	The time when the instance was created. This value is a UNIX timestamp in milliseconds.	1640847284000
TopicCount	integer	The number of topics.	1
GroupCount	integer	The number of consumer groups.	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.