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

Cree una categoría de tema personalizado para un producto.

Límites de QPS

Puede llamar a esta operación hasta una vez por segundo 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í	CreateProductTopic	La operación que desea ejecutar. Establezca el valor en CreateProductTopic.
Operation	String	Sí	PUB	Los permisos del dispositivo sobre la categoría de tema personalizado. Valores válidos: SUB: Suscripción. PUB: Publicación. ALL: Publicación y suscripción.
ProductKey	String	Sí	aldDEin****	La clave ProductKey del producto para el cual desea crear la categoría de tema personalizado.
TopicShortName	String	Sí	submit	El nombre de la categoría de tema personalizado. Una categoría de tema consta de varios campos. Separe los campos con barras diagonales (`/`). El nombre puede contener letras, dígitos y guiones bajos (_). Ningún nivel de nombre de la categoría de tema puede estar vacío. Nota Si establece Operation en SUB, puede especificar los caracteres comodín signo más (`+`) y almohadilla (`#`) en el nombre de una categoría de tema para permitir que los dispositivos se suscriban a varios temas simultáneamente. Para obtener más información sobre el uso de caracteres comodín, consulte Custom topics with wildcard characters. Si usa un producto de puerta de enlace en la nube, no se especifica ningún prefijo automáticamente. Debe especificar un valor personalizado para el parámetro. Puede usar `${deviceName}` para especificar un DeviceName. Si usa un producto que no es de puerta de enlace en la nube, `/${productKey}/${deviceName}/user/` se especifica automáticamente como prefijo del valor de TopicShortName. Solo necesita especificar un nombre personalizado para la categoría de tema.
IotInstanceId	String	No	iot_instc_pu***_c-v64********	El ID de la instancia. Puede consultar 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	submit a test topic	La descripción de la categoría de tema personalizado. La longitud máxima permitida es de 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 facilita la suscripción del dispositivo al conectarlo a IoT Platform.
Codec	String	No	compress	Especifica si se debe habilitar la función de compresión o descompresión de datos para un tema personalizado. Este parámetro solo está disponible si usa 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 contiene caracteres comodín, como el signo más (`+`) y la almohadilla (`#`), para TopicShortName, no puede configurar Codec. Si la función de compresión o descompresión de datos está habilitada cuando usa caracteres comodín para crear una categoría de tema, la llamada fallará.

Además de los parámetros de solicitud específicos de la operación anteriores, debe configurar 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 se realizó correctamente. Valores válidos: true: La llamada se realizó correctamente. false: La llamada falló.
TopicId	Long	10000	El ID de la categoría de tema personalizado. IoT Platform genera este ID si la llamada se realiza correctamente. Nota Mantenga la confidencialidad del ID de la categoría de tema personalizado. Este ID es obligatorio al llamar a operaciones específicas relacionadas con dicha categoría.

Ejemplos

Solicitudes de ejemplo

https://iot.cn-shanghai.aliyuncs.com/?Action=CreateProductTopic
&ProductKey=aldDEin****
&TopicShortName=submit
&Operation=PUB
&Desc=submit a test topic
&<Common request parameters>

Respuestas correctas de ejemplo

Formato XML

<CreateProductTopicResponse>
      <RequestId>FCC27691-9151-4B93-9622-9C90F30542EC</RequestId>
      <Success>true</Success>
      <TopicId>10000</TopicId>
</CreateProductTopicResponse>

Formato JSON

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

Códigos de error

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