CreateDestination - IoT Platform - Centro de documentación de Alibaba Cloud

Crea un destino de datos para el reenvío de datos.

Límites de QPS

Cada cuenta de Alibaba Cloud puede invocar esta operación hasta 10 veces por segundo (QPS).

Nota

Los usuarios de RAM de una cuenta de Alibaba Cloud comparten la cuota de la cuenta.

Depuración

OpenAPI Explorer calcula automáticamente el valor de la firma. Para su comodidad, se recomienda invocar esta operación en OpenAPI Explorer. OpenAPI Explorer genera dinámicamente el código de ejemplo de la operación para distintos SDK.

Parámetros de solicitud

Parámetro	Tipo	Obligatorio	Ejemplo	Descripción
Action	String	Sí	CreateDestination	Operación que desea realizar. Establezca el valor en CreateDestination.
Name	String	Sí	DataPurpose	Nombre del destino de datos.
Type	String	Sí	REPUBLISH	Tipo de operación que se realizará en los datos. Valores válidos: REPUBLISH: reenvía los datos del tema procesados por un script de análisis sintáctico a un tema de comunicación de IoT Platform. AMQP: envía los datos del tema procesados por un script de análisis sintáctico a un grupo de consumidores de Advanced Message Queuing Protocol (AMQP). DATAHUB: dirige los datos del tema procesados por un script de análisis sintáctico a DataHub para el procesamiento de flujos. ONS: remite los datos del tema procesados por un script de análisis sintáctico a Message Queue for Apache RocketMQ para la distribución de mensajes. MNS: reenvía los datos del tema procesados por un script de análisis sintáctico a Message Service (MNS) para la transmisión de mensajes. FC: envía los datos del tema procesados por un script de análisis sintáctico a Function Compute para el procesamiento de eventos. OTS: entrega los datos del tema procesados por un script de análisis sintáctico a Tablestore (OTS) para el almacenamiento de datos NoSQL.
Configuration	String	Sí	{"topic":"/a1POX0c****/device1/user/get","topicType":1}	Configuración del destino de datos en formato JSON. La configuración varía según el tipo de destino. Para consultar la sintaxis obligatoria y los ejemplos, consulte las tablas que se muestran a continuación.
IotInstanceId	String	No	iot-2w****	ID de instancia. Consulte el ID en la página Overview de la consola de IoT Platform. Importante Si su instancia tiene un ID, especifíquelo para este parámetro. De lo contrario, la invocación falla. Si no se genera una página Overview ni un ID para su instancia, no es necesario especificar este parámetro. Para obtener más información, consulte Descripción general.
Description	String	No	Los datos que desea reenviar a una base de datos.	Descripción del destino de datos.

Configuraciones del tipo REPUBLISH

Parámetro

Descripción

productKey

ProductKey del producto al que pertenece el tema de destino.

Ejemplos

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

Configuraciones del tipo AMQP

Parámetro

Descripción

groupId

ID del grupo de consumidores.

Ejemplo

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

Configuraciones del tipo OTS

Parámetro	Descripción
instanceName	Nombre de la instancia de Tablestore que recibirá datos.
regionName	Código de la región donde está desplegado Tablestore. Ejemplo: cn-shanghai.
tableName	Nombre de la tabla que recibirá datos.
role	Información del rol de RAM. Para conceder acceso de IoT Platform a Tablestore, asigne un rol de servicio. La sintaxis de un rol de RAM: `{"roleName":"AliyunIOTAccessingOTSRole","roleArn":"acs:ram::${uid}:role/aliyuniotaccessingotsrole"}` `${uid}` especifica el ID de su cuenta de Alibaba Cloud. Inicie sesión en Alibaba Cloud Management Console y consulte el ID de cuenta en la página Security Settings. `AliyunIOTAccessingOTSRole` es un rol vinculado a un servicio definido en RAM. Este rol concede a IoT Platform permisos de acceso a Tablestore. Gestione los roles de RAM en la página RAM Roles de la consola de RAM.

Ejemplo

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

Configuraciones del tipo DATAHUB

Parámetro	Descripción
projectName	Nombre del proyecto de DataHub que recibirá datos.
topicName	Nombre del tema de DataHub que recibirá datos.
regionName	Código de la región donde está desplegado DataHub. Ejemplo: cn-shanghai.
role	Datos del rol de RAM. Si necesita conceder acceso de IoT Platform a DataHub, asigne un rol de servicio. Sintaxis del rol de RAM: `{"roleArn":"acs:ram::${uid}:role/aliyuniotaccessingdatahubrole","roleName": "AliyunIOTAccessingDataHubRole"}` `${uid}` corresponde al ID de su cuenta de Alibaba Cloud. Para consultar el ID de cuenta, inicie sesión en Alibaba Cloud Management Console y abra la página Security Settings. `AliyunIOTAccessingDataHubRole` es un rol vinculado a un servicio definido en RAM. Este rol otorga a IoT Platform permisos de acceso a DataHub. Los roles de RAM se gestionan en la página RAM Roles de la consola de RAM.

Ejemplo

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

Configuraciones del tipo MNS

Parámetro	Descripción
themeName	Nombre del tema de MNS que recibirá datos.
regionName	Código de la región donde está desplegado MNS. Ejemplo: cn-shanghai.
role	Información del rol de RAM. Para autorizar el acceso de IoT Platform a MNS, asigne un rol de servicio a IoT Platform. La sintaxis de un rol de RAM: `{"roleArn":"acs:ram::${uid}:role/aliyuniotaccessingmnsrole","roleName": "AliyunIOTAccessingMNSRole"}` `${uid}` indica el ID de su cuenta de Alibaba Cloud. Inicie sesión en Alibaba Cloud Management Console y consulte el ID de cuenta en la página Security Settings. `AliyunIOTAccessingMNSRole` es un rol vinculado a un servicio definido en RAM. Este rol concede a IoT Platform permisos de acceso a MNS. Para gestionar los roles de RAM, utilice la página RAM Roles de la consola de RAM.

Ejemplo

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

Configuraciones del tipo ONS

Nota

Para conceder permisos a IoT Platform sobre Message Queue for Apache RocketMQ, invoque el SDK o inicie sesión en la consola de Message Queue for Apache RocketMQ. Debe autorizar a IoT Platform para publicar mensajes en Message Queue for Apache RocketMQ antes de crear una acción de regla para reenviar datos al servicio.

Parámetro	Descripción
instanceId	ID de la instancia de Message Queue for Apache RocketMQ que recibirá datos.
topic	Nombre del tema de Message Queue for Apache RocketMQ que recibirá datos.
regionName	Código de la región donde está desplegado Message Queue for Apache RocketMQ. Ejemplo: cn-shanghai. Solo puede reenviar datos dentro de la misma región.
role	Información del rol de RAM. Puede conceder acceso de IoT Platform a Message Queue for Apache RocketMQ mediante la asignación de un rol de servicio. La sintaxis de un rol de RAM: `{"roleArn":"acs:ram::${uid}:role/aliyuniotaccessingmqrole","roleName": "AliyunIOTAccessingMQRole"}` `${uid}` representa el ID de su cuenta de Alibaba Cloud. Para ver el ID de cuenta, inicie sesión en Alibaba Cloud Management Console y acceda a la página Security Settings. `AliyunIOTAccessingFCRole` es un rol vinculado a un servicio definido en la consola de RAM. Este rol concede a IoT Platform permisos de acceso a Message Queue for Apache RocketMQ. La página RAM Roles de la consola de RAM permite gestionar los roles de RAM.

Ejemplo

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

Configuraciones del tipo FC

Parámetro	Descripción
functionName	Nombre de la función que recibirá datos.
serviceName	Nombre del servicio que recibirá datos.
regionName	ID de la región donde está desplegado Function Compute. Ejemplo: cn-shanghai.
role	Datos del rol de RAM. Para otorgar acceso de IoT Platform a Function Compute, asigne un rol de servicio. Sintaxis del rol de RAM: `{"roleArn":"acs:ram::${uid}:role/aliyuniotaccessingfcrole","roleName": "AliyunIOTAccessingFCRole"}` `${uid}` especifica el ID de su cuenta de Alibaba Cloud. Consulte el ID de cuenta en la página Security Settings después de iniciar sesión en Alibaba Cloud Management Console. `AliyunIOTAccessingFCRole` es un rol vinculado a un servicio definido en RAM. Este rol concede a IoT Platform permisos de acceso a Function Compute. Gestione los roles de RAM en la página RAM Roles de la consola de RAM.

Ejemplo

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

Además de los parámetros específicos de la operación anteriores, especifique los parámetros de solicitud comunes cuando invoque esta operación. Para obtener más información, consulte Parámetros comunes de solicitud.

Parámetros de respuesta

Parámetro	Tipo	Ejemplo	Descripción
Code	String	iot.system.SystemException	Código de error devuelto si la invocación falla. Para obtener más información, consulte Códigos de error.
Destination	Struct		Información del destino de datos devuelta después de crear el destino.
Configuration	String	{"topic":"/a1POX0c****/device1/user/get","topicType":1}	Datos de configuración del destino de datos.
DestinationId	Long	1003	ID del destino de datos.
IsFailover	Boolean	false	Indica si el destino de datos reenvía datos de operaciones con errores. Los datos de operaciones con errores son datos con errores de reenvío que se reenvían nuevamente a otros servicios de Alibaba Cloud. true: Se reenvían los datos de operaciones con errores. false: Solo se reenvían datos normales. Valor predeterminado: false.
Name	String	DataPurpose	Nombre del destino de datos.
Type	String	REPUBLISH	Operación realizada sobre los datos del destino de datos.
UtcCreated	String	2022-03-27T12:45:43.000Z	Hora a la que se creó el destino de datos, en UTC. Formato: `yyyy-MM-dd'T'HH:mm:ss.SSS'Z'`.
ErrorMessage	String	A system exception occurred.	Mensaje de error devuelto si la solicitud falla.
RequestId	String	E4C0FF92-2A86-41DB-92D3-73B60310D25E	ID de solicitud.
Success	Boolean	true	Indica si la invocación se realizó correctamente. true: La invocación se realizó correctamente. false: La invocación falló.

Ejemplos

Solicitudes de ejemplo

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

Respuestas exitosas de ejemplo

XML formato

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

{
    "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
}

Códigos de error

Código HTTP	Código de error	Mensaje de error	Descripción
400	iot.system.SystemException	Se produjo un error interno. Inténtelo de nuevo más tarde.	El mensaje de error devuelto porque se produjo una excepción del sistema.
400	iot.system.IllegalRequest	El parámetro de solicitud no es válido.	Mensaje de error devuelto porque el parámetro de solicitud no es válido.
400	iot.ruleng.NullRuleActionConfig	La configuración de la acción de regla está vacía.	Este mensaje de error se devuelve cuando no hay acciones de regla configuradas.
400	iot.ruleng.NullRuleActionType	La acción de regla especificada no es válida o no se especificó el tipo de acción de regla.	Configure el parámetro Type para la acción de regla.

Para ver una lista de códigos de error, visite el Centro de errores de API.