云服务器内容精选

  • 响应示例 返回状态码为200:光口资源查询成功。 HTTP/1.1 200 OK Date: Tue,30 Oct 2018 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive { "code" : 0, "data" : [ { "name" : "XGigabitEthernet0/0/1", "adminstatus" : "1", "operstatus" : "1", "ipaddress" : "10.x.x.x", "ipnetmask" : "0.0.0.0", "portindex" : "70664270" } ], "pageSize" : 1, "totalSize" : 100, "description" : "查询成功。" } 返回状态码为400:参数错误。 HTTP/1.1 400 Bad Request Date: Tue,30 Oct 2018 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive 返回状态码为404:rest接口没找到。 HTTP/1.1 404 Not Found Date: Tue,30 Oct 2018 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive 返回状态码为500:默认ServiceException异常码,应用内部错误。 HTTP/1.1 500 Internal Server Error Date: Tue,30 Oct 2018 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive
  • URI /rest/openapi/network/otpoint 表1 query参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 nedn 否 string 1~100个字符。 - 设备DN。 "047f72d1-7ad3-11e9-b906-000c29b01448" start 否 integer - 0 指定从哪个起始记录位置开始返回查询结果集。缺省值是0。说明:如果值小于0,将使用缺省值。 0 size 否 integer - 20 指定返回查询结果集总数,支持1~100条,缺省值是20。说明:如果值小于1或大于100时,将使用缺省值。 20 fields 否 string - - 指定查询结果所包含的列。需要查询的列名为fields参数的值,多个列名时可用英文逗号隔开。 说明: 此请求参数只有指定了fields请求参数后才有效,不指定默认返回所有字段。包含字段name, adminstatus, operstatus, ipaddress, ipnetmask, portindex "name"
  • 请求示例 cURL的示例 curl -k -s -L -i -X GET -H 'Content-Type: application/json' -H 'Accept: application/json' -H 'Accept-Language: en-US' -H 'X-AC CES S-TOKEN: x-rwld6ng9vy2rg96llg85sbdisbmrfw1gdfamaoepoahcaq2nliams8s8epapiofx2r5druhi5g7wmmjzc5btftlduo7w88bybuqp7xmlup9htd5gpg4bmmrufvnt4aan' 'https://192.168.1.125:18002/rest/openapi/network/otpoint?nedn=047f72d1-7ad3-11e9-b906-000c29b01448&start=0&size=20&fields=name' HTTP的示例 GET /rest/openapi/network/otpoint?nedn=047f72d1-7ad3-11e9-b906-000c29b01448&start=0&size=20&fields=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-rwld6ng9vy2rg96llg85sbdisbmrfw1gdfamaoepoahcaq2nliams8s8epapiofx2r5druhi5g7wmmjzc5btftlduo7w88bybuqp7xmlup9htd5gpg4bmmrufvnt4aan
  • 响应参数 返回状态码为200:光口资源查询成功。 表2 OTPointResResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 code int32 - 0 操作返回码。可以是如下值之一: 0:成功 非0:失败 0 data ARRAY_REFERENCE 详细请参见表3。 - - pageSize integer - - 记录总页数。 1 totalSize integer - - 记录总数。 100 description string - - 描述信息。 "查询成功。" 表3 OTPointResData对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 name string - - 光口名称。 "XGigabitEthernet0/0/1" adminstatus string - - 光口管理状态,可以是如下值之一: 1:up 2:down 3:planning "1" operstatus string - - 光口操作状态,可以是如下值之一: 1:up 2:down 3:testing 4:unknown 5:dormant 6:notPresent 7:lowerLayerDown "1" ipaddress string - - 光口IP地址。 "10.x.x.x" ipnetmask string - - 光口子网掩码。 "0.0.0.0" portindex string - - 光口索引。 "70664270" 返回状态码为400:参数错误。 详细信息请参见实际响应消息体。 返回状态码为404:rest接口没找到。 详细信息请参见实际响应消息体。 返回状态码为500:默认ServiceException异常码,应用内部错误。 详细信息请参见实际响应消息体。
  • 响应示例 返回状态码为200:子卡资源查询成功。 HTTP/1.1 200 OK Date: Tue,30 Oct 2018 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive { "code" : 0, "data" : [ { "nedn" : "a4059c31-7ad3-11e9-b906-000c29b01448", "neName" : "AR1220-56", "framedn" : "a4059c31-7ad3-11e9-b906-000c29b01448,FR=0", "slotdn" : "a4059c31-7ad3-11e9-b906-000c29b01448,FR=0,S=0", "slotname" : "SRU Board 0", "subslotdn" : "a4059c31-7ad3-11e9-b906-000c29b01448,FR=0,S=0,SS=0", "frameno" : 0, "slotno" : 0, "subslotindex" : 16397, "subslotno" : 0, "descr" : "FAN Card", "subslotname" : "FAN Card 0/1", "vendortype" : ".1.3.6.1.4.1.2011.20021210.13.0", "physicalclass" : 9, "hardversion" : "VER.0", "firmversion" : "Hex:31 30 39", "softversion" : "0", "adminstatus" : 4, "operstatus" : 3, "modelname" : "--", "serialnum" : "030KSB10B3000060", "mfgname" : "Huawei" } ], "description" : "查询成功。" } 返回状态码为400:参数错误。 HTTP/1.1 400 Bad Request Date: Tue,30 Oct 2018 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive 返回状态码为404:rest接口没找到。 HTTP/1.1 404 Not Found Date: Tue,30 Oct 2018 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive 返回状态码为500:默认ServiceException异常码,应用内部错误。 HTTP/1.1 500 Internal Server Error Date: Tue,30 Oct 2018 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive
  • 响应参数 返回状态码为200:子卡资源查询成功。 表2 SubSlotResResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 code int32 - 0 操作返回码。可以是如下值之一: 0:成功 非0:失败 0 data ARRAY_REFERENCE 详细请参见表3。 - - description string - - 描述信息。 "查询成功。" 表3 SubSlotResData对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 nedn string - - 设备dn。 "a4059c31-7ad3-11e9-b906-000c29b01448" neName string - - 设备名称。 "AR1220-56" framedn string - - 机框dn。 "a4059c31-7ad3-11e9-b906-000c29b01448,FR=0" slotdn string - - 单板dn。 "a4059c31-7ad3-11e9-b906-000c29b01448,FR=0,S=0" slotname string - - 单板名称。 "SRU Board 0" subslotdn string - - 子卡dn。 "a4059c31-7ad3-11e9-b906-000c29b01448,FR=0,S=0,SS=0" frameno integer - - 机框序号。 0 slotno integer - - 单板序号。 0 subslotindex integer - - 子卡索引。 16397 subslotno integer - - 子卡序号。 0 descr string - - 子卡描述。 "FAN Card" subslotname string - - 子卡名称。 "FAN Card 0/1" vendortype string - - 厂商类型。 ".1.3.6.1.4.1.2011.20021210.13.0" physicalclass integer - - 设备上实体大类型: 3:框 4:背板 5:子槽 6:电源 7:风扇 9:板 10:端口 9 hardversion string - - 硬件版本。 "VER.0" firmversion string - - firm版本。 "Hex:31 30 39" softversion string - - 软件版本。 "0" adminstatus integer - - 管理状态: 4、11:正常 2、3、12:错误 13:LoopBack 4 operstatus integer - - 操作状态: 3、11、13、15、16:正常 2、12、17:错误 4:离线 其他:未知 3 modelname string - - 模块名称。 "--" serialnum string - - 序列号。 "030KSB10B3000060" mfgname string - - 组件名称,物理固件的制造厂商。 "Huawei" 返回状态码为400:参数错误。 详细信息请参见实际响应消息体。 返回状态码为404:rest接口没找到。 详细信息请参见实际响应消息体。 返回状态码为500:默认ServiceException异常码,应用内部错误。 详细信息请参见实际响应消息体。
  • 请求示例 cURL的示例 curl -k -s -L -i -X GET -H 'Content-Type: application/json' -H 'Accept: application/json' -H 'Accept-Language: en-US' -H 'X-ACCESS-TOKEN: x-rwld6ng9vy2rg96llg85sbdisbmrfw1gdfamaoepoahcaq2nliams8s8epapiofx2r5druhi5g7wmmjzc5btftlduo7w88bybuqp7xmlup9htd5gpg4bmmrufvnt4aan' 'https://192.168.1.125:18002/rest/openapi/network/subslot?nedn=a4059c31-7ad3-11e9-b906-000c29b01448&nename=AR1220-56&framedn=a4059c31-7ad3-11e9-b906-000c29b01448,FR=0&slotdn=a4059c31-7ad3-11e9-b906-000c29b01448,FR=0,S=0&slotname=SRU Board 0&subslotdn=a4059c31-7ad3-11e9-b906-000c29b01448,FR=0,S=0,SS=0&frameno=0&slotno=0&subslotindex=16397&subslotno=0&descr=FAN Card&subslotname=FAN Card 0/1&vendortype=.1.3.6.1.4.1.2011.20021210.13.0&physicalclass=9&hardversion=VER.0&firmversion=Hex:31 30 39&softversion=0&adminstatus=4&operstatus=3&modelname=--&serialnum=030KSB10B3000060&mfgname=Huawei&start=0&size=20&orderby=nedn&desc=true' HTTP的示例 GET /rest/openapi/network/subslot?nedn=a4059c31-7ad3-11e9-b906-000c29b01448&nename=AR1220-56&framedn=a4059c31-7ad3-11e9-b906-000c29b01448,FR=0&slotdn=a4059c31-7ad3-11e9-b906-000c29b01448,FR=0,S=0&slotname=SRU Board 0&subslotdn=a4059c31-7ad3-11e9-b906-000c29b01448,FR=0,S=0,SS=0&frameno=0&slotno=0&subslotindex=16397&subslotno=0&descr=FAN Card&subslotname=FAN Card 0/1&vendortype=.1.3.6.1.4.1.2011.20021210.13.0&physicalclass=9&hardversion=VER.0&firmversion=Hex:31 30 39&softversion=0&adminstatus=4&operstatus=3&modelname=--&serialnum=030KSB10B3000060&mfgname=Huawei&start=0&size=20&orderby=nedn&desc=true HTTP/1.1 Host: 192.168.1.125:18002 Content-Type: application/json Accept: application/json Accept-Language: en-US X-ACCESS-TOKEN: x-rwld6ng9vy2rg96llg85sbdisbmrfw1gdfamaoepoahcaq2nliams8s8epapiofx2r5druhi5g7wmmjzc5btftlduo7w88bybuqp7xmlup9htd5gpg4bmmrufvnt4aan
  • URI /rest/openapi/network/subslot 表1 query参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 nedn 否 string 1~100个字符。 - 设备Dn。 "a4059c31-7ad3-11e9-b906-000c29b01448" nename 否 string 1~100个字符。 - 设备名称。 "AR1220-56" framedn 否 string 1~100个字符。 - 机框Dn。 "a4059c31-7ad3-11e9-b906-000c29b01448,FR=0" slotdn 否 string 1~100个字符。 - 单板Dn。 "a4059c31-7ad3-11e9-b906-000c29b01448,FR=0,S=0" slotname 否 string 1~100个字符。 - 单板名称。 "SRU Board 0" subslotdn 否 string 1~100个字符。 - 子卡Dn。 "a4059c31-7ad3-11e9-b906-000c29b01448,FR=0,S=0,SS=0" frameno 否 integer 满足正则表达^([-+]?\d{1,10})$。 - 机框序号。 0 slotno 否 integer 满足正则表达^([-+]?\d{1,10})$。 - 单板序号。 0 subslotindex 否 integer 满足正则表达^([-+]?\d{1,10})$。 - 子卡索引。 16397 subslotno 否 integer 满足正则表达^([-+]?\d{1,10})$。 - 子卡序号。 0 descr 否 string 1~100个字符。 - 子卡描述。 "FAN Card" subslotname 否 string 1~100个字符。 - 子卡名称。 "FAN Card 0/1" vendortype 否 string 1~100个字符。 - 厂商类型。 ".1.3.6.1.4.1.2011.20021210.13.0" physicalclass 否 integer 满足正则表达^([-+]?\d{1,10})$。 - 设备上实体大类型: 3:框 4:背板 5:子槽 6:电源 7:风扇 9:板 10:端口 9 hardversion 否 string 1~100个字符。 - 硬件版本。 "VER.0" firmversion 否 string 1~100个字符。 - 固件版本 。 "Hex:31 30 39" softversion 否 string 1~100个字符。 - 软件版本。 "0" adminstatus 否 integer 满足正则表达^([-+]?\d{1,10})$。 - 管理状态: 4、11:正常 2、3、12:错误 13:LoopBack 4 operstatus 否 integer 满足正则表达^([-+]?\d{1,10})$。 - 操作状态: 3、11、13、15、16:正常 2、12、17:错误 4:离线 其他:未知 3 modelname 否 string 1~100个字符。 - 模块名称。 "--" serialnum 否 string 1~100个字符。 - 序列号。 "030KSB10B3000060" mfgname 否 string 1~100个字符。 - 组件名称,物理固件的制造厂商。 "Huawei" start 否 integer - 0 指定从哪个起始记录位置开始返回查询结果集。缺省值是0。说明:如果值小于0,将使用缺省值。 0 size 否 integer - 20 指定返回查询结果集总数。缺省值是20。说明:如果值小于0,将使用缺省值。 20 orderby 否 string - nedn 指定查询结果集采用的排序字段。缺省排序字段是nedn。可指定的排序字段包括:nedn、nename、framedn、slotdn、slotname。说明:指定多个排序字段时字段间用英文半角逗号“,”分隔。 "nedn" desc 否 boolean - false 指定查询结果是否按降序排序。缺省值是false。说明:此请求参数只有指定了“orderby”请求参数后才有效。 true
  • 响应示例 返回状态码为200:单板资源查询成功。 HTTP/1.1 200 OK Date: Tue,30 Oct 2018 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive { "code" : 0, "data" : [ { "nedn" : "047f72d1-7ad3-11e9-b906-000c29b01448", "neName" : "FW_B", "framedn" : "047f72d1-7ad3-11e9-b906-000c29b01448,FR=1", "framename" : "Eudemon1000E-N6", "frameno" : 1, "slotdn" : "047f72d1-7ad3-11e9-b906-000c29b01448,FR=1,S=1", "slotindex" : 67371017, "slotno" : 1, "vendortype" : ".1.3.6.1.4.1.2011.20021210.12.16719978", "descr" : "--", "slotname" : "2XG8GE", "physicalclass" : 9, "adminstatus" : 4, "operstatus" : 3, "standbystatus" : 1, "hardversion" : "VER.A", "firmversion" : "221 Nov 28 2017 17:23:17", "softversion" : "V500R001C80SPC100", "serialnum" : "210235G7FW0123456789", "mfgname" : "Huawei", "modelname" : "huawei", "alarmlight" : "huawei" } ], "description" : "查询成功。" } 返回状态码为400:参数错误。 HTTP/1.1 400 Bad Request Date: Tue,30 Oct 2018 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive 返回状态码为404:rest接口没找到。 HTTP/1.1 404 Not Found Date: Tue,30 Oct 2018 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive 返回状态码为500:默认ServiceException异常码,应用内部错误。 HTTP/1.1 500 Internal Server Error Date: Tue,30 Oct 2018 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive
  • 请求示例 cURL的示例 curl -k -s -L -i -X GET -H 'Content-Type: application/json' -H 'Accept: application/json' -H 'Accept-Language: en-US' -H 'X-ACCESS-TOKEN: x-rwld6ng9vy2rg96llg85sbdisbmrfw1gdfamaoepoahcaq2nliams8s8epapiofx2r5druhi5g7wmmjzc5btftlduo7w88bybuqp7xmlup9htd5gpg4bmmrufvnt4aan' 'https://192.168.1.125:18002/rest/openapi/network/slot?nedn=047f72d1-7ad3-11e9-b906-000c29b01448&nename=FW_B&framedn=047f72d1-7ad3-11e9-b906-000c29b01448,FR=1&framename=Eudemon1000E-N6&frameno=1&slotdn=047f72d1-7ad3-11e9-b906-000c29b01448,FR=1,S=1&slotindex=67371017&slotno=1&vendortype=.1.3.6.1.4.1.2011.20021210.12.16719978&descr=--&slotname=2XG8GE&physicalclass=9&adminstatus=4&operstatus=3&standbystatus=1&hardversion=VER.A&firmversion=221 Nov 28 2017 17:23:17&softversion=V500R001C80SPC100&serialnum=210235G7FW0123456789&mfgname=Huawei&modelname=huawei&alarmlight=huawei&start=0&size=20&orderby=nedn&desc=true&fields=nedn' HTTP的示例 GET /rest/openapi/network/slot?nedn=047f72d1-7ad3-11e9-b906-000c29b01448&nename=FW_B&framedn=047f72d1-7ad3-11e9-b906-000c29b01448,FR=1&framename=Eudemon1000E-N6&frameno=1&slotdn=047f72d1-7ad3-11e9-b906-000c29b01448,FR=1,S=1&slotindex=67371017&slotno=1&vendortype=.1.3.6.1.4.1.2011.20021210.12.16719978&descr=--&slotname=2XG8GE&physicalclass=9&adminstatus=4&operstatus=3&standbystatus=1&hardversion=VER.A&firmversion=221 Nov 28 2017 17:23:17&softversion=V500R001C80SPC100&serialnum=210235G7FW0123456789&mfgname=Huawei&modelname=huawei&alarmlight=huawei&start=0&size=20&orderby=nedn&desc=true&fields=nedn HTTP/1.1 Host: 192.168.1.125:18002 Content-Type: application/json Accept: application/json Accept-Language: en-US X-ACCESS-TOKEN: x-rwld6ng9vy2rg96llg85sbdisbmrfw1gdfamaoepoahcaq2nliams8s8epapiofx2r5druhi5g7wmmjzc5btftlduo7w88bybuqp7xmlup9htd5gpg4bmmrufvnt4aan
  • 响应参数 返回状态码为200:单板资源查询成功。 表2 SlotResResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 code int32 - 0 操作返回码。可以是如下值之一: 0:成功 非0:失败 0 data ARRAY_REFERENCE 详细请参见表3。 - - description string - - 描述信息。 Operation success 表3 SlotResData对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 nedn string - - 设备dn。 "047f72d1-7ad3-11e9-b906-000c29b01448" neName string - - 设备名称。 "FW_B" framedn string - - 机框dn。 "047f72d1-7ad3-11e9-b906-000c29b01448,FR=1" framename string - - 机框名称。 "Eudemon1000E-N6" frameno integer - - 机框序号。 1 slotdn string - - 单板dn。 "047f72d1-7ad3-11e9-b906-000c29b01448,FR=1,S=1" slotindex integer - - 单板索引。 67371017 slotno integer - - 单板序号。 1 vendortype string - - 厂商类型。 ".1.3.6.1.4.1.2011.20021210.12.16719978" descr string - - 单板描述。 "--" slotname string - - 单板名称。 "2XG8GE" physicalclass integer - - 设备上实体大类型: 3:框 4:背板 5:子槽 6:电源 7:风扇 9:板 10:端口 9 adminstatus integer - - 管理状态: 4、11:正常 2、3、12:错误 13:LoopBack 其他:未知 4 operstatus integer - - 操作状态: 3、11、13、15、16:正常 2、12、17:错误 4:离线 其他:未知 3 standbystatus integer - - 主备状态: 1:notSupported 2:hotStandby 3:coldStandby 4:providingService 1 hardversion string - - 硬件版本。 "VER.A" firmversion string - - 固件版本。 "221 Nov 28 2017 17:23:17" softversion string - - 软件版本。 "V500R001C80SPC100" serialnum string - - 序列号。 "210235G7FW0123456789" mfgname string - - 组件名称。 "Huawei" modelname string - - 模块名称。 "huawei" alarmlight string - - 预留字段,当前无意义。 "huawei" 返回状态码为400:参数错误。 详细信息请参见实际响应消息体。 返回状态码为404:rest接口没找到。 详细信息请参见实际响应消息体。 返回状态码为500:默认ServiceException异常码,应用内部错误。 详细信息请参见实际响应消息体。
  • URI /rest/openapi/network/slot 表1 query参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 nedn 否 string 1~100个字符。 - 设备DN。 "047f72d1-7ad3-11e9-b906-000c29b01448" nename 否 string 1~100个字符。 - 设备名称。 "FW_B" framedn 否 string 1~100个字符。 - 机框DN。 "047f72d1-7ad3-11e9-b906-000c29b01448,FR=1" framename 否 string 1~100个字符。 - 机框名称。 "Eudemon1000E-N6" frameno 否 integer 满足正则表达^([-+]?\d{1,10})$。 - 机框序号。 1 slotdn 否 string 1~100个字符。 - 单板Dn。 "047f72d1-7ad3-11e9-b906-000c29b01448,FR=1,S=1" slotindex 否 integer 满足正则表达^([-+]?\d{1,10})$。 - 单板索引。 67371017 slotno 否 integer 满足正则表达^([-+]?\d{1,10})$。 - 单板序号。 1 vendortype 否 string 1~100个字符。 - 厂商类型。 ".1.3.6.1.4.1.2011.20021210.12.16719978" descr 否 string 1~100个字符。 - 单板描述。 "--" slotname 否 string 1~100个字符。 - 单板名称。 "2XG8GE" physicalclass 否 integer 满足正则表达^([-+]?\d{1,10})$。 - 设备上实体大类型: 3:框 4:背板 5:子槽 6:电源 7:风扇 9:板 10:端口 9 adminstatus 否 integer 满足正则表达^([-+]?\d{1,10})$。 - 管理状态: 4、11:正常 2、3、12:错误 13:LoopBack 其他:未知 4 operstatus 否 integer 满足正则表达^([-+]?\d{1,10})$。 - 操作状态: 3、11、13、15、16:正常 2、12、17:错误 4:离线 其他:未知 3 standbystatus 否 integer 满足正则表达^([-+]?\d{1,10})$。 - 主备状态: 1:notSupported 2: hotStandby 3:coldStandby 4:providingService 1 hardversion 否 string 1~100个字符。 - 硬件版本。 "VER.A" firmversion 否 string 1~100个字符。 - 固件版本。 "221 Nov 28 2017 17:23:17" softversion 否 string 1~100个字符。 - 软件版本。 "V500R001C80SPC100" serialnum 否 string 1~100个字符。 - 序列号。 "210235G7FW0123456789" mfgname 否 string 1~100个字符。 - 组件名称。 "Huawei" modelname 否 string 1~100个字符。 - 模块名称。 "huawei" alarmlight 否 string 1~100个字符。 - 预留字段,当前无意义。 "huawei" start 否 integer - 0 指定从哪个起始记录位置开始返回查询结果集。缺省值是0。说明: 如果值小于0,将使用缺省值。 0 size 否 integer - 20 指定返回查询结果集总数。缺省值是20。说明: 1、如果值小于0,将使用缺省值。2、数据的size,最大建议10000条。 20 orderby 否 string - nedn 指定查询结果集采用的排序字段。缺省排序字段是nedn。可指定的排序字段包括:nedn、nename、framedn、framename、slotdn说明:指定多个排序字段时字段间用英文半角逗号“,”分隔。 "nedn" desc 否 boolean - false 指定查询结果是否按降序排序。缺省值是false。说明: 此请求参数只有指定了“orderby”请求参数后才有效。 true fields 否 string - - 指定查询结果所包含的列。需要查询的列名为fields参数的值,多个列名时可用英文逗号隔开。说明:此请求参数只有指定了“fields”请求参数后才有效,不指定默认返回所有字段。 "nedn"
  • 响应示例 返回状态码为200:机框资源查询成功。 HTTP/1.1 200 OK Date: Tue,30 Oct 2018 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive { "code" : 0, "data" : [ { "neDN" : "047f72d1-7ad3-11e9-b906-000c29b01448", "neName" : "FW_B", "frameDN" : "047f72d1-7ad3-11e9-b906-000c29b01448,FR=1", "shelfIndex" : -1, "frameIndex" : 67108867, "frameNo" : 1, "vendorType" : ".1.3.6.1.4.1.2011.20021210.11.16715812", "mfgName" : "Huawei", "serialNum" : "020LKTD0A9000233", "physicalClass" : 3, "descr" : "Eudemon1000E-N6", "frameName" : "Eudemon1000E-N6", "adminStatus" : 4, "operStatus" : 3, "standBystatus" : 1, "softVersion" : "V500R001C80SPC100" } ], "description" : "查询成功。" } 返回状态码为400:参数错误。 HTTP/1.1 400 Bad Request Date: Tue,30 Oct 2018 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive 返回状态码为404:rest接口没找到。 HTTP/1.1 404 Not Found Date: Tue,30 Oct 2018 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive 返回状态码为500:默认ServiceException异常码,应用内部错误。 HTTP/1.1 500 Internal Server Error Date: Tue,30 Oct 2018 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive
  • 请求示例 cURL的示例 curl -k -s -L -i -X GET -H 'Content-Type: application/json' -H 'Accept: application/json' -H 'Accept-Language: en-US' -H 'X-ACCESS-TOKEN: x-rwld6ng9vy2rg96llg85sbdisbmrfw1gdfamaoepoahcaq2nliams8s8epapiofx2r5druhi5g7wmmjzc5btftlduo7w88bybuqp7xmlup9htd5gpg4bmmrufvnt4aan' 'https://192.168.1.125:18002/rest/openapi/network/frame?nedn=047f72d1-7ad3-11e9-b906-000c29b01448&nename=FW_B&framedn=047f72d1-7ad3-11e9-b906-000c29b01448,FR=1&shelfindex=-1&frameindex=67108867&frameno=1&vendortype=.1.3.6.1.4.1.2011.20021210.11.16715812&mfgname=Huawei&serialnum=020LKTD0A9000233&physicalclass=3&descr=Eudemon1000E-N6&framename=Eudemon1000E-N6&adminstatus=4&operstatus=3&standbystatus=1&softversion=V500R001C80SPC100&start=0&size=20&orderby=nedn&desc=true' HTTP的示例 GET /rest/openapi/network/frame?nedn=047f72d1-7ad3-11e9-b906-000c29b01448&nename=FW_B&framedn=047f72d1-7ad3-11e9-b906-000c29b01448,FR=1&shelfindex=-1&frameindex=67108867&frameno=1&vendortype=.1.3.6.1.4.1.2011.20021210.11.16715812&mfgname=Huawei&serialnum=020LKTD0A9000233&physicalclass=3&descr=Eudemon1000E-N6&framename=Eudemon1000E-N6&adminstatus=4&operstatus=3&standbystatus=1&softversion=V500R001C80SPC100&start=0&size=20&orderby=nedn&desc=true HTTP/1.1 Host: 192.168.1.125:18002 Content-Type: application/json Accept: application/json Accept-Language: en-US X-ACCESS-TOKEN: x-rwld6ng9vy2rg96llg85sbdisbmrfw1gdfamaoepoahcaq2nliams8s8epapiofx2r5druhi5g7wmmjzc5btftlduo7w88bybuqp7xmlup9htd5gpg4bmmrufvnt4aan
  • 响应参数 返回状态码为200:机框资源查询成功。 表2 FrameResResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 code int32 - 0 操作返回码。可以是如下值之一: 0:成功 非0:失败 0 data ARRAY_REFERENCE 详细请参见表3。 - - description string - - 描述信息。 "查询成功。" 表3 FrameResData对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 neDN string - - 设备dn。 "047f72d1-7ad3-11e9-b906-000c29b01448" neName string - - 网元名称。 "FW_B" frameDN string - - 机框dn。 "047f72d1-7ad3-11e9-b906-000c29b01448,FR=1" shelfIndex int32 - - 机架索引,所有资源的根索引。 -1 frameIndex int32 - - 机框索引。 67108867 frameNo int32 - - 机框序号。 1 vendorType string - - 厂商类型。 ".1.3.6.1.4.1.2011.20021210.11.16715812" mfgName string - - 物理固件的制造厂商。 "Huawei" serialNum string - - 序列号。 "020LKTD0A9000233" physicalClass int32 - - 设备上实体大类型: 3:框 4:背板 5:子槽 6:电源 7:风扇 9:板 10:端口 3 descr string - - 机框描述。 "Eudemon1000E-N6" frameName string - - 机框名称。 "Eudemon1000E-N6" adminStatus int32 - - 管理状态,可以是如下值之一: 4、11:正常 2、3、12:错误 13:LoopBack 其他:未知 4 operStatus int32 - - 操作状态,可以是如下值之一: 3、11、13、15、16:正常 2、12、17:错误 4:离线 其他:未知 3 standBystatus int32 - - 主备状态: 1:notSupported 2:hotStandby 3:coldStandby 4:providingService 1 softVersion string - - 软件版本。 "V500R001C80SPC100" 返回状态码为400:参数错误。 详细信息请参见实际响应消息体。 返回状态码为404:rest接口没找到。 详细信息请参见实际响应消息体。 返回状态码为500:默认ServiceException异常码,应用内部错误。 详细信息请参见实际响应消息体。