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

Agrega uno o más dispositivos a un grupo.

Límites

Cada cuenta de Alibaba Cloud admite un máximo de 500 consultas por segundo (QPS).

Nota

Los usuarios de RAM de una cuenta de Alibaba Cloud comparten la cuota de dicha cuenta.

Depuración

Alibaba Cloud proporciona OpenAPI Explorer para simplificar el uso de la API. OpenAPI Explorer calcula automáticamente el valor de la firma. Para su comodidad, se recomienda llamar a esta operación desde OpenAPI Explorer. Esta herramienta 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í	BatchAddDeviceGroupRelations	La operación que desea ejecutar. Establezca el valor en BatchAddDeviceGroupRelations.
Device.N.DeviceName	String	Sí	ZHuPo6sZzv7pOzYh****	Los nombres de los dispositivos por agregar. Especifique un máximo de 200 dispositivos.
Device.N.ProductKey	String	Sí	a1kORrK****	Las claves de producto (ProductKey) de los productos a los que pertenecen los dispositivos. Especifique un máximo de 200 ProductKeys.
GroupId	String	Sí	6VfhebLg5iUe****	El identificador único global (GUID) del grupo.
IotInstanceId	String	No	iot_instc_pu***_c-v64********	El ID de la instancia. Consulte el ID de la instancia en la página de Overview de la consola de IoT Platform. Importante Si su instancia tiene un ID, debe especificar este parámetro. De lo contrario, la llamada fallará. Si su instancia no tiene página de Overview ni ID, no es necesario establecer este parámetro. Para obtener más información, consulte Descripción general.

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

Parámetros de respuesta

Parámetro	Tipo	Ejemplo	Descripción
AlreadyRelatedGroupDeviceCount	Integer	0	El número de dispositivos que ya existen en el grupo.
Code	String	iot.system.SystemException	El código de error devuelto si la llamada falla. Para obtener más información, consulte Códigos de error.
ErrorMessage	String	A system exception occurred.	El mensaje de error devuelto si la llamada falla.
ExceedTenGroupDeviceCount	Integer	0	El número de dispositivos que ya pertenecen a 10 o más grupos. Un dispositivo puede pertenecer a un máximo de 10 grupos.
RequestId	String	671D0F8F-FDC7-4B12-93FA-336C079C965A	El ID de la solicitud.
Success	Boolean	true	Indica si la llamada se realizó correctamente. true: La llamada se realizó correctamente. false: La llamada falló.
SuccessAddedDeviceCount	Integer	2	El número de dispositivos agregados correctamente al grupo.
ValidDeviceCount	Integer	2	El número de dispositivos válidos especificados.

Ejemplos

Solicitudes de ejemplo

https://iot.cn-shanghai.aliyuncs.com/?Action=BatchAddDeviceGroupRelations
&Device.1.DeviceName=ZHuPo6sZzv7pOzYh****
&Device.1.ProductKey=a1kORrK****
&Device.2.DeviceName=rB4V9PDW2FCPmwuf****
&Device.2.ProductKey=a1kORrK****
&GroupId=6VfhebLg5iUe****
&<Common request parameters>

Respuestas exitosas de ejemplo

Formato XML

<BatchAddDeviceGroupRelationsResponse>
      <SuccessAddedDeviceCount>2</SuccessAddedDeviceCount>
      <ExceedTenGroupDeviceCount>0</ExceedTenGroupDeviceCount>
      <ErrorMessage>2 devices have been added, and 0 devices failed to be added.</ErrorMessage>
      <ValidDeviceCount>2</ValidDeviceCount>
      <AlreadyRelatedGroupDeviceCount>0</AlreadyRelatedGroupDeviceCount>
      <RequestId>671D0F8F-FDC7-4B12-93FA-336C079C965A</RequestId>
      <Success>true</Success>
</BatchAddDeviceGroupRelationsResponse>

Formato JSON

{
    "SuccessAddedDeviceCount":2,
    "ExceedTenGroupDeviceCount":0,
    "ErrorMessage":"2 devices have been added, and 0 devices failed to be added.",
    "ValidDeviceCount":2,
    "AlreadyRelatedGroupDeviceCount":0,
    "RequestId":"671D0F8F-FDC7-4B12-93FA-336C079C965A",
    "Success":true   
}

Códigos de error

Para obtener una lista de códigos de error, visite el Centro de errores de API.