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

Consulta informações sobre todos os tópicos na sua conta.

Descrição da operação

Importante A OpenAPI do Alibaba Cloud é uma API de gerenciamento que você pode usar para gerenciar e consultar recursos dos serviços do Alibaba Cloud. Integre esta API apenas para fins de gerenciamento. Não dependa desta API para links de dados principais que enviam e recebem mensagens. Isso pode criar ameaças à segurança dos seus links de dados.

Esta operação é normalmente usada para gerar uma lista de recursos, e não para visualizar detalhes específicos.

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:ListTopic

list

Instance

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

Nenhuma

mq:QueryInstanceBaseInfo

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
Topic	string	Não	Especifique o tópico a ser consultado. Se você deixar este parâmetro vazio, todos os tópicos serão consultados.	test
InstanceId	string	Não	O ID da instância que contém os tópicos que você deseja consultar.	MQ_INST_188077086902****_BXSuW61e
Tag	array<object>	Não	A lista de tags anexadas ao tópico. A lista pode conter no máximo 20 elementos.
	object	Não	A estrutura da tag retornada.
Key	string	Sim	A chave da tag do tópico. Você deve especificar os parâmetros Key e Value ao mesmo tempo ou deixar ambos vazios. Se você especificar ambos os parâmetros, esta operação consultará os tópicos que possuem a tag especificada. Se você deixar ambos os parâmetros vazios, esta operação consultará todos os tópicos. Se você especificar este parâmetro, seu valor não poderá ser uma string vazia. O valor pode ter até 128 caracteres. Não pode começar com `aliyun` ou `acs:`. Não pode conter `http://` ou `https://`.	CartService
Value	string	Sim	O valor da tag do tópico. Você deve especificar os parâmetros Key e Value ao mesmo tempo ou deixar ambos vazios. Se você especificar ambos os parâmetros, esta operação consultará os tópicos que possuem a tag especificada. Se você deixar ambos os parâmetros vazios, esta operação consultará todos os tópicos. Se você especificar este parâmetro, seu valor poderá ser uma string vazia. O valor pode ter até 128 caracteres. Não pode começar com `aliyun` ou `acs:`. Não pode conter `http://` ou `https://`.	ServiceA

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	A estrutura de dados retornada.
RequestId	string	Este é um parâmetro comum. Cada solicitação possui um ID exclusivo. Você pode usar este ID para solucionar problemas.	4A978869-7681-4529-B470-107E1379****
Data	object
PublishInfoDo	array<object>	A lista de tópicos na instância especificada.
	array<object>	A estrutura de dados do tópico retornado.
MessageType	integer	The message type. Valid values: 0: Normal message 1: Partitionally ordered message 2: Globally ordered message 4: Transactional message 5: Scheduled and delayed message	0
RelationName	string	The relation name. Valid values are Owner, Subscribable, Publishable, and Publishable and Subscribable.	授权发布/订阅
Owner	string	The ID of the topic owner. This is the ID of an Alibaba Cloud account.	138015630679****
IndependentNaming	boolean	Indicates whether the instance that contains the topic has a namespace. Valid values: true: The instance has an independent namespace. The resource name must be unique within the instance. The resource name can be the same as a resource name in another instance. false: The instance does not have an independent namespace. The resource name must be globally unique within and across all instances.	true
Remark	string	The remarks.	测试
Relation	integer	The relation ID. Valid values: 1: The owner of the topic. 2: The account can publish messages to the topic. 4: The account can subscribe to the topic. 6: The account can publish messages to and subscribe to the topic.	6
CreateTime	integer	The time when the topic was created.	1570700947000
Topic	string	The topic name.	test
Tags	object
Tag	array<object>	The tags that are attached to the topic.
	object	The definition of the tag structure.
Key	string	The tag key.	CartService
Value	string	The tag value.	SrviceA
InstanceId	string	The ID of the instance that contains the topic.	MQ_INST_188077086902****_BXSuW61e
ServiceStatus	integer	The status of the asynchronous topic creation. Valid values: 0: Creating. 1: In service.	0

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "4A978869-7681-4529-B470-107E1379****",
  "Data": {
    "PublishInfoDo": [
      {
        "MessageType": 0,
        "RelationName": "授权发布/订阅",
        "Owner": "138015630679****",
        "IndependentNaming": true,
        "Remark": "测试",
        "Relation": 6,
        "CreateTime": 1570700947000,
        "Topic": "test",
        "Tags": {
          "Tag": [
            {
              "Key": "CartService",
              "Value": "SrviceA"
            }
          ]
        },
        "InstanceId": "MQ_INST_188077086902****_BXSuW61e",
        "ServiceStatus": 0
      }
    ]
  }
}

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.