华为乾坤-创建终端:请求参数

时间:2025-05-12 15:31:41

请求参数

表1 body参数列表

参数名称

必选

类型

参数值域

默认值

参数说明

参数示例

createParam

REFERENCE

详细请参见表2

待创建的终端信息。

-

表2 TerminalMgrTerminalContent对象的参数列表

参数名称

必选

类型

参数值域

默认值

参数说明

参数示例

terminalContents

ARRAY_REFERENCE

1-1000个列表项,详细请参见表3

待添加的终端信息列表。

-

表3 TerminalMgrTerminalDto对象的参数列表

参数名称

必选

类型

参数值域

默认值

参数说明

参数示例

terminalMac

string

0~64个字符。

-

终端Mac,MAC的格式支持xx-xx-xx-xx-xx-xx、xx:xx:xx:xx:xx:xx。

"11-11-11-11-11-11"

serialNumber

string

-

-

序列号。

"SN10219210"

terminalIP

string

-

-

终端ip,只支持IPv4地址。

"192.168.0.1"

terminalGroupId

string

32~36个字符。

-

自定义终端组ID。UUID格式

"22fbb5f2-d07e-4710-94ac-7705517ab842"

isBlocked

boolean

  • true

  • false

false

是否加入黑名单,处于黑名单的终端无法认证。

false

isApproved

integer

-

0

审批状态。取值范围:0(默认)、1(已审批)、2(待审批)。

1

expirationDate

int32

[0-1440]

-

审批状态过期时间,单位:分钟,只有当isApproved为“1”可配置。

60

bindingDeviceMac

string

17个字符。

-

绑定设备的MAC,MAC的格式支持xx-xx-xx-xx-xx-xx、xx:xx:xx:xx:xx:xx。

"11-11-11-11-11-11"

bindingDevicePort

string

-

-

终端绑定设备端口。

"GigabitEthernet0/0/1"

source

integer

-

-

终端来源,三方系统添加的终端来源为固定值 6。

6

description

string

0~64个字符。

-

对终端的描述,1~64,不能包含特殊字符。

"Huawei phone"

deviceType

string

0~64个字符。

-

设备大类,仅允许中英文及_-@ .*

"打印机"

deviceVendor

string

0~64个字符。

-

设备厂商,仅允许中英文及_-@ .*,只有传入deviceType才生效

"HP"

deviceModel

string

0~64个字符。

-

设备型号,仅允许中英文及_-@ .*,只有传入deviceType,deviceVendor才生效

"HP-5720"

osVendor

string

0~64个字符。

-

操作系统厂商,仅允许中英文及_-@ .*

"Microsoft"

osType

string

0~64个字符。

-

操作系统类型,仅允许中英文及_-@ .*,只有传入osVendor才生效

"Windows"

osVersion

string

0~64个字符。

-

操作系统版本,仅允许中英文及_-@ .*,只有传入osVendor,osType才生效

"18362.1082"

customFields

ARRAY_REFERENCE

0-32个列表项,详细请参见表4

自定义字段

-

syncType

int32

-

-

同步类型:0-不同步,1-同步AC-IOT。

1

forceOverride

boolean

  • true

  • false

false

强制覆盖相同MAC的终端

false

表4 CustomField对象的参数列表

参数名称

必选

类型

参数值域

默认值

参数说明

参数示例

name

string

1~64个字符。

-

自定义字段名称,仅允许中英文及_-@ .*。控制器只做数据呈现,敏感信息请自行处理。

"资产编号"

value

string

1~64个字符。

-

自定义字段值,仅允许中英文及_-@ .*。控制器只做数据呈现,敏感信息请自行处理。

"HW-00001"

support.huaweicloud.com/qiankuncmn-qiankuncs/toctopics/zh-cn_topic_0000002128679062.html