ListDestination - IoT Platform - Centre de documentation Alibaba Cloud

Limites de QPS

Chaque compte Alibaba Cloud peut exécuter jusqu'à 10 requêtes par seconde (QPS).

Remarque

Les utilisateurs Resource Access Management (RAM) d'un compte Alibaba Cloud partagent le quota de ce compte.

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 l'exemple de code de l'opération pour différents SDK.

Paramètres de requête

Parameter	Type	Required	Example	Description
Action	String	Yes	ListDestination	Opération à effectuer. Définissez la valeur sur ListDestination.
Page	Integer	Yes	1	Numéro de la page à renvoyer. Valeurs valides : 1 à 100.
PageSize	Integer	Yes	10	Nombre d'entrées par page. Valeur maximale : 100.
IotInstanceId	String	No	iot-2w****	ID de l'instance. Vous pouvez afficher l'ID de l'instance sur la page Overview de la console IoT Platform. Important Si votre instance possède un ID, vous devez spécifier ce paramètre. Sinon, l'appel échoue. Si la page Overview ou l'ID de l'instance n'est pas affiché dans la console IoT Platform, vous n'avez pas besoin de spécifier ce paramètre. Pour plus d'informations, consultez la rubrique Vue d'ensemble.
SearchName	String	No	DataPurpose	Chaîne de recherche permettant de filtrer les destinations de données par nom. Spécifiez des mots-clés pour faire correspondre les noms des destinations de données.
Types.N	RepeatList	No	["REPUBLISH", "OTS"]	Types d'actions de transfert de données. Les données sont traitées par un script d'analyse avant d'être transférées. Valeurs valides : REPUBLISH : transfère les données vers une rubrique de communication IoT Platform. AMQP : transfère les données vers un groupe de consommateurs Advanced Message Queuing Protocol (AMQP). DATAHUB : transfère les données vers DataHub pour le traitement de flux. ONS : transfère les données vers Message Queue for Apache RocketMQ. MNS : transfère les données vers Message Service (MNS). FC : transfère les données vers Function Compute pour le traitement des événements. OTS : transfère les données vers Tablestore pour le stockage de données NoSQL.

En plus des paramètres de requête spécifiques à l'opération, vous devez spécifier les paramètres de requête communs lorsque vous appelez cette opération. Pour plus d'informations, consultez la rubrique Paramètres communs.

Paramètres de réponse

Parameter	Type	Example	Description
Code	String	iot.system.SystemException	Code d'erreur renvoyé en cas d'échec de l'appel. Pour plus d'informations, consultez la rubrique Codes d'erreur.
Destinations	Array of destinations		Destinations de données.
destinations
Configuration	String	{"topic":"/a1POX0c****/device1/user/get","topicType":1}	Configuration de la destination de données.
Description	String	The data is forwarded to a database.	Description de la destination de données.
DestinationId	Long	1003	ID de la destination de données.
IsFailover	Boolean	false	Indique si la destination de données reçoit les données d'opération erronées. Les données d'opération erronées correspondent aux données dont le transfert a échoué après deux tentatives consécutives. true : La destination de données reçoit les données d'opération erronées. false : La destination de données reçoit les données normales, et non les données d'opération erronées. Valeur par défaut : false
Name	String	DataPurpose	Nom de la destination de données.
Status	String	NORMAL	État de la destination de données. Valeurs valides : INIT : Configuration en cours. NORMAL : Configuration terminée et destination de données disponible. INVALID : Configuration invalide et destination de données indisponible. SHORTCUT : Une exception s'est produite et le transfert de données est arrêté.
Type	String	REPUBLISH	Action de transfert de données pour la destination de données.
UtcCreated	String	2022-03-27T12:45:43.000Z	Heure de création de la destination de données, au format UTC. Format : `yyyy-MM-dd'T'HH:mm:ss.SSS'Z'`.
ErrorMessage	String	A system exception occurred.	Message d'erreur renvoyé en cas d'échec de l'appel.
Page	Integer	1	Numéro de la page renvoyée.
PageSize	Integer	10	Nombre d'entrées renvoyées par page.
RequestId	String	E4C0FF92-2A86-41DB-92D3-73B60310D25E	ID de la requête.
Success	Boolean	true	Indique si l'appel a réussi. true : L'appel a réussi. false : L'appel a échoué.
Total	Integer	100	Nombre total de destinations de données renvoyées.

Exemples

Exemples de requêtes

http(s)://iot.cn-shanghai.aliyuncs.com/?Action=ListDestination
&Page=1
&PageSize=10
&<Common request parameters>

Exemples de réponses réussies

XML format

<ListDestinationResponse>
  <PageSize>10</PageSize>
  <RequestId>E4C0FF92-2A86-41DB-92D3-73B60310D25E</RequestId>
  <Total>100</Total>
  <Destinations>
        <destinations>
              <Type>REPUBLISH</Type>
              <Description>The data is forwarded to another topic. </Description>
              <UtcCreated>2022-03-27T12:45:43.000Z</UtcCreated>
              <Configuration>{"topic":"/a1POX0c****/device1/user/get","topicType":1}</Configuration>
              <IsFailover>false</IsFailover>
              <Status>NORMAL</Status>
              <DestinationId>1004</DestinationId>
              <Name>DataPurpose1</Name>
        </destinations>
        <destinations>
              <Type>REPUBLISH</Type>
              <Description>The data is forwarded to another topic. </Description>
              <UtcCreated>2022-03-27T12:45:43.000Z</UtcCreated>
              <Configuration>{"topic":"/a1POX0c****/device2/user/get","topicType":1}</Configuration>
              <IsFailover>false</IsFailover>
              <Status>NORMAL</Status>
              <DestinationId>1005</DestinationId>
              <Name>DataPurpose2</Name>
        </destinations>
  </Destinations>
  <Page>1</Page>
  <Success>true</Success>
</ListDestinationResponse>

JSON format

{
    "PageSize": 10,
    "RequestId": "E4C0FF92-2A86-41DB-92D3-73B60310D25E",
    "Total": 100,
    "Destinations": {
        "destinations": [
            {
                "Type": "REPUBLISH",
                "Description": "The data is forwarded to another topic.",
                "UtcCreated": "2022-03-27T12:45:43.000Z",
                "Configuration": "{\"topic\":\"/a1POX0c****/device1/user/get\",\"topicType\":1}",
                "IsFailover": false,
                "Status": "NORMAL",
                "DestinationId": 1004,
                "Name": "DataPurpose1"
            },{
                "Type": "REPUBLISH",
                "Description": "The data is forwarded to another topic.",
                "UtcCreated": "2022-03-27T12:45:43.000Z",
                "Configuration": "{\"topic\":\"/a1POX0c****/device2/user/get\",\"topicType\":1}",
                "IsFailover": false,
                "Status": "NORMAL",
                "DestinationId": 1005,
                "Name": "DataPurpose2"
            }
        ]
    },
    "Page": 1,
    "Success": true
}

Codes d'erreur

HttpCode	Error code	Error message	Description
400	iot.system.SystemException	An internal error occurred. Try again later.	Le message d'erreur renvoyé en raison d'une exception système.
400	iot.system.IllegalRequest	The request parameter is invalid.	Le message d'erreur renvoyé car le paramètre de requête n'est pas valide.

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