GetTopicStatus - - Centre de documentation Alibaba Cloud

Débogage

OpenAPI Explorer calcule automatiquement la valeur de signature. Pour plus de commodité, nous vous recommandons d'appeler cette opération dans OpenAPI Explorer. OpenAPI Explorer génère dynamiquement des exemples de code pour différents SDK.

Paramètres de requête

Paramètre	Type	Obligatoire	Exemple	Description
Action	String	Oui	GetTopicStatus	Opération à effectuer. Définissez la valeur sur GetTopicStatus.
InstanceId	String	Oui	alikafka_pre-cn-v0h15tjmo003	ID de l'instance Message Queue for Apache Kafka contenant le topic.
Topic	String	Oui	normal_topic_9d034262835916103455551be06cc2dc_6	Nom du topic à interroger.
RegionId	String	Non	cn-hangzhou	ID de la région où se trouve l'instance.

Paramètres de réponse

Paramètre	Type	Exemple	Description
Code	Integer	200	Code de réponse. Le code HTTP 200 indique que la requête a abouti.
Message	String	operation success.	Message de réponse.
RequestId	String	E475C7E2-8C35-46EF-BE7D-5D2A9F5D****	ID de la requête.
Success	Boolean	true	Indique si la requête a abouti.
TopicStatus	Struct		Statut d'envoi et de réception des messages du topic.
LastTimeStamp	Long	1566470063575	Heure de génération du dernier message consommé.
OffsetTable	Array		Liste des décalages (offsets) des consommateurs dans le topic.
OffsetTable
LastUpdateTimestamp	Long	1566470063547	Heure de la dernière mise à jour du décalage du consommateur dans le topic.
MaxOffset	Long	76	Décalage maximal du consommateur dans la partition actuelle du topic.
MinOffset	Long	0	Décalage minimal du consommateur dans la partition actuelle du topic.
Partition	Integer	0	ID de la partition dans le topic.
Topic	String	testkafka	Nom du topic.
TotalCount	Long	423	Nombre total de messages dans le topic.

Exemples

Exemples de requêtes

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

Exemples de réponses réussies

Format XML

<GetTopicStatusResponse>
      <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>
</GetTopicStatusResponse>

Format JSON

{
    "RequestId":"E475C7E2-8C35-46EF-BE7D-5D2A9F5D****",
    "Message":"operation success.",
    "TopicStatus":{
        "LastTimeStamp":"1566470063575",
        "TotalCount":"423",
        "OffsetTable":{
            "OffsetTable":[
                {
                    "Partition":"0",
                    "MaxOffset":"76",
                    "Topic":"testkafka",
                    "LastUpdateTimestamp":"1566470063547",
                    "MinOffset":"0"
                }
            ]
        }
    },
    "Code":"200",
    "Success":"true"
}

Codes d'erreur

Pour obtenir la liste des codes d'erreur, consultez le Centre d'erreurs API.