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

Cria vários DeviceNames personalizados em um produto. O IoT Platform verifica a validade dos DeviceNames.

Observações de uso

Use esta operação em conjunto com a operação BatchRegisterDeviceWithApplyId para registrar vários dispositivos com nomes exclusivos em um produto.

Procedimento:

Chame a operação BatchCheckDeviceNames para especificar os nomes dos dispositivos a registrar. O IoT Platform retorna o ID da solicitação, indicado pelo parâmetro ApplyId. Se a chamada for bem-sucedida, o sistema envia uma solicitação de verificação dos DeviceNames. A verificação ocorre de forma assíncrona.
Chame a operação QueryBatchRegisterDeviceStatus para consultar o resultado da definição dos nomes.
Chame a operação BatchRegisterDeviceWithApplyId para registrar os dispositivos.
Opcional. Chame a operação QueryBatchRegisterDeviceStatus para consultar o resultado do registro dos dispositivos.
Chame a operação QueryPageByApplyId para visualizar os detalhes dos dispositivos registrados simultaneamente.

Limites

Você pode especificar até 10.000 DeviceNames em uma única chamada.

Limites de QPS

Você pode chamar esta API até 10 vezes por segundo por conta.

Nota

Os usuários RAM de uma conta Alibaba Cloud compartilham a cota dessa 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	BatchCheckDeviceNames	A operação a executar. Defina o valor como BatchCheckDeviceNames.
ProductKey	String	Sim	a1BwAGV****	O ProductKey do produto ao qual o dispositivo pertence.
IotInstanceId	String	Não	iot-cn-0pp1n8t****	O ID da instância IoT. Visualize o ID da instância na página Overview no console do IoT Platform. Importante Se sua instância tiver um ID, especifique o ID neste parâmetro. Caso contrário, a chamada falhará. Se a página Overview não estiver visível ou se sua instância não tiver um ID, não é necessário especificar este parâmetro. Para mais informações, consulte o tópico Visão geral das instâncias IoT.
DeviceName.N	RepeatList	Não	light	O nome do dispositivo. O DeviceName deve ser exclusivo dentro do produto. Deve ter entre 4 e 32 caracteres e pode conter letras, dígitos, hifens (-), sublinhados (_), arrobas (@), pontos (.) e dois-pontos (:). Especifique este parâmetro ou o parâmetro DeviceNameList.N.DeviceName. Se ambos forem especificados simultaneamente, o valor de DeviceNameList.N.DeviceName terá precedência. Nota Você pode especificar até 10.000 DeviceNames por chamada. Nomes que excederem esse limite serão descartados.
DeviceNameList.N.DeviceName	String	Não	light1	O nome do dispositivo. O DeviceName deve ser exclusivo dentro do produto. Deve ter entre 4 e 32 caracteres e pode conter letras, dígitos, hifens (-), sublinhados (_), arrobas (@), pontos (.) e dois-pontos (:). Especifique este parâmetro ou o parâmetro DeviceName.N. Se ambos forem informados ao mesmo tempo, o valor deste parâmetro prevalecerá. Nota Você pode especificar até 10.000 DeviceNames por chamada. Nomes que excederem esse limite serão descartados.
DeviceNameList.N.DeviceNickname	String	Não	Smart light 1	O apelido do dispositivo. Deve ter entre 4 e 64 caracteres e pode conter letras, dígitos e sublinhados (_). Importante Ao especificar este parâmetro, você também deve especificar o parâmetro DeviceNameList.N.DeviceName.

Além dos parâmetros específicos descritos acima, você deve incluir os parâmetros comuns de solicitação ao chamar esta operação. Para mais detalhes sobre esses parâmetros, 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 caso a chamada falhe. Para mais informações, consulte Códigos de erro.
Data	Struct		Os dados retornados quando a chamada é bem-sucedida.
ApplyId	Long	1295006	O ID da solicitação (ApplyId) retornado em caso de sucesso. Ao chamar a operação BatchRegisterDeviceWithApplyId para registrar dispositivos, você deve especificar o parâmetro ApplyId.
InvalidDetailList	Array of InvalidDetailList		Detalhes dos DeviceNames inválidos dos dispositivos que não puderam ser registrados.
InvalidDetailList
DeviceName	String	light	O DeviceName.
ErrorMsg	String	The device name is illegal.	As mensagens de erro retornadas quando o registro dos dispositivos falha. Nota Múltiplas mensagens de erro são separadas por barras verticais (\|).
NickName	String	Smart Light 1	O apelido do dispositivo.
InvalidDeviceNameList	List	{ "InvalidDeviceName": [ "APT$", "aw" ] }	Os DeviceNames inválidos que não puderam ser registrados.
InvalidDeviceNicknameList	List	{ "InvalidDeviceNickname": [ "APT$", "aw" ] }	Os apelidos de dispositivo inválidos que não puderam ser registrados.
RepeatedDeviceNameList	List	{ "RepeatedDeviceName": [ "APT$", "aw" ] }	Os DeviceNames duplicados que não puderam ser registrados.
ErrorMessage	String	A system exception occurred.	A mensagem de erro retornada se a chamada falhar.
RequestId	String	E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565	O ID da solicitação.
Success	Boolean	true	Indica se a solicitação foi bem-sucedida. Valores válidos: true false

Exemplos

Exemplos de solicitações

https://iot.cn-shanghai.aliyuncs.com/?Action=BatchCheckDeviceNames
&productKey=a1BwAGV****
&DeviceNameList.1.DeviceName=light1
&DeviceNameList.2.DeviceName=light2
&DeviceNameList.3.DeviceName=light3
&DeviceNameList.3.DeviceNickname=Smart light 3
&<Common request parameters>

Exemplos de respostas de sucesso

Formato XML

<BatchCheckDeviceNamesResponse>
  <Data>
        <ApplyId>1234567</ApplyId>
  </Data>
  <RequestId>E976E36B-6874-4FA4-8BC0-55F9BEC5E2EF</RequestId>
  <Success>true</Success>
</BatchCheckDeviceNamesResponse>

Formato JSON

{
	"Data": {
		"ApplyId": 1234567
	},
	"RequestId": "E976E36B-6874-4FA4-8BC0-55F9BEC5E2EF",
	"Success": true
}

Códigos de erro

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