-
请求参数 表2 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 requestDto 是 REFERENCE 详细请参见表3。 请求Dto - 表3 LedConfigRequest对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 ledOffEnable 是 boolean true false true 闪灯关闭配置开关参数，默认值为：true。 true timeTplEnable 是 boolean true false true 闪灯时间模板配置开关参数，默认值为：true。 true timeTplId 否 string 1~64个字符。 - 闪灯时间模板id，UUID格式。 "ea25fdbf-8dee-4823-bac2-5bfe8e3359ca"
-
请求示例 HTTP的示例 PUT /v1/oam/config/sites/fbde1c5d-5b94-49e3-a912-48641015e45c/ledconfig 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
{
"ledOffEnable" : true,
"timeTplEnable" : true,
"timeTplId" : "ea25fdbf-8dee-4823-bac2-5bfe8e3359ca"
}
-
响应参数 返回状态码为200：返回下发站点闪灯配置结果。 表4 LedConfigResult对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string 0~64个字符。 - 错误码。 "0" errmsg string 0~256个字符。 - 错误信息。 "" 返回状态码为400：接口入参非法的返回体。 详细信息请参见实际响应消息体。 返回状态码为500：接口发生内部错误后的返回体。 详细信息请参见实际响应消息体。
-
响应示例 返回状态码为200：返回下发站点闪灯配置结果。 HTTP/1.1 200 OK
Date: Sun,11 May 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,11 May 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,11 May 2025 10:00:00 GMT
Server: example-server
Content-Type: application/json;charset=UTF-8
Content-Length: 250
Connection: keep-alive
-
响应示例 返回状态码为200：闪灯增强成功，响应体参考ResultDto。 HTTP/1.1 200 OK
Date: Sun,11 May 2025 10:00:00 GMT
Server: example-server
Content-Type: application/json;charset=UTF-8
Content-Length: 250
Connection: keep-alive
{
"errcode" : "0",
"errmsg" : "error"
}
-
请求示例 HTTP的示例 PUT /controller/campus/v2/oamservice/devoam/device/blink/ea25fdbf-8dee-4823-bac2-5bfe8e3359ca 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
{
"takeover" : true,
"timeout" : 10,
"leds" : [
{
"ledName" : "sys-led",
"status" : 0
}
]
}
-
请求参数 表2 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 ledCtrlParam 是 REFERENCE 详细请参见表3。 LED灯控制参数。 - 表3 LedCtrlParam对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 takeover 是 boolean true false - 是否使能LED灯的控制，使能后，灯的状态将由下面的参数指定。当参数为False时，timeout和leds不生效。 true timeout 否 integer [10-600] - LED灯熄灭的时间，当时间到期后，LED灯将恢复原有的功能。单位：秒。当takeover参数为true时，该项为必填项。 10 leds 否 REFERENCE 1-4个列表项，详细请参见表4。 指定需要控制的灯的状态列表。当takeover参数为true时，该项为必填项。 - 表4 leds对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 ledName 否 string - - 指定要进行控制的灯的名字。系统灯---sys-led，控制灯---ctrl-led，网络灯---inet-led，USB灯---usb-led。 "sys-led" status 否 integer 0 1 2 - 灯状态。0---常灭，1---常亮，2---闪烁。 0
-
请求示例 HTTP的示例 POST /controller/campus/v2/oamservice/devoam/device/lsw/config-fault-light 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
{
"keepTime" : 45,
"mode" : "under-repair",
"devicesInfo" : [
{
"deviceId" : "ea25fdbf-8dee-4823-bac2-5bfe8e3359ca"
}
]
}
-
响应示例 返回状态码为200：配置成功，响应体参考OperationResultDto。 HTTP/1.1 200 OK
Date: Sun,11 May 2025 10:00:00 GMT
Server: example-server
Content-Type: application/json;charset=UTF-8
Content-Length: 250
Connection: keep-alive
{
"errcode" : "0",
"errmsg" : "error",
"successDeviceList" : [
"ea25fdbf-8dee-4823-bac2-5bfe8e3359ca"
],
"failedDeviceList" : [
{
"deviceId" : "ea25fdbf-8dee-4823-bac2-5bfe8e3359ca",
"failedReason" : "Device is not online"
}
]
}
-
请求参数 表1 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 lswLightInput 是 REFERENCE 详细请参见表2。 故障指示灯控制参数。 - 表2 LswLightInput对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 keepTime 否 int32 [45-600] - 指定故障指示灯表示设备故障状态所维持的时间。单位：秒。 45 mode 是 string under-repair - 设置设备的故障指示灯状态。 "under-repair" devicesInfo 是 ARRAY_REFERENCE 1-30个列表项，详细请参见表3。 指定需要闪灯的设备列表。 - 表3 DeviceInfo对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 deviceId 否 uuid - - 指定要进行控制的灯设备id,UUID格式。 "ea25fdbf-8dee-4823-bac2-5bfe8e3359ca"
-
请求示例 HTTP的示例 GET /v1/oam/config/sites/fbde1c5d-5b94-49e3-a912-48641015e45c/ledconfig 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：查询站点闪灯配置状态的返回结果。 表2 QueryLedConfigStatusResult对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string 0~64个字符。 - 错误码。 "0" errmsg string 0~256个字符。 - 错误信息。 "" data ARRAY_REFERENCE 0-2个列表项，详细请参见表3。 查询设备闪灯配置的状态。 - 表3 LedConfigStatus对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 ledOffEnable boolean true false true 闪灯关闭配置开关参数，默认值为：true。 true timeTplEnable boolean true false true 闪灯时间模板配置开关参数，默认值为：true。 true timeTplId string 1~64个字符。 - 闪灯时间模板id，UUID格式。 "ea25fdbf-8dee-4823-bac2-5bfe8e3359ca" 返回状态码为400：接口入参非法的返回体。 详细信息请参见实际响应消息体。 返回状态码为500：接口发生内部错误后的返回体。 详细信息请参见实际响应消息体。
-
响应示例 返回状态码为200：查询站点闪灯配置状态的返回结果。 HTTP/1.1 200 OK
Date: Sun,11 May 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" : [
{
"ledOffEnable" : true,
"timeTplEnable" : true,
"timeTplId" : "ea25fdbf-8dee-4823-bac2-5bfe8e3359ca"
}
]
} 返回状态码为400：接口入参非法的返回体。 HTTP/1.1 400 Bad Request
Date: Sun,11 May 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,11 May 2025 10:00:00 GMT
Server: example-server
Content-Type: application/json;charset=UTF-8
Content-Length: 250
Connection: keep-alive
