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

Depuração

O OpenAPI Explorer calcula automaticamente o valor da assinatura. Recomendamos chamar esta operação no OpenAPI Explorer, que também gera dinamicamente códigos de exemplo para diferentes SDKs.

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Exemplo	Descrição
Action	String	Sim	GetTopicList	Operação a ser executada. Defina o valor como GetTopicList.
InstanceId	String	Sim	alikafka_pre-cn-0pp1954n****	ID da instância cujos tópicos serão consultados.
CurrentPage	String	Não	1	Número da página a retornar.
PageSize	String	Não	10	Quantidade de entradas por página.
RegionId	String	Não	cn-hangzhou	ID da região da instância cujos tópicos serão consultados.
Topic	String	Não	topic_name	Nome do tópico a consultar.

Parâmetros de resposta

Parâmetro	Tipo	Exemplo	Descrição
CurrentPage	Integer	1	Número da página retornada.
RequestId	String	C0D3DC5B-5C37-47AD-9F22-1F5598809***	ID da solicitação.
Success	Boolean	true	Indica se a solicitação foi bem-sucedida.
Code	Integer	200	Código de status HTTP. O código 200 indica sucesso na solicitação.
Message	String	operation success.	Mensagem retornada.
PageSize	Integer	10	Quantidade de entradas retornadas por página.
Total	Integer	1	Número total de tópicos.
TopicList	Array of TopicVO		Informações dos tópicos.
TopicVO
Status	Integer	0	Status do tópico. Valor válido: 0: tópico em execução. Se o tópico tiver sido excluído, este parâmetro não será retornado.
PartitionNum	Integer	6	Número de partições do tópico.
Remark	String	test	Descrição do tópico. Deve atender aos seguintes requisitos: Conter apenas letras, dígitos, hifens (-) e sublinhados (_). Ter entre 3 e 64 caracteres.
CreateTime	Long	1576563109000	Momento de criação do tópico.
Topic	String	topic_name	Nome do tópico. Deve atender aos seguintes requisitos: Conter apenas letras, dígitos, hifens (-) e sublinhados (_). Ter entre 3 e 64 caracteres. Nomes com mais de 64 caracteres são truncados automaticamente.
StatusName	String	Running	Nome do status do tópico. Valor válido: Running Se o tópico tiver sido excluído, este parâmetro não será retornado.
CompactTopic	Boolean	false	Política de limpeza de log do tópico. Retornado quando LocalTopic é definido como true. Valores válidos: false: política padrão de limpeza de log. true: política de compactação de log do Apache Kafka.
InstanceId	String	alikafka_pre-cn-0pp1954n****	ID da instância à qual o tópico pertence.
LocalTopic	Boolean	false	Mecanismo de armazenamento do tópico. Valores válidos: false: modo Cloud Storage. true: modo Local Storage.
RegionId	String	cn-hangzhou	ID da região da instância à qual o tópico pertence.
Tags	Array of TagVO		Tags associadas ao tópico.
TagVO
Key	String	Test	Chave da tag.
Value	String	Test	Valor da tag.

Exemplos

Exemplos de solicitações

http(s)://alikafka.cn-hangzhou.aliyuncs.com/?Action=GetTopicList
&InstanceId=alikafka_pre-cn-0pp1954n****
&CurrentPage=1
&PageSize=10
&RegionId=cn-hangzhou
&Topic=topic_name
&<Common request parameters>

Exemplos de respostas de sucesso

Formato XML

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

<GetTopicListResponse>
    <CurrentPage>1</CurrentPage>
    <RequestId>C0D3DC5B-5C37-47AD-9F22-1F5598809***</RequestId>
    <Success>true</Success>
    <Code>200</Code>
    <Message>operation success.</Message>
    <PageSize>10</PageSize>
    <Total>1</Total>
    <TopicList>
        <Status>0</Status>
        <PartitionNum>6</PartitionNum>
        <Remark>test</Remark>
        <CreateTime>1576563109000</CreateTime>
        <Topic>topic_name</Topic>
        <StatusName>Running</StatusName>
        <CompactTopic>false</CompactTopic>
        <InstanceId>alikafka_pre-cn-0pp1954n****</InstanceId>
        <LocalTopic>false</LocalTopic>
        <RegionId>cn-hangzhou</RegionId>
        <Tags>
            <Key>Test</Key>
            <Value>Test</Value>
        </Tags>
    </TopicList>
</GetTopicListResponse>

Formato JSON

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

{
  "CurrentPage" : 1,
  "RequestId" : "C0D3DC5B-5C37-47AD-9F22-1F5598809***",
  "Success" : true,
  "Code" : 200,
  "Message" : "operation success.",
  "PageSize" : 10,
  "Total" : 1,
  "TopicList" : [ {
    "Status" : 0,
    "PartitionNum" : 6,
    "Remark" : "test",
    "CreateTime" : 1576563109000,
    "Topic" : "topic_name",
    "StatusName": "Running",
    "CompactTopic" : false,
    "InstanceId" : "alikafka_pre-cn-0pp1954n****",
    "LocalTopic" : false,
    "RegionId" : "cn-hangzhou",
    "Tags" : [ {
      "Key" : "Test",
      "Value" : "Test"
    } ]
  } ]
}

Códigos de erro

Para obter uma lista de códigos de erro, visite o API Error Center.