GetTopicStatus - : 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 para maior conveniência. A ferramenta também gera dinamicamente códigos de exemplo da operação para diferentes SDKs.

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Exemplo	Descrição
Action	String	Sim	GetTopicStatus	A operação a ser executada. Defina o valor como GetTopicStatus.
InstanceId	String	Sim	alikafka_pre-cn-v0h15tjmo003	O ID da instância do Message Queue for Apache Kafka onde o tópico está localizado.
Topic	String	Sim	normal_topic_9d034262835916103455551be06cc2dc_6	O nome do tópico.
RegionId	String	Não	cn-hangzhou	O ID da região da instância do Message Queue for Apache Kafka onde o tópico está localizado.

Parâmetros de resposta

Parâmetro	Tipo	Exemplo	Descrição
Code	Integer	200	Código de status retornado. Se "200" for retornado, a solicitação foi bem-sucedida.
Message	String	operation success.	Mensagem retornada.
RequestId	String	E475C7E2-8C35-46EF-BE7D-5D2A9F5D****	ID da solicitação.
Success	Boolean	true	Indica se a solicitação foi bem-sucedida.
TopicStatus	Struct		Status de envio e recebimento de mensagens do tópico.
LastTimeStamp	Long	1566470063575	Momento em que a última mensagem consumida foi gerada.
OffsetTable	Array		Lista de offsets de consumidor retornada no tópico.
OffsetTable
LastUpdateTimestamp	Long	1566470063547	Última atualização do offset de consumidor no tópico.
MaxOffset	Long	76	Offset máximo de consumidor na partição atual do tópico.
MinOffset	Long	0	Offset mínimo de consumidor na partição atual do tópico.
Partition	Integer	0	ID da partição no tópico.
Topic	String	testkafka	Nome do tópico.
TotalCount	Long	423	Número total de mensagens no tópico.

Exemplos

Exemplos de solicitações

http(s)://[Endpoint]/? Action=GetTopicStatus
&InstanceId=alikafka_pre-cn-v0h15tjmo003
&Topic=normal_topic_9d034262835916103455551be06cc2dc_6
&<Common request parameters>

Exemplos de respostas de sucesso

Formato XML

<Message>operation success. </Message>
<RequestId>D2FF4C1A-2A4A-4C24-BFCD-A2FF2DC1AAFE</RequestId>
<TopicStatus>
    <TotalCount>0</TotalCount>
    <LastTimeStamp>0</LastTimeStamp>
    <OffsetTable>
        <OffsetTable>
            <Partition>0</Partition>
            <LastUpdateTimestamp>0</LastUpdateTimestamp>
            <Topic>demo</Topic>
            <MaxOffset>0</MaxOffset>
            <MinOffset>0</MinOffset>
        </OffsetTable>
        <OffsetTable>
            <Partition>1</Partition>
            <LastUpdateTimestamp>0</LastUpdateTimestamp>
            <Topic>demo</Topic>
            <MaxOffset>0</MaxOffset>
            <MinOffset>0</MinOffset>
        </OffsetTable>
        <OffsetTable>
            <Partition>2</Partition>
            <LastUpdateTimestamp>0</LastUpdateTimestamp>
            <Topic>demo</Topic>
            <MaxOffset>0</MaxOffset>
            <MinOffset>0</MinOffset>
        </OffsetTable>
        <OffsetTable>
            <Partition>3</Partition>
            <LastUpdateTimestamp>0</LastUpdateTimestamp>
            <Topic>demo</Topic>
            <MaxOffset>0</MaxOffset>
            <MinOffset>0</MinOffset>
        </OffsetTable>
        <OffsetTable>
            <Partition>4</Partition>
            <LastUpdateTimestamp>0</LastUpdateTimestamp>
            <Topic>demo</Topic>
            <MaxOffset>0</MaxOffset>
            <MinOffset>0</MinOffset>
        </OffsetTable>
        <OffsetTable>
            <Partition>5</Partition>
            <LastUpdateTimestamp>0</LastUpdateTimestamp>
            <Topic>demo</Topic>
            <MaxOffset>0</MaxOffset>
            <MinOffset>0</MinOffset>
        </OffsetTable>
        <OffsetTable>
            <Partition>6</Partition>
            <LastUpdateTimestamp>0</LastUpdateTimestamp>
            <Topic>demo</Topic>
            <MaxOffset>0</MaxOffset>
            <MinOffset>0</MinOffset>
        </OffsetTable>
        <OffsetTable>
            <Partition>7</Partition>
            <LastUpdateTimestamp>0</LastUpdateTimestamp>
            <Topic>demo</Topic>
            <MaxOffset>0</MaxOffset>
            <MinOffset>0</MinOffset>
        </OffsetTable>
        <OffsetTable>
            <Partition>8</Partition>
            <LastUpdateTimestamp>0</LastUpdateTimestamp>
            <Topic>demo</Topic>
            <MaxOffset>0</MaxOffset>
            <MinOffset>0</MinOffset>
        </OffsetTable>
        <OffsetTable>
            <Partition>9</Partition>
            <LastUpdateTimestamp>0</LastUpdateTimestamp>
            <Topic>demo</Topic>
            <MaxOffset>0</MaxOffset>
            <MinOffset>0</MinOffset>
        </OffsetTable>
        <OffsetTable>
            <Partition>10</Partition>
            <LastUpdateTimestamp>0</LastUpdateTimestamp>
            <Topic>demo</Topic>
            <MaxOffset>0</MaxOffset>
            <MinOffset>0</MinOffset>
        </OffsetTable>
        <OffsetTable>
            <Partition>11</Partition>
            <LastUpdateTimestamp>0</LastUpdateTimestamp>
            <Topic>demo</Topic>
            <MaxOffset>0</MaxOffset>
            <MinOffset>0</MinOffset>
        </OffsetTable>
    </OffsetTable>
</TopicStatus>
<Success>true</Success>
<Code>200</Code>

Formato JSON

{
    "Message": "operation success.",
    "RequestId": "D2FF4C1A-2A4A-4C24-BFCD-A2FF2DC1AAFE",
    "TopicStatus": {
        "TotalCount": 0,
        "LastTimeStamp": 0,
        "OffsetTable": {
            "OffsetTable": [
                {
                    "Partition": 0,
                    "LastUpdateTimestamp": 0,
                    "Topic": "demo",
                    "MaxOffset": 0,
                    "MinOffset": 0
                },
                {
                    "Partition": 1,
                    "LastUpdateTimestamp": 0,
                    "Topic": "demo",
                    "MaxOffset": 0,
                    "MinOffset": 0
                },
                {
                    "Partition": 2,
                    "LastUpdateTimestamp": 0,
                    "Topic": "demo",
                    "MaxOffset": 0,
                    "MinOffset": 0
                },
                {
                    "Partition": 3,
                    "LastUpdateTimestamp": 0,
                    "Topic": "demo",
                    "MaxOffset": 0,
                    "MinOffset": 0
                },
                {
                    "Partition": 4,
                    "LastUpdateTimestamp": 0,
                    "Topic": "demo",
                    "MaxOffset": 0,
                    "MinOffset": 0
                },
                {
                    "Partition": 5,
                    "LastUpdateTimestamp": 0,
                    "Topic": "demo",
                    "MaxOffset": 0,
                    "MinOffset": 0
                },
                {
                    "Partition": 6,
                    "LastUpdateTimestamp": 0,
                    "Topic": "demo",
                    "MaxOffset": 0,
                    "MinOffset": 0
                },
                {
                    "Partition": 7,
                    "LastUpdateTimestamp": 0,
                    "Topic": "demo",
                    "MaxOffset": 0,
                    "MinOffset": 0
                },
                {
                    "Partition": 8,
                    "LastUpdateTimestamp": 0,
                    "Topic": "demo",
                    "MaxOffset": 0,
                    "MinOffset": 0
                },
                {
                    "Partition": 9,
                    "LastUpdateTimestamp": 0,
                    "Topic": "demo",
                    "MaxOffset": 0,
                    "MinOffset": 0
                },
                {
                    "Partition": 10,
                    "LastUpdateTimestamp": 0,
                    "Topic": "demo",
                    "MaxOffset": 0,
                    "MinOffset": 0
                },
                {
                    "Partition": 11,
                    "LastUpdateTimestamp": 0,
                    "Topic": "demo",
                    "MaxOffset": 0,
                    "MinOffset": 0
                }
            ]
        }
    },
    "Success": true,
    "Code": 200
}

Códigos de erro

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