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

Descrição

Esta operação consulta uma lista de recursos, e não seus detalhes individuais.

Limites de taxa da API

Cada conta pode chamar esta operação até 10 vezes por segundo. O sistema ativa o throttling quando a frequência de chamadas à API excede esse limite, o que pode interromper seus serviços. Recomendamos ajustar a frequência das chamadas adequadamente. Para mais informações, consulte Limites de taxa da API.

Autorização

Por padrão, apenas contas Alibaba Cloud podem executar esta operação. Um usuário RAM precisa receber as permissões necessárias antes de chamá-la. A tabela a seguir lista as permissões obrigatórias para invocar esta operação.

API	Action	Resource
OnsTopicList	mq:QueryInstanceBaseInfo	acs:mq:::{instanceId}

Nota

No entanto, quando um usuário RAM chama esta operação, o sistema retorna apenas dados sobre os recursos nos quais ele tem permissão para publicar e assinar. Para acessar dados de outros recursos, a conta Alibaba Cloud deve conceder as permissões correspondentes ao usuário RAM. Para mais informações, consulte

Políticas e exemplos

.

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Exemplo	Descrição
Action	String	Sim	OnsTopicList	A operação a ser executada. Defina o valor como OnsTopicList.
Topic	String	Não	test	Nome do tópico a consultar. Este parâmetro é necessário para consultar um tópico específico. Se você não definir este parâmetro, o sistema consultará todos os tópicos.
InstanceId	String	Sim	MQ_INST_188077086902****_BXSuW61e	ID da instância do Message Queue for Apache RocketMQ à qual pertence o tópico que você deseja consultar.
Tag.N.Key	String	Sim	CartService	Chave de uma tag associada ao tópico. Este parâmetro não é obrigatório, mas se você o definir, também deverá definir o parâmetro Tag.N.Value. Quando ambos os parâmetros Tag.N.Key e Tag.N.Value estão definidos, o sistema filtra os tópicos com base na tag. Caso contrário, todos os tópicos serão consultados. Valores válidos de N: 1 a 20. O valor do parâmetro não pode ser uma string vazia. Pode ter até 128 caracteres e não pode começar com acs: ou aliyun. Não pode conter http:// ou https://.
Tag.N.Value	String	Sim	ServiceA	Valor de uma tag associada ao tópico que você deseja consultar. Este parâmetro não é obrigatório, mas se você o definir, também deverá definir o parâmetro Tag.N.Value. Quando ambos os parâmetros Tag.N.Key e Tag.N.Value estão definidos, o sistema filtra os tópicos com base na tag. Caso contrário, todos os tópicos serão consultados. Valores válidos de N: 1 a 20. O valor do parâmetro pode ser uma string vazia. Pode ter até 128 caracteres e não pode começar com acs: ou aliyun. Não pode conter http:// ou https://.

Parâmetros de resposta

Parâmetro	Tipo	Exemplo	Descrição
RequestId	String	4A978869-7681-4529-B470-107E1379****	ID da solicitação. Trata-se de um parâmetro comum; cada solicitação possui um ID exclusivo. Use este ID para solucionar problemas.
Data	Array of PublishInfoDo		Lista de todos os tópicos na instância especificada.
PublishInfoDo
MessageType	Integer	0	Tipo da mensagem. Valores válidos: 0: mensagens padrão 1: mensagens ordenadas por partição 2: mensagens ordenadas globalmente 4: mensagens transacionais 5: mensagens agendadas ou atrasadas
RelationName	String	Authorized publishing and subscription	Nome da relação entre a conta Alibaba Cloud e as mensagens no tópico, como proprietário, publicador, assinante, ou publicador e assinante.
Owner	String	138015630679****	ID do proprietário do tópico. Corresponde ao ID da conta Alibaba Cloud.
IndependentNaming	Boolean	true	Indica se há um namespace configurado para a instância do Message Queue for Apache RocketMQ à qual o tópico pertence. Valores válidos: true: A instância possui um namespace separado. Os nomes dos recursos devem ser exclusivos dentro da instância, mas recursos em instâncias diferentes podem ter o mesmo nome. false: Não há namespace separado configurado para a instância. Os nomes dos recursos devem ser exclusivos em todas as instâncias.
Remark	String	Test	Observação.
Relation	Integer	6	Código da relação entre a conta Alibaba Cloud e as mensagens no tópico. Valores válidos: 1: A conta Alibaba Cloud é proprietária do tópico. 2: A conta Alibaba Cloud pode publicar mensagens no tópico. 4: A conta Alibaba Cloud pode assinar o tópico. 6: A conta Alibaba Cloud pode publicar mensagens e assinar o tópico.
CreateTime	Long	1570700947000	Horário de criação do tópico.
Topic	String	test	Nome do tópico.
Tags	Array of Tag		Tags associadas ao tópico.
Tag
Key	String	CartService	Chave da tag.
Value	String	SrviceA	Valor da tag.
InstanceId	String	MQ_INST_188077086902****_BXSuW61e	ID da instância do Message Queue for Apache RocketMQ à qual o tópico pertence.
ServiceStatus	Integer	0	Status do tópico criado de forma assíncrona. Valores válidos: 0: O tópico está sendo criado. 1: O tópico está em uso.

Exemplos

Exemplos de solicitações

http(s)://ons.cn-zhangjiakou.aliyuncs.com/?Action=OnsTopicList
&InstanceId=MQ_INST_188077086902****_BXSuW61e
&Tag.1.Key=CartService
&Tag.1.Value=ServiceA
&<Common request parameters>

Exemplos de respostas de sucesso

Formato XML

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

<OnsTopicListResponse>
    <RequestId>4A978869-7681-4529-B470-107E1379****</RequestId>
    <Data>
        <MessageType>0</MessageType>
        <RelationName>Authorized publishing and subscription</RelationName>
        <Owner>138015630679****</Owner>
        <IndependentNaming>true</IndependentNaming>
        <Remark>Test</Remark>
        <Relation>6</Relation>
        <CreateTime>1570700947000</CreateTime>
        <Topic>test</Topic>
        <Tags>
            <Key>CartService</Key>
            <Value>SrviceA</Value>
        </Tags>
        <InstanceId>MQ_INST_188077086902****_BXSuW61e</InstanceId>
        <ServiceStatus>0</ServiceStatus>
    </Data>
</OnsTopicListResponse>

Formato JSON

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

{
  "RequestId" : "4A978869-7681-4529-B470-107E1379****",
  "Data" : [ {
    "MessageType" : 0,
    "RelationName": "Authorized publishing and subscription",
    "Owner" : "138015630679****",
    "IndependentNaming" : true,
    "Remark": "Test",
    "Relation" : 6,
    "CreateTime" : 1570700947000,
    "Topic" : "test",
    "Tags" : [ {
      "Key" : "CartService",
      "Value" : "SrviceA"
    } ],
    "InstanceId" : "MQ_INST_188077086902****_BXSuW61e",
    "ServiceStatus" : 0
  } ]
}

Códigos de erro

Para obter uma lista de códigos de erro, visite a Central de Erros da API.