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

Modifica uma assinatura do lado do servidor do Message Service (MNS) ou AMQP.

Limites

Cada conta Alibaba Cloud pode executar no máximo 5 consultas por segundo (QPS).

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. Recomendamos chamar esta operação no OpenAPI Explorer para maior conveniência. A ferramenta também gera dinamicamente códigos de exemplo da operação para diferentes SDKs.

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Exemplo	Descrição
Action	String	Sim	UpdateSubscribeRelation	A operação a ser executada. Defina o valor como UpdateSubscribeRelation.
ProductKey	String	Sim	a1fyXVF****	O ProductKey do produto especificado na assinatura.
Type	String	Sim	AMQP	O tipo da assinatura. Valores válidos: MNS AMQP
IotInstanceId	String	Não	iot-cn-0pp1n8t****	O ID da instância. Visualize o ID da instância na página Overview do console IoT Platform. Importante Se a instância possuir um ID, configure este parâmetro. Caso contrário, a chamada falhará. Se a instância não tiver uma página Overview ou ID, não é necessário definir este parâmetro. Para mais informações, consulte Visão geral.
DeviceDataFlag	Boolean	Não	true	Define se mensagens upstream do dispositivo devem ser enviadas. Valores válidos: true: sim. false: não. Valor padrão: false.
DeviceStatusChangeFlag	Boolean	Não	true	Indica se mensagens sobre alterações de status do dispositivo devem ser enviadas. Valores válidos: true: sim. false: não. Valor padrão: false.
FoundDeviceListFlag	Boolean	Não	true	Especifica se notificações devem ser enviadas quando um gateway detectar novos subdispositivos. Valores válidos: true: sim. Válido apenas para produtos de gateway. false: não. Valor padrão: false.
DeviceTopoLifeCycleFlag	Boolean	Não	true	Determina o envio de mensagens sobre alterações nas relações topológicas dos dispositivos. Valores válidos: true: sim. Aplica-se somente a produtos de gateway. false: não. Valor padrão: false.
DeviceLifeCycleFlag	Boolean	Não	true	Controla o envio de mensagens referentes a mudanças no ciclo de vida do dispositivo. Valores válidos: true: sim. false: não. Valor padrão: false.
ThingHistoryFlag	Boolean	Não	true	Define se dados históricos upstream da Thing Specification Language (TSL) serão enviados. Valores válidos: true: sim. false: não. Valor padrão: false.
OtaEventFlag	Boolean	Não	true	Habilita o envio de notificações sobre o status de lotes de atualização OTA. Valores válidos: true: sim. false: não. Valor padrão: false.
DeviceTagFlag	Boolean	Não	true	Especifica se mensagens sobre alterações de tags do dispositivo devem ser enviadas. Valores válidos: true: sim. Este parâmetro só tem efeito se o parâmetro Type estiver definido como AMQP. false: não. Valor padrão: false.
OtaVersionFlag	Boolean	Não	true	Indica se mensagens sobre números de versão de módulos OTA serão enviadas. Valores válidos: true: sim. Válido apenas quando o parâmetro Type for AMQP. false: não. Valor padrão: false.
OtaJobFlag	Boolean	Não	true	Define o envio de notificações sobre os status de tarefas de atualização OTA. Valores válidos: true: sim. Requer que o parâmetro Type esteja configurado como AMQP. false: não. Valor padrão: false.
MnsConfiguration	String	Não	{ "queueName": "mns-test-topic1", "regionName": "cn-shanghai", "role": { "roleArn": "acs:ram::5645***:role/aliyuniotaccessingmnsrole", "roleName": "AliyunIOTAccessingMNSRole" } }	As configurações da fila MNS. Obrigatório se o parâmetro Type estiver definido como AMQP. Para mais detalhes, consulte a seção "Definição do parâmetro MnsConfiguration".
ConsumerGroupIds.N	RepeatList	Não	nJRaJPn5U1JITGfjBO9l00****	Os IDs dos grupos de consumidores criados na assinatura AMQP. Necessário quando o parâmetro Type for AMQP. Após chamar a operação CreateConsumerGroup para criar um grupo de consumidores, o sistema retorna o ID do grupo. Chame a operação QueryConsumerGroupList para consultar o ID do grupo pelo nome. Alternativamente, acesse o console IoT Platform,e escolha Rules > Server-side Subscription > Consumer Groups para visualizar o ID do grupo de consumidores.

Nota

É obrigatório definir pelo menos um parâmetro relacionado a Flag como

true

Definição do parâmetro MnsConfiguration

Parâmetro	Descrição
queueName	O nome da fila MNS usada para receber dados. Crie uma fila no console MNS e obtenha o nome da fila. Para mais informações, consulte Criar uma fila.
regionName	O código da região onde o MNS está implantado. Exemplo: cn-shanghai.
role	As informações sobre a função RAM. Para conceder ao IoT Platform acesso ao MNS, atribua uma função RAM ao serviço. O script abaixo mostra a sintaxe de uma função RAM: `{"roleArn":"acs:ram::5645*:role/aliyuniotaccessingmnsrole","roleName": "AliyunIOTAccessingMNSRole"}` Substitua `6541*` pelo seu ID da Alibaba Cloud. Faça login no Console de Gerenciamento da Alibaba Cloud e visualize o ID da conta na página Security Settings. `AliyunIOTAccessingMNSRole` é uma função de serviço especificada no console RAM. Essa função concede ao IoT Platform acesso ao MNS. Acesse a página RAM Roles no console RAM para gerenciar as funções RAM.

Exemplo do parâmetro MnsConfiguration


{
    "queueName": "mns-test-topic1",
    "regionName": "cn-shanghai",
    "role": {
        "roleArn": "acs:ram::5645***:role/aliyuniotaccessingmnsrole",
        "roleName": "AliyunIOTAccessingMNSRole"
    }
}

Além dos parâmetros específicos mencionados acima, especifique os parâmetros de solicitação comuns ao chamar esta operação. Para mais informações, consulte Parâmetros de solicitação 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 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	21D327AF-A7DE-4E59-B5D1-ACAC8C024555	O ID da solicitação.
Success	Boolean	true	Indica se a chamada foi bem-sucedida. true: A chamada foi bem-sucedida. false: A chamada falhou.

Exemplos

Exemplos de solicitações

https://iot.cn-shanghai.aliyuncs.com/?Action=UpdateSubscribeRelation
&OtaEventFlag=true
&ProductKey=a1Zkii7****
&Type=AMQP
&ConsumerGroupIds.1=Xs95KifeaSKbi8tKkcoD00****
&<Common request parameters>

Exemplos de respostas de sucesso

Formato XML

<UpdateSubscribeRelationResponse>
        <RequestId>C21DA94F-07D7-482F-8A0C-5BB0E3CC1A82</RequestId>
        <Success>true</Success>
</UpdateSubscribeRelationResponse>

Formato JSON

{
    "RequestId": "C21DA94F-07D7-482F-8A0C-5BB0E3CC1A82",
    "Success": true
}

Códigos de erro

Para obter uma lista de códigos de erro, visite o Centro de Erros de API.