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

Obtiene información detallada de un destino de datos específico.

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 comparten la cuota de la cuenta de Alibaba Cloud.

Depuración

OpenAPI Explorer calcula automáticamente el valor de la firma. Para su comodidad, se recomienda invocar esta operación en OpenAPI Explorer. Esta herramienta genera dinámicamente 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í	GetDestination	La operación que desea ejecutar. Establezca el valor en `GetDestination`.
DestinationId	Long	Sí	1004	ID del destino de datos. Invoque la operación ListDestination para obtener este ID.
IotInstanceId	String	No	iot-2w****	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, debe especificar este parámetro; de lo contrario, la invocación fallará. Si no se generó una página Overview o un ID para su instancia, no es necesario especificar este parámetro. Para más información, consulte Descripción general.

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

Parámetros de respuesta

Parámetro	Tipo	Ejemplo	Descripción
Code	String	iot.system.SystemException	Código de error. Para más información, consulte Códigos de error.
Destination	Struct		Detalles del destino de datos.
Configuration	String	{"topic":"/a1POX0c****/device1/user/get","topicType":1}	Configuración del destino de datos.
DestinationId	String	1003	ID del destino de datos.
IsFailover	Boolean	false	Indica si el destino de datos se usa para failover. Un destino de failover recibe los datos cuyo reenvío al destino original falló tras agotar los reintentos. true: El destino es un destino de failover. false: El destino reenvía datos normales. Valor predeterminado: false.
Name	String	DataPurpose	Nombre del destino de datos.
Status	String	NORMAL	Estado del destino de datos. Valores válidos: INIT: El destino de datos se está inicializando. NORMAL: La configuración se completó y el destino de datos está disponible. INVALID: La configuración presenta anomalías y el destino de datos no está disponible. SHORTCUT: La operación de reenvío de datos se interrumpió porque el servicio de reenvío presenta anomalías.
Type	String	REPUBLISH	Tipo del destino de datos. Valores válidos: REPUBLISH: Reenvía datos analizados a un tema de comunicación de IoT Platform. AMQP: Reenvía datos analizados a un grupo de consumidores AMQP. DATAHUB: Reenvía datos analizados a DataHub para cómputo de flujos. ONS: Reenvía datos analizados a Message Queue for Apache RocketMQ. MNS: Reenvía datos analizados a Message Service (MNS). FC: Reenvía datos analizados a Function Compute para cómputo basado en eventos. OTS: Reenvía datos analizados a Tablestore para almacenamiento de datos NoSQL.
UtcCreated	String	2022-03-27T12:45:43.000Z	Hora de creación del destino de datos en formato UTC. Formato: `yyyy-MM-dd'T'HH:mm:ss.SSS'Z'`.
ErrorMessage	String	A system exception occurred.	Mensaje de error.
RequestId	String	E4C0FF92-2A86-41DB-92D3-73B60310D25E	ID de la solicitud.
Success	Boolean	true	Indica si la invocación fue exitosa. Valores válidos: true: La invocación fue exitosa. false: La invocación falló.

Ejemplos

Solicitudes de ejemplo

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

Respuestas exitosas de ejemplo

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

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

Códigos de error

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

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