CreateDestination - 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 d'un compte Alibaba Cloud partagent le quota du compte.

Débogage

OpenAPI Explorer calcule automatiquement la valeur de signature. 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

Paramètre	Type	Obligatoire	Exemple	Description
Action	String	Oui	CreateDestination	L'opération à effectuer. Définissez la valeur sur CreateDestination.
Name	String	Oui	DataPurpose	Le nom de la destination de données.
Type	String	Oui	REPUBLISH	Le type d'opération à effectuer sur les données. Valeurs valides : REPUBLISH : transfère les données de rubrique traitées par un script d'analyse vers une rubrique de communication IoT Platform. AMQP : transfère les données de rubrique traitées par un script d'analyse vers un groupe de consommateurs AMQP (Advanced Message Queuing Protocol). DATAHUB : transfère les données de rubrique traitées par un script d'analyse vers DataHub pour le calcul de flux. ONS : transfère les données de rubrique traitées par un script d'analyse vers Message Queue for Apache RocketMQ pour la distribution de messages. MNS : transfère les données de rubrique traitées par un script d'analyse vers Message Service (MNS) pour la transmission de messages. FC : transfère les données de rubrique traitées par un script d'analyse vers Function Compute pour le calcul d'événements. OTS : transfère les données de rubrique traitées par un script d'analyse vers Tablestore (OTS) pour le stockage de données NoSQL.
Configuration	String	Oui	{"topic":"/a1POX0c****/device1/user/get","topicType":1}	La configuration de la destination de données au format JSON. La configuration varie en fonction du type de destination. Pour la syntaxe requise et des exemples, consultez les tableaux suivants.
IotInstanceId	String	Non	iot-2w****	L'ID de l'instance. Vous pouvez consulter l'ID sur la page Overview de la console IoT Platform. Important Si votre instance possède un ID, vous devez le spécifier pour ce paramètre. Sinon, l'appel échouera. Si aucune page Overview ou aucun ID n'est généré pour votre instance, vous n'avez pas besoin de spécifier ce paramètre. Pour plus d'informations, consultez Vue d'ensemble.
Description	String	Non	Les données que vous souhaitez transférer vers une base de données.	La description de la destination de données.

Configurations du type REPUBLISH

Paramètre	Description
productKey	Le ProductKey du produit auquel appartient la rubrique de destination.

Exemples


{
    "productKey":"hf****3xn"
}

Configurations du type AMQP

Paramètre	Description
groupId	L'ID du groupe de consommateurs.

Exemple


{
    "groupId":"ZTh1JmuZcUfv44p4z00****"
}

Configurations du type OTS

Paramètre	Description
instanceName	Le nom de l'instance Tablestore destinée à recevoir les données.
regionName	Le code de la région où Tablestore est déployé. Exemple : cn-shanghai.
tableName	Le nom de la table destinée à recevoir les données.
role	Les informations relatives au rôle RAM. Vous pouvez accorder à IoT Platform l'accès à Tablestore en attribuant un rôle de service. La syntaxe d'un rôle RAM : `{"roleName":"AliyunIOTAccessingOTSRole","roleArn":"acs:ram::${uid}:role/aliyuniotaccessingotsrole"}` `${uid}` spécifie l'ID de votre compte Alibaba Cloud. Connectez-vous à la console Alibaba Cloud Management Console et consultez l'ID du compte sur la page Security Settings. `AliyunIOTAccessingOTSRole` est un rôle lié au service défini dans RAM. Ce rôle accorde à IoT Platform les autorisations d'accès à Tablestore. Vous pouvez gérer les rôles RAM sur la page RAM Roles de la console RAM.

Exemple


{
    "instanceName":"${instanceName}",
    "regionName":"cn-shanghai",
    "tableName":"test_table",
    "role":{
        "roleName":"AliyunIOTAccessingOTSRole",
        "roleArn":"acs:ram::${uid}:role/aliyuniotaccessingotsrole"
    }
}

Configurations du type DATAHUB

Paramètre	Description
projectName	Le nom du projet DataHub destiné à recevoir les données.
topicName	Le nom de la rubrique DataHub destinée à recevoir les données.
regionName	Le code de la région où DataHub est déployé. Exemple : cn-shanghai.
role	Les informations relatives au rôle RAM. Vous pouvez accorder à IoT Platform l'accès à DataHub en attribuant un rôle de service. La syntaxe d'un rôle RAM : `{"roleArn":"acs:ram::${uid}:role/aliyuniotaccessingdatahubrole","roleName": "AliyunIOTAccessingDataHubRole"}` `${uid}` spécifie l'ID de votre compte Alibaba Cloud. Connectez-vous à la console Alibaba Cloud Management Console et consultez l'ID du compte sur la page Security Settings. `AliyunIOTAccessingDataHubRole` est un rôle lié au service défini dans RAM. Ce rôle accorde à IoT Platform les autorisations d'accès à DataHub. Vous pouvez gérer les rôles RAM sur la page RAM Roles de la console RAM.

Exemple


{
    "role":{
        "roleArn": "acs:ram::${uid}:role/aliyuniotaccessingdatahubrole",
        "roleName": "AliyunIOTAccessingDataHubRole"
    },
    "ProjectName": "test_project_name",
    "RegionName": "cn-shanghai",
    "TopicName": "test_topic"
}

Configurations du type MNS

Paramètre	Description
themeName	Le nom de la rubrique MNS destinée à recevoir les données.
regionName	Le code de la région où MNS est déployé. Exemple : cn-shanghai.
role	Les informations relatives au rôle RAM. Pour accorder à IoT Platform l'accès à MNS, attribuez un rôle de service à IoT Platform. La syntaxe d'un rôle RAM : `{"roleArn":"acs:ram::${uid}:role/aliyuniotaccessingmnsrole","roleName": "AliyunIOTAccessingMNSRole"}` `${uid}` spécifie l'ID de votre compte Alibaba Cloud. Connectez-vous à la console Alibaba Cloud Management Console et consultez l'ID du compte sur la page Security Settings. `AliyunIOTAccessingMNSRole` est un rôle lié au service défini dans RAM. Ce rôle accorde à IoT Platform les autorisations d'accès à MNS. Vous pouvez gérer les rôles RAM sur la page RAM Roles de la console RAM.

Exemple


{
    "themeName": "test_name",
    "role":{
        "roleArn": "acs:ram::${uid}:role/aliyuniotaccessingmnsrole",
        "roleName": "AliyunIOTAccessingMNSRole"
    },
    "regionName": "cn-shanghai"
}

Configurations du type ONS

Remarque

Pour accorder à IoT Platform des autorisations sur Message Queue for Apache RocketMQ, appelez le SDK ou connectez-vous à la console Message Queue for Apache RocketMQ. IoT Platform doit être autorisé à publier des messages dans Message Queue for Apache RocketMQ avant que vous ne puissiez créer une action de règle pour transférer des données vers le service.

Paramètre	Description
instanceId	L'ID de l'instance Message Queue for Apache RocketMQ destinée à recevoir les données.
topic	Le nom de la rubrique Message Queue for Apache RocketMQ destinée à recevoir les données.
regionName	Le code de la région où Message Queue for Apache RocketMQ est déployé. Exemple : cn-shanghai. Vous ne pouvez transférer des données qu'au sein de la même région.
role	Les informations relatives au rôle RAM. Vous pouvez accorder à IoT Platform l'accès à Message Queue for Apache RocketMQ en attribuant un rôle de service. La syntaxe d'un rôle RAM : `{"roleArn":"acs:ram::${uid}:role/aliyuniotaccessingmqrole","roleName": "AliyunIOTAccessingMQRole"}` `${uid}` spécifie l'ID de votre compte Alibaba Cloud. Connectez-vous à la console Alibaba Cloud Management Console et consultez l'ID du compte sur la page Security Settings. `AliyunIOTAccessingFCRole` est un rôle lié au service défini dans la console RAM. Ce rôle accorde à IoT Platform les autorisations d'accès à Message Queue for Apache RocketMQ. Vous pouvez gérer les rôles RAM sur la page RAM Roles de la console RAM.

Exemple


{
    "instanceId": "${MQ_INST_ID}",
    "role":
    {
        "roleArn": "acs:ram::${uid}:role/aliyuniotaccessingmqrole",
        "roleName": "AliyunIOTAccessingMQRole"
    },
    "regionName": "cn-shanghai",
    "topic": "test_topic"
}

Configurations du type FC

Paramètre	Description
functionName	Le nom de la fonction destinée à recevoir les données.
serviceName	Le nom du service destiné à recevoir les données.
regionName	L'ID de la région où Function Compute est déployé. Exemple : cn-shanghai.
role	Les informations relatives au rôle RAM. Vous pouvez accorder à IoT Platform l'accès à Function Compute en attribuant un rôle de service. La syntaxe d'un rôle RAM : `{"roleArn":"acs:ram::${uid}:role/aliyuniotaccessingfcrole","roleName": "AliyunIOTAccessingFCRole"}` `${uid}` spécifie l'ID de votre compte Alibaba Cloud. Connectez-vous à la console Alibaba Cloud Management Console et consultez l'ID du compte sur la page Security Settings. `AliyunIOTAccessingFCRole` est un rôle lié au service défini dans RAM. Ce rôle accorde à IoT Platform les autorisations d'accès à Function Compute. Vous pouvez gérer les rôles RAM sur la page RAM Roles de la console RAM.

Exemple


{
    "role":
    {
        "roleArn": "acs:ram::${uid}:role/aliyuniotaccessingfcrole",
        "roleName": "AliyunIOTAccessingFCRole"
    },
    "functionName": "${function_name}",
    "serviceName": "${service_name}",
    "regionName": "cn-shanghai"
}

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

Paramètres de réponse

Paramètre	Type	Exemple	Description
Code	String	iot.system.SystemException	Le code d'erreur renvoyé si l'appel échoue. Pour plus d'informations, consultez Codes d'erreur.
Destination	Struct		Les informations sur la destination de données renvoyées après la création de la destination.
Configuration	String	{"topic":"/a1POX0c****/device1/user/get","topicType":1}	Les données de configuration de la destination de données.
DestinationId	Long	1003	L'ID de la destination de données.
IsFailover	Boolean	false	Indique si la destination de données transfère les données d'opération d'erreur. Les données d'opération d'erreur correspondent aux données dont le transfert a échoué et qui sont retransférées vers d'autres services Alibaba Cloud. true : Les données d'opération d'erreur sont transférées. false : Seules les données normales sont transférées. Valeur par défaut : false.
Name	String	DataPurpose	Le nom de la destination de données.
Type	String	REPUBLISH	L'opération effectuée sur les données de la destination de données.
UtcCreated	String	2022-03-27T12:45:43.000Z	L'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.	Le message d'erreur renvoyé si la requête échoue.
RequestId	String	E4C0FF92-2A86-41DB-92D3-73B60310D25E	L'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é.

Exemples

Exemples de requêtes

http(s)://iot.cn-shanghai.aliyuncs.com/?Action=CreateDestination
&Configuration={"topic":"/a1POX0c****/device1/user/get","topicType":1}
&Name=DataPurpose
&Type=REPUBLISH
&<Common request parameters>

Exemples de réponses réussies

XML format

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

JSON format

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

Codes d'erreur

HttpCode	Code d'erreur	Message d'erreur	Description
400	iot.system.SystemException	An internal error occurred. Try again later.	Le message d'erreur renvoyé car une exception système s'est produite.
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.
400	iot.ruleng.NullRuleActionConfig	The rule action configuration is empty.	Le message d'erreur renvoyé car aucune action de règle n'est configurée.
400	iot.ruleng.NullRuleActionType	The specified rule action is invalid or the rule action type is unspecified.	Vous devez configurer le paramètre Type pour l'action de règle.

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