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

Modifique una categoría de tema personalizado.

Límites de QPS

Puede llamar a esta operación de API hasta 50 veces por segundo y por cuenta.

Nota

Los usuarios de 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 su comodidad, le recomendamos que llame a esta operación en OpenAPI Explorer. OpenAPI Explorer genera dinámicamente el código de ejemplo de la operación para diferentes SDK.

Parámetros de solicitud

Parámetro	Tipo	Obligatorio	Ejemplo	Descripción
Action	String	Sí	UpdateProductTopic	La operación que desea ejecutar. Establezca el valor en UpdateProductTopic.
Operation	String	Sí	PUB	Los permisos del dispositivo sobre la categoría de tema. Valores válidos: SUB: Suscribir. PUB: Publicar. ALL: Publicar y suscribir.
TopicId	String	Sí	821****	El ID de la categoría de tema que desea modificar. Si crea una categoría de tema personalizado después de llamar a la operación CreateProductTopic, se devuelve el ID de la categoría de tema indicado por TopicId.
TopicShortName	String	Sí	resubmit	El nombre del nivel de categoría personalizada. De forma predeterminada, una categoría de tema incluye los siguientes niveles: _productkey_ y _devicename_. Separe los dos niveles con barras diagonales (/). Formato de una categoría de tema: `productKey/deviceName/topicShortName`. Nota Cada nivel puede contener letras, dígitos y guiones bajos (_), y no puede estar vacío.
IotInstanceId	String	Opcional	iot_instc_pu***_c-v64********	El ID de la instancia. Puede obtener el ID de la instancia en la pestaña Overview de la consola de IoT Platform. Importante Si su instancia tiene un ID, debe especificarlo en este parámetro. De lo contrario, la llamada fallará. Si su instancia no tiene un ID, no es necesario configurar este parámetro. Para obtener más información sobre las instancias, consulte Overview.
Desc	String	No	resubmit a test topic	La descripción de la categoría de tema. Debe tener entre 1 y 100 caracteres.
EnableProxySubscribe	Boolean	No	false	Si establece Operation en SUB o ALL, puede habilitar la función de suscripción delegada. Valores válidos: true: Habilita la función de suscripción delegada. false: Deshabilita la función de suscripción delegada. Si habilita la función de suscripción delegada para un tema, IoT Platform obtiene los detalles del tema y ayuda al dispositivo a suscribirse cuando lo conecta a IoT Platform.
Codec	String	No	compress	Especifica si se debe habilitar la compresión o descompresión de datos para un tema personalizado. Este parámetro solo está disponible si utiliza una instancia Standard o Exclusive Enterprise Edition. Valores válidos: compress: Habilita la compresión de datos. decompress: Habilita la descompresión de datos. Para obtener más información, consulte Data compression. Importante Si especifica un valor que incluye caracteres comodín (`+` y `#`) para TopicShortName, no puede configurar Codec. Si la compresión o descompresión de datos está habilitada al crear una categoría de tema con caracteres comodín, la solicitud fallará.

Además de los parámetros específicos de la operación anteriores, debe especificar los parámetros de solicitud comunes al llamar a esta operación. Para obtener más información sobre los parámetros de solicitud comunes, consulte Common parameters.

Parámetros de respuesta

Parámetro	Tipo	Ejemplo	Descripción
Code	String	iot.system.SystemException	El código de error devuelto si la llamada falla. Para obtener más información, consulte Error codes.
ErrorMessage	String	A system exception occurred.	El mensaje de error devuelto si la llamada falla.
RequestId	String	FCC27691-9151-4B93-9622-9C90F30542EC	El ID de la solicitud.
Success	Boolean	true	Indica si la llamada fue exitosa. Valores válidos: true: La llamada fue exitosa. false: La llamada falló.

Ejemplos

Solicitudes de ejemplo

https://iot.cn-shanghai.aliyuncs.com/?Action=UpdateProductTopic
&TopicId=821****
&TopicShortName=resubmit
&Operation=PUB
&Desc=resubmit a test topic
&<Common request parameters>

Respuestas exitosas de ejemplo

Formato XML

<UpdateProductTopicResponse>
      <RequestId>FCC27691-9151-4B93-9622-9C90F30542EC</RequestId>
      <Success>true</Success>
</UpdateProductTopicResponse>

Formato JSON

{
    "RequestId":"FCC27691-9151-4B93-9622-9C90F30542EC",
    "Success":true
}

Códigos de error

Para obtener una lista de códigos de error, consulte Códigos de error del servicio.