GetDestination - IoT Platform - Centre de documentation Alibaba Cloud

Limites QPS

Chaque compte Alibaba Cloud peut appeler cette opération jusqu'à 10 fois par seconde (QPS).

Remarque

Les utilisateurs RAM partagent le quota du compte 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 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	GetDestination	L'opération à effectuer. Définissez la valeur sur `GetDestination`.
DestinationId	Long	Yes	1004	ID de la destination de données. Appelez l'opération ListDestination pour obtenir l'ID de la destination.
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 aucune page Overview ni aucun ID n'est généré pour votre instance, il n'est pas nécessaire de spécifier ce paramètre. Pour plus d'informations, consultez Overview.

En plus des paramètres de requête spécifiques à l'opération, vous devez spécifier les paramètres de requête communs lors de l'appel à cette opération. Pour plus d'informations, consultez Common parameters.

Paramètres de réponse

Parameter	Type	Example	Description
Code	String	iot.system.SystemException	Code d'erreur. Pour plus d'informations, consultez Error codes.
Destination	Struct		Détails de la destination de données.
Configuration	String	{"topic":"/a1POX0c****/device1/user/get","topicType":1}	Configuration de la destination de données.
DestinationId	String	1003	ID de la destination de données.
IsFailover	Boolean	false	Indique si la destination de données est utilisée pour le basculement. Une destination de basculement reçoit les données qui n'ont pas pu être transférées vers la destination d'origine après épuisement des nouvelles tentatives. true : La destination est une destination de basculement. false : La destination transfère les données normales. 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 possibles : INIT : La destination de données est en cours d'initialisation. NORMAL : La configuration est terminée. La destination de données est disponible. INVALID : La configuration est anormale. La destination de données n'est pas disponible. SHORTCUT : L'opération de transfert de données est interrompue car le service de transfert de données est anormal.
Type	String	REPUBLISH	Type de la destination de données. Valeurs possibles : REPUBLISH : transfère les données analysées vers un sujet de communication IoT Platform. AMQP : transfère les données analysées vers un groupe de consommateurs AMQP. DATAHUB : transfère les données analysées vers DataHub pour le calcul de flux. ONS : transfère les données analysées vers Message Queue for Apache RocketMQ. MNS : transfère les données analysées vers Message Service (MNS). FC : transfère les données analysées vers Function Compute pour le calcul événementiel. OTS : transfère les données analysées vers Tablestore pour le stockage de données NoSQL.
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.
RequestId	String	E4C0FF92-2A86-41DB-92D3-73B60310D25E	ID de la requête.
Success	Boolean	true	Indique si l'appel a réussi. Valeurs possibles : true : L'appel a réussi. false : L'appel a échoué.

Exemples

Exemples de requêtes

http(s)://iot.cn-shanghai.aliyuncs.com/?Action=GetDestination
&DestinationId=1004
&<Common request parameters>

Exemples de réponses réussies

Format XML

<GetDestinationResponse>
  <Destination>
        <Type>REPUBLISH</Type>
        <UtcCreated>2022-03-27T12:45:43.000Z</UtcCreated>
        <Configuration>{"topic":"/a1POX0c****/device1/user/get","topicType":1}</Configuration>
        <IsFailover>false</IsFailover>
        <Status>NORMAL</Status>
        <DestinationId>1003</DestinationId>
        <Name>DataPurpose</Name>
  </Destination>
  <RequestId>E4C0FF92-2A86-41DB-92D3-73B60310D25E</RequestId>
  <Success>true</Success>
</GetDestinationResponse>

Format JSON

{
    "Destination": {
        "Type": "REPUBLISH",
        "UtcCreated": "2022-03-27T12:45:43.000Z",
        "Configuration": "{\"topic\":\"/a1POX0c****/device1/user/get\",\"topicType\":1}",
        "IsFailover": false,
        "Status": "NORMAL",
        "DestinationId": 1003,
        "Name": "DataPurpose"
    },
    "RequestId": "E4C0FF92-2A86-41DB-92D3-73B60310D25E",
    "Success": true
}

Codes d'erreur

HttpCode	Error code	Error message	Description
400	iot.system.IllegalRequest	The request parameter is invalid.	Le paramètre de requête n'est pas valide.
400	iot.system.SystemException	An internal error occurred. Try again later.	Une exception système s'est produite.

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