更新时间:2024-02-28 GMT+08:00
分享

添加设备组

功能介绍

应用服务器可调用此接口新建设备组,一个华为云账号下最多可有1,000个设备组,包括父设备组和子设备组。设备组的最大层级关系不超过5层,即群组形成的关系树最大深度不超过5。

调用方法

请参见如何调用API

URI

POST /v5/iot/{project_id}/device-group

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数说明:项目ID。获取方法请参见 获取项目ID

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数说明:用户Token。通过调用IAM服务 获取IAM用户Token接口获取,接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。简要的获取方法样例请参见 Token认证

Instance-Id

String

参数说明:实例ID。物理多租下各实例的唯一标识,建议携带该参数,在使用专业版时必须携带该参数。您可以在IoTDA管理控制台界面,选择左侧导航栏“总览”页签查看当前实例的ID,具体获取方式请参考查看实例详情

表3 请求Body参数

参数

是否必选

参数类型

描述

name

String

参数说明:设备组名称,单个资源空间下不可重复。 取值范围:长度不超过64,只允许中文、字母、数字、以及_? '#().,&%@!-等字符的组合。

最小长度:1

最大长度:64

description

String

参数说明:设备组描述。 取值范围:长度不超过64,只允许中文、字母、数字、以及_? '#().,&%@!-等字符的组合。

最小长度:1

最大长度:64

super_group_id

String

参数说明:父设备组ID,携带该参数时表示在该设备组下创建一个子设备组,动态群组不支持该参数。 取值范围:长度不超过36,十六进制字符串和连接符(-)的组合。

app_id

String

参数说明:资源空间ID。此参数为非必选参数,存在多资源空间的用户需要使用该接口时,建议携带该参数指定创建的设备组归属到哪个资源空间下,否则创建的设备组将会归属到默认资源空间下。 取值范围:长度不超过36,只允许字母、数字、下划线(_)、连接符(-)的组合。

group_type

String

参数说明:设备组类型,默认为静态设备组;当设备组类型为动态设备组时,需要填写动态设备组组规则

dynamic_group_rule

String

参数说明:动态设备组规则语法和高级搜索保持一致,只需要填写where 子句内容,其余子句无需填写,todo补充说明

响应参数

状态码: 201

表4 响应Body参数

参数

参数类型

描述

group_id

String

设备组ID,用于唯一标识一个设备组,在创建设备组时由物联网平台分配。

name

String

设备组名称,单个资源空间下不可重复。

description

String

设备组描述。

super_group_id

String

父设备组ID,该设备组的父设备组ID。

group_type

String

设备组类型,分为动态设备组和静态设备组两种

dynamic_group_rule

String

动态设备组规则

请求示例

  • 创建静态设备组,设备组名为GroupA。

    POST https://{endpoint}/v5/iot/{project_id}/device-group
    
    {
      "name" : "GroupA",
      "description" : "群组A",
      "super_group_id" : "04ed32dc1b0025b52fe3c01a27c2b0a8",
      "app_id" : "jeQDJQZltU8iKgFFoW060F5SGZka",
      "group_type" : "STATIC"
    }
  • 创建动态设备组,设备组名为GroupA。

    POST https://{endpoint}/v5/iot/{project_id}/device-group
    
    {
      "name" : "GroupA",
      "description" : "群组A",
      "app_id" : "jeQDJQZltU8iKgFFoW060F5SGZka",
      "dynamic_group_rule" : "product_id = '63fef97897bacf7a56438cba'",
      "group_type" : "DYNAMIC"
    }

响应示例

状态码: 201

Created

{
  "group_id" : "04ed32dc1b0025b52fe3c01a27c2babc",
  "name" : "GroupA",
  "description" : "群组A",
  "super_group_id" : "04ed32dc1b0025b52fe3c01a27c2b0a8",
  "group_type" : "STATIC",
  "dynamic_group_rule" : null
}

SDK代码示例

SDK代码示例如下。

Java

  • 创建静态设备组,设备组名为GroupA。

     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    25
    26
    27
    28
    29
    30
    31
    32
    33
    34
    35
    36
    37
    38
    39
    40
    41
    42
    43
    44
    45
    46
    47
    48
    49
    50
    51
    52
    53
    54
    package com.huaweicloud.sdk.test;
    
    import com.huaweicloud.sdk.core.auth.ICredential;
    import com.huaweicloud.sdk.core.auth.AbstractCredentials;
    import com.huaweicloud.sdk.core.auth.BasicCredentials;
    import com.huaweicloud.sdk.core.exception.ConnectionException;
    import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
    import com.huaweicloud.sdk.core.exception.ServiceResponseException;
    import com.huaweicloud.sdk.iotda.v5.region.IoTDARegion;
    import com.huaweicloud.sdk.iotda.v5.*;
    import com.huaweicloud.sdk.iotda.v5.model.*;
    
    
    public class AddDeviceGroupSolution {
    
        public static void main(String[] args) {
            // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
            // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
            String ak = System.getenv("CLOUD_SDK_AK");
            String sk = System.getenv("CLOUD_SDK_SK");
    
            ICredential auth = new BasicCredentials()
                    .withDerivedPredicate(AbstractCredentials.DEFAULT_DERIVED_PREDICATE) // Used in derivative ak/sk authentication scenarios
                    .withAk(ak)
                    .withSk(sk);
    
            IoTDAClient client = IoTDAClient.newBuilder()
                    .withCredential(auth)
                    .withRegion(IoTDARegion.valueOf("<YOUR REGION>"))
                    .build();
            AddDeviceGroupRequest request = new AddDeviceGroupRequest();
            AddDeviceGroupDTO body = new AddDeviceGroupDTO();
            body.withGroupType("STATIC");
            body.withAppId("jeQDJQZltU8iKgFFoW060F5SGZka");
            body.withSuperGroupId("04ed32dc1b0025b52fe3c01a27c2b0a8");
            body.withDescription("群组A");
            body.withName("GroupA");
            request.withBody(body);
            try {
                AddDeviceGroupResponse response = client.addDeviceGroup(request);
                System.out.println(response.toString());
            } catch (ConnectionException e) {
                e.printStackTrace();
            } catch (RequestTimeoutException e) {
                e.printStackTrace();
            } catch (ServiceResponseException e) {
                e.printStackTrace();
                System.out.println(e.getHttpStatusCode());
                System.out.println(e.getRequestId());
                System.out.println(e.getErrorCode());
                System.out.println(e.getErrorMsg());
            }
        }
    }
    
  • 创建动态设备组,设备组名为GroupA。

     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    25
    26
    27
    28
    29
    30
    31
    32
    33
    34
    35
    36
    37
    38
    39
    40
    41
    42
    43
    44
    45
    46
    47
    48
    49
    50
    51
    52
    53
    54
    package com.huaweicloud.sdk.test;
    
    import com.huaweicloud.sdk.core.auth.ICredential;
    import com.huaweicloud.sdk.core.auth.AbstractCredentials;
    import com.huaweicloud.sdk.core.auth.BasicCredentials;
    import com.huaweicloud.sdk.core.exception.ConnectionException;
    import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
    import com.huaweicloud.sdk.core.exception.ServiceResponseException;
    import com.huaweicloud.sdk.iotda.v5.region.IoTDARegion;
    import com.huaweicloud.sdk.iotda.v5.*;
    import com.huaweicloud.sdk.iotda.v5.model.*;
    
    
    public class AddDeviceGroupSolution {
    
        public static void main(String[] args) {
            // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
            // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
            String ak = System.getenv("CLOUD_SDK_AK");
            String sk = System.getenv("CLOUD_SDK_SK");
    
            ICredential auth = new BasicCredentials()
                    .withDerivedPredicate(AbstractCredentials.DEFAULT_DERIVED_PREDICATE) // Used in derivative ak/sk authentication scenarios
                    .withAk(ak)
                    .withSk(sk);
    
            IoTDAClient client = IoTDAClient.newBuilder()
                    .withCredential(auth)
                    .withRegion(IoTDARegion.valueOf("<YOUR REGION>"))
                    .build();
            AddDeviceGroupRequest request = new AddDeviceGroupRequest();
            AddDeviceGroupDTO body = new AddDeviceGroupDTO();
            body.withDynamicGroupRule("product_id = '63fef97897bacf7a56438cba'");
            body.withGroupType("DYNAMIC");
            body.withAppId("jeQDJQZltU8iKgFFoW060F5SGZka");
            body.withDescription("群组A");
            body.withName("GroupA");
            request.withBody(body);
            try {
                AddDeviceGroupResponse response = client.addDeviceGroup(request);
                System.out.println(response.toString());
            } catch (ConnectionException e) {
                e.printStackTrace();
            } catch (RequestTimeoutException e) {
                e.printStackTrace();
            } catch (ServiceResponseException e) {
                e.printStackTrace();
                System.out.println(e.getHttpStatusCode());
                System.out.println(e.getRequestId());
                System.out.println(e.getErrorCode());
                System.out.println(e.getErrorMsg());
            }
        }
    }
    

Python

  • 创建静态设备组,设备组名为GroupA。

     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    25
    26
    27
    28
    29
    30
    31
    32
    33
    34
    35
    36
    37
    38
    # coding: utf-8
    
    from huaweicloudsdkcore.auth.credentials import BasicCredentials
    from huaweicloudsdkcore.auth.credentials import DerivedCredentials
    from huaweicloudsdkiotda.v5.region.iotda_region import IoTDARegion
    from huaweicloudsdkcore.exceptions import exceptions
    from huaweicloudsdkiotda.v5 import *
    
    if __name__ == "__main__":
        # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        ak = __import__('os').getenv("CLOUD_SDK_AK")
        sk = __import__('os').getenv("CLOUD_SDK_SK")
    
        credentials = BasicCredentials(ak, sk) \
                .with_derived_predicate(DerivedCredentials.get_default_derived_predicate()) \
    
        client = IoTDAClient.new_builder() \
            .with_credentials(credentials) \
            .with_region(IoTDARegion.value_of("<YOUR REGION>")) \
            .build()
    
        try:
            request = AddDeviceGroupRequest()
            request.body = AddDeviceGroupDTO(
                group_type="STATIC",
                app_id="jeQDJQZltU8iKgFFoW060F5SGZka",
                super_group_id="04ed32dc1b0025b52fe3c01a27c2b0a8",
                description="群组A",
                name="GroupA"
            )
            response = client.add_device_group(request)
            print(response)
        except exceptions.ClientRequestException as e:
            print(e.status_code)
            print(e.request_id)
            print(e.error_code)
            print(e.error_msg)
    
  • 创建动态设备组,设备组名为GroupA。

     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    25
    26
    27
    28
    29
    30
    31
    32
    33
    34
    35
    36
    37
    38
    # coding: utf-8
    
    from huaweicloudsdkcore.auth.credentials import BasicCredentials
    from huaweicloudsdkcore.auth.credentials import DerivedCredentials
    from huaweicloudsdkiotda.v5.region.iotda_region import IoTDARegion
    from huaweicloudsdkcore.exceptions import exceptions
    from huaweicloudsdkiotda.v5 import *
    
    if __name__ == "__main__":
        # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        ak = __import__('os').getenv("CLOUD_SDK_AK")
        sk = __import__('os').getenv("CLOUD_SDK_SK")
    
        credentials = BasicCredentials(ak, sk) \
                .with_derived_predicate(DerivedCredentials.get_default_derived_predicate()) \
    
        client = IoTDAClient.new_builder() \
            .with_credentials(credentials) \
            .with_region(IoTDARegion.value_of("<YOUR REGION>")) \
            .build()
    
        try:
            request = AddDeviceGroupRequest()
            request.body = AddDeviceGroupDTO(
                dynamic_group_rule="product_id = '63fef97897bacf7a56438cba'",
                group_type="DYNAMIC",
                app_id="jeQDJQZltU8iKgFFoW060F5SGZka",
                description="群组A",
                name="GroupA"
            )
            response = client.add_device_group(request)
            print(response)
        except exceptions.ClientRequestException as e:
            print(e.status_code)
            print(e.request_id)
            print(e.error_code)
            print(e.error_msg)
    

Go

  • 创建静态设备组,设备组名为GroupA。

     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    25
    26
    27
    28
    29
    30
    31
    32
    33
    34
    35
    36
    37
    38
    39
    40
    41
    42
    43
    44
    45
    46
    47
    48
    49
    package main
    
    import (
    	"fmt"
    	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
        iotda "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/iotda/v5"
    	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/iotda/v5/model"
        region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/iotda/v5/region"
        core_auth "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth"
    )
    
    func main() {
        // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        ak := os.Getenv("CLOUD_SDK_AK")
        sk := os.Getenv("CLOUD_SDK_SK")
    
        auth := basic.NewCredentialsBuilder().
            WithAk(ak).
            WithSk(sk).
            WithDerivedPredicate(core_auth.GetDefaultDerivedPredicate()). // Used in derivative ak/sk authentication scenarios
            Build()
    
        client := iotda.NewIoTDAClient(
            iotda.IoTDAClientBuilder().
                WithRegion(region.ValueOf("<YOUR REGION>")).
                WithCredential(auth).
                Build())
    
        request := &model.AddDeviceGroupRequest{}
    	groupTypeAddDeviceGroupDto:= "STATIC"
    	appIdAddDeviceGroupDto:= "jeQDJQZltU8iKgFFoW060F5SGZka"
    	superGroupIdAddDeviceGroupDto:= "04ed32dc1b0025b52fe3c01a27c2b0a8"
    	descriptionAddDeviceGroupDto:= "群组A"
    	nameAddDeviceGroupDto:= "GroupA"
    	request.Body = &model.AddDeviceGroupDto{
    		GroupType: &groupTypeAddDeviceGroupDto,
    		AppId: &appIdAddDeviceGroupDto,
    		SuperGroupId: &superGroupIdAddDeviceGroupDto,
    		Description: &descriptionAddDeviceGroupDto,
    		Name: &nameAddDeviceGroupDto,
    	}
    	response, err := client.AddDeviceGroup(request)
    	if err == nil {
            fmt.Printf("%+v\n", response)
        } else {
            fmt.Println(err)
        }
    }
    
  • 创建动态设备组,设备组名为GroupA。

     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    25
    26
    27
    28
    29
    30
    31
    32
    33
    34
    35
    36
    37
    38
    39
    40
    41
    42
    43
    44
    45
    46
    47
    48
    49
    package main
    
    import (
    	"fmt"
    	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
        iotda "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/iotda/v5"
    	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/iotda/v5/model"
        region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/iotda/v5/region"
        core_auth "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth"
    )
    
    func main() {
        // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        ak := os.Getenv("CLOUD_SDK_AK")
        sk := os.Getenv("CLOUD_SDK_SK")
    
        auth := basic.NewCredentialsBuilder().
            WithAk(ak).
            WithSk(sk).
            WithDerivedPredicate(core_auth.GetDefaultDerivedPredicate()). // Used in derivative ak/sk authentication scenarios
            Build()
    
        client := iotda.NewIoTDAClient(
            iotda.IoTDAClientBuilder().
                WithRegion(region.ValueOf("<YOUR REGION>")).
                WithCredential(auth).
                Build())
    
        request := &model.AddDeviceGroupRequest{}
    	dynamicGroupRuleAddDeviceGroupDto:= "product_id = '63fef97897bacf7a56438cba'"
    	groupTypeAddDeviceGroupDto:= "DYNAMIC"
    	appIdAddDeviceGroupDto:= "jeQDJQZltU8iKgFFoW060F5SGZka"
    	descriptionAddDeviceGroupDto:= "群组A"
    	nameAddDeviceGroupDto:= "GroupA"
    	request.Body = &model.AddDeviceGroupDto{
    		DynamicGroupRule: &dynamicGroupRuleAddDeviceGroupDto,
    		GroupType: &groupTypeAddDeviceGroupDto,
    		AppId: &appIdAddDeviceGroupDto,
    		Description: &descriptionAddDeviceGroupDto,
    		Name: &nameAddDeviceGroupDto,
    	}
    	response, err := client.AddDeviceGroup(request)
    	if err == nil {
            fmt.Printf("%+v\n", response)
        } else {
            fmt.Println(err)
        }
    }
    

更多

更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

201

Created

403

Forbidden

404

Not Found

500

Internal Server Error

错误码

请参见错误码

分享:

    相关文档

    相关产品