GetTopicList - - Centre de documentation Alibaba Cloud

Débogage

OpenAPI Explorer calcule automatiquement la valeur de signature. Nous vous recommandons d'appeler cette opération dans OpenAPI Explorer pour plus de commodité. 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	GetTopicList	Opération à exécuter. Définissez la valeur sur GetTopicList.
InstanceId	String	Oui	alikafka_pre-cn-0pp1954n****	ID de l'instance dont vous souhaitez interroger les topics.
CurrentPage	String	Non	1	Numéro de la page à renvoyer.
PageSize	String	Non	10	Nombre d'entrées à renvoyer par page.
RegionId	String	Non	cn-hangzhou	ID de région de l'instance dont vous souhaitez interroger les topics.
Topic	String	Non	topic_name	Nom du topic que vous souhaitez interroger.

Paramètres de réponse

Paramètre	Type	Exemple	Description
CurrentPage	Integer	1	Numéro de la page renvoyée.
RequestId	String	C0D3DC5B-5C37-47AD-9F22-1F5598809***	ID de la requête.
Success	Boolean	true	Indique si la requête a abouti.
Code	Integer	200	Code d'état HTTP. Le code 200 indique que la requête a abouti.
Message	String	operation success.	Message renvoyé.
PageSize	Integer	10	Nombre d'entrées renvoyées par page.
Total	Integer	1	Nombre total de topics.
TopicList	Array of TopicVO		Informations relatives aux topics.
TopicVO
Status	Integer	0	Statut du topic. Valeur valide : 0 : indique que le topic est en cours d'exécution. Si ce topic a été supprimé, ce paramètre n'est pas renvoyé.
PartitionNum	Integer	6	Nombre de partitions dans le topic.
Remark	String	test	Description du topic. La description doit respecter les exigences suivantes : La description ne peut contenir que des lettres, des chiffres, des traits d'union (-) et des traits de soulignement (_). La longueur de la description doit être comprise entre 3 et 64 caractères.
CreateTime	Long	1576563109000	Heure de création du topic.
Topic	String	topic_name	Nom du topic. Le nom du topic doit respecter les exigences suivantes : Le nom ne peut contenir que des lettres, des chiffres, des traits d'union (-) et des traits de soulignement (_). La longueur du nom doit être comprise entre 3 et 64 caractères. Les noms contenant plus de 64 caractères sont automatiquement tronqués.
StatusName	String	Running	Nom du statut du topic. Valeur valide : Running Si ce topic a été supprimé, ce paramètre n'est pas renvoyé.
CompactTopic	Boolean	false	Politique de nettoyage des journaux pour le topic. Ce paramètre est renvoyé lorsque LocalTopic est défini sur true. Valeurs valides : false : utilise la politique de nettoyage des journaux par défaut. true : utilise la politique de compaction des journaux Apache Kafka.
InstanceId	String	alikafka_pre-cn-0pp1954n****	ID de l'instance sur laquelle réside le topic.
LocalTopic	Boolean	false	Moteur de stockage du topic. Valeurs valides : false : mode Cloud Storage. true : mode Local Storage.
RegionId	String	cn-hangzhou	ID de région de l'instance sur laquelle réside le topic.
Tags	Array of TagVO		Tags associés au topic.
TagVO
Key	String	Test	Clé du tag.
Value	String	Test	Valeur du tag.

Exemples

Exemples de requêtes

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>

Exemples de réponses réussies

Format 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>

Format 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"
    } ]
  } ]
}

Codes d'erreur

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