云服务器内容精选

  • 请求示例 HTTP的示例 PUT /controller/campus/v1/sdwan/aaa/devicemanager/00000000-0000-0000-0000-000000000000 HTTP/1.1 Host: 192.168.1.125:18002 Content-Type: application/json Accept: application/json Accept-Language: en-US X-AC CES S-TOKEN: x-yyyyyy { "siteId" : "00000000-0000-0000-0000-000000000000", "deviceId" : "00000000-0000-0000-0000-000000000000", "domainId" : "00000000-0000-0000-0000-000000000000", "userName" : "name", "state" : "active", "serviceType" : "['http','ssh','terminal']", "privilegeLevel" : 0, "expireTime" : "2025-04-12T23:20:50.520Z", "timerange" : "10:00-12:00", "idleTimeout" : 5, "deviceUserId" : "00000000-0000-0000-0000-000000000000", "password" : "Example@123" }
  • 响应参数 返回状态码为200:修改成功,响应体参考DeviceManagerUserResponse。 DeviceManagerUserResponse对象的参数列表,详细请参见表3。 返回状态码为400:请求参数错误,响应体参考CommonDeviceManagerResponse。 表4 CommonDeviceManagerResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string 0~64个字符。 - 错误码。 "0" errmsg string 0~255个字符。 - 错误描述。 "" 返回状态码为500:内部异常。 详细信息请参见实际响应消息体。
  • 响应示例 返回状态码为200:修改成功,响应体参考DeviceManagerUserResponse。 HTTP/1.1 200 OK Date: Sun,16 Feb 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive { "errcode" : "0", "errmsg" : "", "data" : { "siteId" : "00000000-0000-0000-0000-000000000000", "deviceId" : "00000000-0000-0000-0000-000000000000", "domainId" : "00000000-0000-0000-0000-000000000000", "userName" : "name", "state" : "active", "serviceType" : "['http','ssh','terminal']", "privilegeLevel" : 0, "expireTime" : "2025-04-12T23:20:50.520Z", "timerange" : "10:00-12:00", "idleTimeout" : 5, "deviceUserId" : "00000000-0000-0000-0000-000000000000", "createTime" : "1985-04-12 23:20:50" } } 返回状态码为400:请求参数错误,响应体参考CommonDeviceManagerResponse。 HTTP/1.1 400 Bad Request Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive { "errcode" : "0x587679", "errmsg" : "" } 返回状态码为500:内部异常。 HTTP/1.1 500 Internal Server Error Date: Sun,16 Feb 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive
  • 请求参数 表2 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 body 是 REFERENCE 详细请参见表3。 设备管理员。 - 表3 DeviceManagerUserRequest对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 siteId 是 uuid - - 站点ID,UUID格式。 "00000000-0000-0000-0000-000000000000" deviceId 是 uuid - - 设备ID,UUID格式。 "00000000-0000-0000-0000-000000000000" domainId 是 uuid - - 域ID,UUID格式,需要先创建域。 "00000000-0000-0000-0000-000000000000" userName 是 string 1~64个字符。 - 设备管理员名称。 创建后不允许修改。 其中V600版本设备的设备管理员名称有如下说明: a) 针对V600R021C00版本及之后版本的设备,名称为admin时补齐为administrator下发; b) 长度不能小于6; c) 不允许创建名称为administrator的设备管理员。 "name" state 否 string active block active 帐号状态,该字段可以设置为以下几种: a) active:激活状态 b) block:阻塞状态 激活状态的帐号可以进行登录认证,阻塞状态的帐号设备拒绝登录认证。 默认值active。 "active" serviceType 否 string - ['http'] 服务类型,该字段可以设置为以下几种: a) http b) ssh c) terminal http为不安全协议,建议使用更安全的服务类型。 默认值['http']。 "['http','ssh','terminal']" privilegeLevel 否 integer [0-15] 0 用户级别,取值范围:0~15。 其中FW设备的用户级别取值范围为0~3。默认值0。 0 expireTime 否 string 0~128个字符。满足正则表达((((20)(([2468][048])|([13579][26])))-(((0[13578]|1[02])-(0[1-9]|[12][0-9]|3[01]))|((0[469]|(11))-(0[1-9]|[12][0-9]|(30)))|(((02)-(0[1-9]|[12][0-9])))))|(((20)(([2468][1235679])|([13579][01345789])))-(((0[13578]|1[02])-(0[1-9]|[12][0-9]|3[01]))|((0[469]|(11))-(0[1-9]|[12][0-9]|(30)))|(((02)-(0[1-9]|[12][0-8]))))))T(([01][0-9])|(2[0-3])):([0-5][0-9]):([0-5][0-9])(\.\d{3})(Z|[\+\-]([0-5][0-9]):([0-5][0-9]))。 2099-12-31T00:00:00.000Z 帐号有效期截止时间,格式为YYYY-MM-DDTHH:MM:SS.SSSZ。 其中V600版本设备的帐号有效期截止时间最大可设置为2037-12-31T23:59:59.000Z。 默认2099-12-31T00:00:00.000Z,其中V600版本设备默认2037-12-31T23:59:59.000Z。 设备管理员创建后此属性不可修改。 "2025-04-12T23:20:50.520Z" timerange 否 string 1~128个字符。满足正则表达^(([01]?[0-9])|(2[0-3])):[0-5]?[0-9]-(([01]?[0-9])|(2[0-3])):[0-5]?[0-9]$。 - 指定userName接入时间段范围,格式:HH:MM-HH:MM。 设备管理员创建后不可修改。 "10:00-12:00" idleTimeout 否 int32 [0-1200] 10 用户的闲置超时时间,单位:秒。 默认为10。 5 deviceUserId 是 uuid - - 设备管理员ID,UUID格式。 "00000000-0000-0000-0000-000000000000" password 否 password 8~128个字符。 - 该字段可能包含敏感信息和个人数据,请妥善做好保护。 1.密码长度必须在8~128位。 2.密码必须满足复杂度,即至少包含英文大写字母(A~Z)、英文小写字母(a~z)、数字(0~9)、特殊字符(如!、@、#、$、%)等中的三种,V600版本的设备至少包含其中的四种,不允许包含'、?和空格。 3.密码中不能包含超过两个连续的相同字符。 4.密码不能为用户名或用户名的倒写。 "Example@123"
  • 响应示例 返回状态码为200:删除成功,响应体参考CommonDeviceManagerResponse。 HTTP/1.1 200 OK Date: Sun,16 Feb 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive { "errcode" : "0", "errmsg" : "" } 返回状态码为400:请求参数错误。 HTTP/1.1 400 Bad Request Date: Sun,16 Feb 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive 返回状态码为500:内部异常。 HTTP/1.1 500 Internal Server Error Date: Sun,16 Feb 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive
  • 请求示例 HTTP的示例 DELETE /controller/campus/v1/sdwan/aaa/devicemanager/00000000-0000-0000-0000-000000000000 HTTP/1.1 Host: 192.168.1.125:18002 Content-Type: application/json Accept: application/json Accept-Language: en-US X-ACCESS-TOKEN: x-yyyyyy
  • 请求示例 HTTP的示例 GET /controller/campus/v1/sdwan/aaa/devicemanager?pageIndex=1&pageSize=10&siteId=00000000-0000-0000-0000-000000000000&deviceId=00000000-0000-0000-0000-000000000000&userName=name HTTP/1.1 Host: 192.168.1.125:18002 Content-Type: application/json Accept: application/json Accept-Language: en-US X-ACCESS-TOKEN: x-yyyyyy
  • 响应参数 返回状态码为200:查询成功,响应体参考QueryDeviceManagerResponse。 表2 QueryDeviceManagerResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string 0~64个字符。 - 错误码。 "0" errmsg string 0~255个字符。 - 错误描述。 "" data ARRAY_REFERENCE 0-100个列表项,详细请参见表4。 - - pageIndex int32 [1-10000] - 当前页,从1开始。 1 pageSize int32 [1-10000] - 页大小。 10 totalRecords int32 [1-100000] - 总记录数。 100 返回状态码为400:请求参数错误。 详细信息请参见实际响应消息体。 返回状态码为500:内部异常。 详细信息请参见实际响应消息体。
  • 响应示例 返回状态码为200:查询成功,响应体参考QueryDeviceManagerResponse。 HTTP/1.1 200 OK Date: Sun,16 Feb 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive { "errcode" : "0", "errmsg" : "", "data" : [ { "siteId" : "00000000-0000-0000-0000-000000000000", "deviceId" : "00000000-0000-0000-0000-000000000000", "domainId" : "00000000-0000-0000-0000-000000000000", "userName" : "name", "state" : "active", "serviceType" : "['http','ssh','terminal']", "privilegeLevel" : 0, "expireTime" : "2025-04-12T23:20:50.520Z", "timerange" : "10:00-12:00", "idleTimeout" : 5, "deviceUserId" : "00000000-0000-0000-0000-000000000000", "createTime" : "1985-04-12 23:20:50" } ], "pageIndex" : 1, "pageSize" : 10, "totalRecords" : 100 } 返回状态码为400:请求参数错误。 HTTP/1.1 400 Bad Request Date: Sun,16 Feb 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive 返回状态码为500:内部异常。 HTTP/1.1 500 Internal Server Error Date: Sun,16 Feb 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive
  • URI /controller/campus/v1/sdwan/aaa/devicemanager 表1 query参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 pageIndex 否 int32 - - 起始页。 1 pageSize 否 int32 [0-100] 10 页行记录数。默认值10。 10 siteId 否 uuid - - 站点ID,UUID格式。 "00000000-0000-0000-0000-000000000000" deviceId 否 uuid - - 设备ID,UUID格式。 "00000000-0000-0000-0000-000000000000" userName 否 string - - 设备管理员名称。 支持模糊查询。 "name"
  • 响应示例 返回状态码为201:创建成功,响应体参考DeviceManagerUserResponse。 HTTP/1.1 201 Created Date: Sun,16 Feb 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive { "errcode" : "0", "errmsg" : "", "data" : { "siteId" : "00000000-0000-0000-0000-000000000000", "deviceId" : "00000000-0000-0000-0000-000000000000", "domainId" : "00000000-0000-0000-0000-000000000000", "userName" : "name", "state" : "active", "serviceType" : "['http','ssh','terminal']", "privilegeLevel" : 0, "expireTime" : "2025-04-12T23:20:50.520Z", "timerange" : "10:00-12:00", "idleTimeout" : 5, "deviceUserId" : "00000000-0000-0000-0000-000000000000", "createTime" : "1985-04-12 23:20:50" } } 返回状态码为400:请求参数错误。 HTTP/1.1 400 Bad Request Date: Sun,16 Feb 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive 返回状态码为500:内部异常。 HTTP/1.1 500 Internal Server Error Date: Sun,16 Feb 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive
  • 请求示例 HTTP的示例 POST /controller/campus/v1/sdwan/aaa/devicemanager HTTP/1.1 Host: 192.168.1.125:18002 Content-Type: application/json Accept: application/json Accept-Language: en-US X-ACCESS-TOKEN: x-yyyyyy { "siteId" : "00000000-0000-0000-0000-000000000000", "deviceId" : "00000000-0000-0000-0000-000000000000", "domainId" : "00000000-0000-0000-0000-000000000000", "userName" : "name", "state" : "active", "serviceType" : "['http','ssh','terminal']", "privilegeLevel" : 0, "expireTime" : "2025-04-12T23:20:50.520Z", "timerange" : "10:00-12:00", "idleTimeout" : 5, "password" : "Example@123" }
  • 响应参数 返回状态码为201:创建成功,响应体参考DeviceManagerUserResponse。 表3 DeviceManagerUserResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string 0~64个字符。 - 错误码。 "0" errmsg string 0~255个字符。 - 错误描述。 "" data REFERENCE 详细请参见表4。 - - 表4 DeviceManagerUser对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 siteId uuid - - 站点ID,UUID格式。 "00000000-0000-0000-0000-000000000000" deviceId uuid - - 设备ID,UUID格式。 "00000000-0000-0000-0000-000000000000" domainId uuid - - 域ID,UUID格式,需要先创建域。 "00000000-0000-0000-0000-000000000000" userName string 1~64个字符。 - 设备管理员名称。 创建后不允许修改。 其中V600版本设备的设备管理员名称有如下说明: a) 针对V600R021C00版本及之后版本的设备,名称为admin时补齐为administrator下发; b) 长度不能小于6; c) 不允许创建名称为administrator的设备管理员。 "name" state string active block active 帐号状态,该字段可以设置为以下几种: a) active:激活状态 b) block:阻塞状态 激活状态的帐号可以进行登录认证,阻塞状态的帐号设备拒绝登录认证。 默认值active。 "active" serviceType string - ['http'] 服务类型,该字段可以设置为以下几种: a) http b) ssh c) terminal http为不安全协议,建议使用更安全的服务类型。 默认值['http']。 "['http','ssh','terminal']" privilegeLevel integer [0-15] 0 用户级别,取值范围:0~15。 其中FW设备的用户级别取值范围为0~3。默认值0。 0 expireTime string 0~128个字符。满足正则表达((((20)(([2468][048])|([13579][26])))-(((0[13578]|1[02])-(0[1-9]|[12][0-9]|3[01]))|((0[469]|(11))-(0[1-9]|[12][0-9]|(30)))|(((02)-(0[1-9]|[12][0-9])))))|(((20)(([2468][1235679])|([13579][01345789])))-(((0[13578]|1[02])-(0[1-9]|[12][0-9]|3[01]))|((0[469]|(11))-(0[1-9]|[12][0-9]|(30)))|(((02)-(0[1-9]|[12][0-8]))))))T(([01][0-9])|(2[0-3])):([0-5][0-9]):([0-5][0-9])(\.\d{3})(Z|[\+\-]([0-5][0-9]):([0-5][0-9]))。 2099-12-31T00:00:00.000Z 帐号有效期截止时间,格式为YYYY-MM-DDTHH:MM:SS.SSSZ。 其中V600版本设备的帐号有效期截止时间最大可设置为2037-12-31T23:59:59.000Z。 默认2099-12-31T00:00:00.000Z,其中V600版本设备默认2037-12-31T23:59:59.000Z。 设备管理员创建后此属性不可修改。 "2025-04-12T23:20:50.520Z" timerange string 1~128个字符。满足正则表达^(([01]?[0-9])|(2[0-3])):[0-5]?[0-9]-(([01]?[0-9])|(2[0-3])):[0-5]?[0-9]$。 - 指定userName接入时间段范围,格式:HH:MM-HH:MM。 设备管理员创建后不可修改。 "10:00-12:00" idleTimeout int32 [0-1200] 10 用户的闲置超时时间,单位:秒。 默认为10。 5 deviceUserId uuid - - 设备管理员ID,UUID格式。 "00000000-0000-0000-0000-000000000000" createTime string 0~128个字符。 - 创建时间,UTC时间,格式:yyyy-MM-dd HH:mm:ss。 "1985-04-12 23:20:50" 返回状态码为400:请求参数错误。 详细信息请参见实际响应消息体。 返回状态码为500:内部异常。 详细信息请参见实际响应消息体。
  • 请求参数 表1 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 deviceManager 是 REFERENCE 详细请参见表2。 设备管理员信息。 - 表2 DeviceManagerUserInfo对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 siteId 是 uuid - - 站点ID,UUID格式。 "00000000-0000-0000-0000-000000000000" deviceId 是 uuid - - 设备ID,UUID格式。 "00000000-0000-0000-0000-000000000000" domainId 是 uuid - - 域ID,UUID格式,需要先创建域。 "00000000-0000-0000-0000-000000000000" userName 是 string 1~64个字符。 - 设备管理员名称。 创建后不允许修改。 其中V600版本设备的设备管理员名称有如下说明: a) 针对V600R021C00版本及之后版本的设备,名称为admin时补齐为administrator下发; b) 长度不能小于6; c) 不允许创建名称为administrator的设备管理员。 "name" state 否 string active block active 帐号状态,该字段可以设置为以下几种: a) active:激活状态 b) block:阻塞状态 激活状态的帐号可以进行登录认证,阻塞状态的帐号设备拒绝登录认证。 默认值active。 "active" serviceType 否 string - ['http'] 服务类型,该字段可以设置为以下几种: a) http b) ssh c) terminal http为不安全协议,建议使用更安全的服务类型。 默认值['http']。 "['http','ssh','terminal']" privilegeLevel 否 integer [0-15] 0 用户级别,取值范围:0~15。 其中FW设备的用户级别取值范围为0~3。默认值0。 0 expireTime 否 string 0~128个字符。满足正则表达((((20)(([2468][048])|([13579][26])))-(((0[13578]|1[02])-(0[1-9]|[12][0-9]|3[01]))|((0[469]|(11))-(0[1-9]|[12][0-9]|(30)))|(((02)-(0[1-9]|[12][0-9])))))|(((20)(([2468][1235679])|([13579][01345789])))-(((0[13578]|1[02])-(0[1-9]|[12][0-9]|3[01]))|((0[469]|(11))-(0[1-9]|[12][0-9]|(30)))|(((02)-(0[1-9]|[12][0-8]))))))T(([01][0-9])|(2[0-3])):([0-5][0-9]):([0-5][0-9])(\.\d{3})(Z|[\+\-]([0-5][0-9]):([0-5][0-9]))。 2099-12-31T00:00:00.000Z 帐号有效期截止时间,格式为YYYY-MM-DDTHH:MM:SS.SSSZ。 其中V600版本设备的帐号有效期截止时间最大可设置为2037-12-31T23:59:59.000Z。 默认2099-12-31T00:00:00.000Z,其中V600版本设备默认2037-12-31T23:59:59.000Z。 设备管理员创建后此属性不可修改。 "2025-04-12T23:20:50.520Z" timerange 否 string 1~128个字符。满足正则表达^(([01]?[0-9])|(2[0-3])):[0-5]?[0-9]-(([01]?[0-9])|(2[0-3])):[0-5]?[0-9]$。 - 指定userName接入时间段范围,格式:HH:MM-HH:MM。 设备管理员创建后不可修改。 "10:00-12:00" idleTimeout 否 int32 [0-1200] 10 用户的闲置超时时间,单位:秒。 默认为10。 5 password 是 password 8~128个字符。 - 该字段可能包含敏感信息和个人数据,请妥善做好保护。 密码必须包含如下规则: 1.密码长度必须在8~128位。 2.密码必须满足复杂度,即至少包含英文大写字母(A~Z)、英文小写字母(a~z)、数字(0~9)、特殊字符(如!、@、#、$、%)等中的三种,V600版本的设备至少包含其中的四种,不允许包含'、?和空格。 3.密码中不能包含超过两个连续的相同字符。 4.密码不能为用户名或用户名的倒写。 "Example@123"