CreateProductTopic - IoT Platform: Central de Documentação do Alibaba Cloud

Limites de QPS

Você pode chamar esta operação até uma vez por segundo por conta.

Nota

Os usuários RAM de uma conta Alibaba Cloud compartilham a cota da conta.

Depuração

O OpenAPI Explorer calcula automaticamente o valor da assinatura. Para sua conveniência, recomendamos chamar esta operação no OpenAPI Explorer. O OpenAPI Explorer gera dinamicamente o código de exemplo da operação para diferentes SDKs.

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Exemplo	Descrição
Action	String	Sim	CreateProductTopic	A operação a ser executada. Defina o valor como CreateProductTopic.
Operation	String	Sim	PUB	As permissões do dispositivo na categoria de tópico personalizado. Valores válidos: SUB: Inscrição. PUB: Publicação. ALL: Publicação e Inscrição.
ProductKey	String	Sim	aldDEin****	A ProductKey do produto para o qual você deseja criar a categoria de tópico personalizado.
TopicShortName	String	Sim	submit	O nome da categoria de tópico personalizado. Uma categoria de tópico consiste em vários campos. Separe os campos com barras (`/`). O nome pode conter letras, dígitos e sublinhados (_). Nenhum nível de nome da categoria de tópico pode estar vazio. Nota Se você definir Operation como SUB, poderá especificar os caracteres curinga sinal de mais (`+`) e cerquilha (`#`) no nome da categoria de tópico para permitir que os dispositivos se inscrevam em vários tópicos simultaneamente. Para obter mais informações sobre o uso de caracteres curinga, consulte Tópicos personalizados com caracteres curinga. Em produtos de gateway de nuvem, nenhum prefixo é especificado automaticamente. Defina um valor personalizado para o parâmetro. Use `${deviceName}` para especificar um DeviceName. Em produtos sem gateway de nuvem, `/${productKey}/${deviceName}/user/` é definido automaticamente como prefixo do valor de TopicShortName. Especifique apenas um nome personalizado para a categoria de tópico.
IotInstanceId	String	Não	iot_instc_pu***_c-v64********	O ID da instância. Visualize o ID da instância na aba Overview do console do IoT Platform. Importante Se a instância tiver um ID, especifique-o neste parâmetro. Caso contrário, a chamada falhará. Se a instância não tiver um ID, não configure este parâmetro. Para obter mais informações sobre instâncias, consulte Visão geral.
Desc	String	Não	submit a test topic	A descrição da categoria de tópico personalizado. A descrição pode ter até 100 caracteres.
EnableProxySubscribe	Boolean	Não	false	Se Operation for definido como SUB ou ALL, ative o recurso de inscrição delegada. Valores válidos: true: ativa o recurso de inscrição delegada. false: desativa o recurso de inscrição delegada. Ao ativar a inscrição delegada para um tópico, o IoT Platform obtém os detalhes do tópico e ajuda o dispositivo a se inscrever quando você o conecta à plataforma.
Codec	String	Não	compress	Especifica se o recurso de compactação ou descompactação de dados deve ser ativado para um tópico personalizado. Este parâmetro está disponível apenas em instâncias das edições Standard ou Exclusive Enterprise. Valores válidos: compress: ativa a compactação de dados. decompress: ativa a descompactação de dados. Para obter mais informações, consulte Compactação de dados. Importante Não configure Codec se especificar um valor contendo caracteres curinga, incluindo o sinal de mais (`+`) e a cerquilha (`#`), para TopicShortName. A chamada falhará se o recurso de compactação ou descompactação estiver ativado durante a criação de uma categoria de tópico com caracteres curinga.

Além dos parâmetros de solicitação específicos da operação anteriores, configure os parâmetros de solicitação comuns ao chamar esta operação. Para obter mais informações sobre parâmetros de solicitação comuns, consulte Parâmetros comuns.

Parâmetros de resposta

Parâmetro	Tipo	Exemplo	Descrição
Code	String	iot.system.SystemException	O código de erro retornado se a chamada falhar. Para obter mais informações, consulte Códigos de erro.
ErrorMessage	String	A system exception occurred.	A mensagem de erro retornada se a chamada falhar.
RequestId	String	FCC27691-9151-4B93-9622-9C90F30542EC	O ID da solicitação.
Success	Boolean	true	Indica se a chamada foi bem-sucedida. Valores válidos: true: A chamada foi bem-sucedida. false: A chamada falhou.
TopicId	Long	10000	O ID da categoria de tópico personalizado. O IoT Platform emite esse ID se a chamada for bem-sucedida. Nota Mantenha o ID da categoria de tópico personalizado em sigilo. Esse ID é necessário ao chamar operações específicas relacionadas à categoria de tópico personalizado.

Exemplos

Exemplos de solicitações

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

Exemplos de respostas de sucesso

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 erro

Para obter uma lista de códigos de erro, consulte Códigos de erro do serviço.