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

Consulta la lista de destinos de datos que ha creado.

Límites de QPS

Cada cuenta de Alibaba Cloud puede ejecutar hasta 10 consultas por segundo (QPS).

Nota

Los usuarios de Resource Access Management (RAM) de una cuenta de Alibaba Cloud comparten la cuota de dicha cuenta.

Depuración

OpenAPI Explorer calcula automáticamente el valor de la firma. Para mayor comodidad, se recomienda invocar esta operación en OpenAPI Explorer. Esta herramienta 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í	ListDestination	La operación que desea ejecutar. Establezca el valor en ListDestination.
Page	Integer	Sí	1	El número de página que se devuelve. Valores válidos: de 1 a 100.
PageSize	Integer	Sí	10	El número de entradas por página. Valor máximo: 100.
IotInstanceId	String	No	iot-2w****	El ID de la instancia. Consulte el ID de la instancia en la página Overview de la consola de IoT Platform. Importante Si su instancia tiene un ID, especifique este parámetro. De lo contrario, la llamada falla. Si la página Overview o el ID de la instancia no se muestran en la consola de IoT Platform, no es necesario especificar este parámetro. Para obtener más información, consulte Descripción general.
SearchName	String	No	DataPurpose	Una cadena de búsqueda para filtrar los destinos de datos por nombre. Especifique palabras clave que coincidan con los nombres de los destinos de datos.
Types.N	RepeatList	No	["REPUBLISH", "OTS"]	Los tipos de acciones de reenvío de datos. Un script de analizador procesa los datos antes de reenviarlos. Valores válidos: REPUBLISH: reenvía los datos a un tema de comunicación de IoT Platform. AMQP: reenvía los datos a un grupo de consumidores de Advanced Message Queuing Protocol (AMQP). DATAHUB: reenvía los datos a DataHub para el procesamiento de flujos. ONS: reenvía los datos a Message Queue for Apache RocketMQ. MNS: reenvía los datos a Message Service (MNS). FC: reenvía los datos a Function Compute para el procesamiento de eventos. OTS: reenvía los datos a Tablestore para el almacenamiento de datos NoSQL.

Además de los parámetros de solicitud específicos de la operación, debe especificar los parámetros de solicitud comunes al invocar esta operación. Para obtener más información, consulte Parámetros comunes.

Parámetros de respuesta

Parámetro	Tipo	Ejemplo	Descripción
Code	String	iot.system.SystemException	El código de error que se devuelve si la llamada falla. Para obtener más información, consulte Códigos de error.
Destinations	Array of destinations		Los destinos de datos.
destinations
Configuration	String	{"topic":"/a1POX0c****/device1/user/get","topicType":1}	La configuración del destino de datos.
Description	String	The data is forwarded to a database.	La descripción del destino de datos.
DestinationId	Long	1003	El ID del destino de datos.
IsFailover	Boolean	false	Indica si el destino de datos recibe datos de operaciones con errores. Los datos de operaciones con errores son aquellos cuyo reenvío falló después de dos intentos consecutivos. true: el destino de datos recibe datos de operaciones con errores. false: el destino de datos recibe datos normales, no datos de operaciones con errores. Valor predeterminado: false
Name	String	DataPurpose	El nombre del destino de datos.
Status	String	NORMAL	El estado del destino de datos. Valores válidos: INIT: la configuración está en curso. NORMAL: la configuración se completó y el destino de datos está disponible. INVALID: la configuración no es válida y el destino de datos no está disponible. SHORTCUT: ocurrió una excepción y se detuvo el reenvío de datos.
Type	String	REPUBLISH	La acción de reenvío de datos del destino de datos.
UtcCreated	String	2022-03-27T12:45:43.000Z	La hora en que se creó el destino de datos, en formato UTC. Formato: `yyyy-MM-dd'T'HH:mm:ss.SSS'Z'`.
ErrorMessage	String	A system exception occurred.	El mensaje de error que se devuelve si la llamada falla.
Page	Integer	1	El número de la página devuelta.
PageSize	Integer	10	El número de entradas devueltas por página.
RequestId	String	E4C0FF92-2A86-41DB-92D3-73B60310D25E	El ID de la solicitud.
Success	Boolean	true	Indica si la llamada fue exitosa. true: la llamada fue exitosa. false: la llamada falló.
Total	Integer	100	El número total de destinos de datos devueltos.

Ejemplos

Solicitudes de ejemplo

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

Respuestas exitosas de ejemplo

Formato XML

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

Formato JSON

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

Códigos de error

HttpCode	Código de error	Mensaje de error	Descripción
400	iot.system.SystemException	An internal error occurred. Try again later.	El mensaje de error que se devuelve porque ocurrió una excepción del sistema.
400	iot.system.IllegalRequest	The request parameter is invalid.	El mensaje de error que se devuelve porque el parámetro de solicitud no es válido.

Para consultar la lista de códigos de error, visite el centro de errores de API.