接口管理北向API接口-华为云

华为乾坤-条件查询接口资源（兼容历史版本）:响应示例

响应示例返回状态码为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 { "error_code" : "0", "error_msg" : "Successful", "totalCount" : 1, "nextmarker" : "", "ApiIfDataList" : [ { "nedn" : "e46412b1-003a-385c-bd10-6c218ce09ef4", "interfaceId" : "4451b04d-64b7-4d5a-aadc-637387068d57", "ifIndex" : "668", "ifDesc" : "XGigabitEthernet1/8/0/0", "ifAlias" : "Link to remote", "ipAddress" : "10.136.10.66/24", "ifOperStatus" : "UP", "ifAdminStatus" : "DOWN", "ifSpeed" : "20G", "ifMtu" : "1500", "ifDuplexMode" : "FULL", "ifType" : "ETHERNET", "ifMAC" : "**-**-**-**-7E-9F" } ] }

华为乾坤接口管理北向API接口

华为乾坤-条件查询接口资源（兼容历史版本）:请求示例

请求示例 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-5hfumrpevvir04ph3vemg7rv3ynxdgumrwjvnyhh04k5gbnv9cums76mthpd2qek9f9ifw44juqns9dfti04oafz85upmm1hhitchj6o6neoalrx2r1e1dmqk8de7vnv' -G --data-urlencode 'condition={"neDn": "e46412b1-003a-385c-bd10-6c218ce09ef4","ifDesc": "XGigabitEthernet","ifSpee":["20000000000"],"sortColumn":"IFINDEX","sortOrder":"ifDesc"}' 'https://192.168.1.125:18002/rest/openapi/networkinventoryservice/v1/interfaces' HTTP的示例 GET /rest/openapi/networkinventoryservice/v1/interfaces?condition=%7B%22neDn%22%3A%20%22e46412b1-003a-385c-bd10-6c218ce09ef4%22,%22ifDesc%22%3A%20%22XGigabitEthernet%22,%22ifSpee%22%3A%5B%2220000000000%22%5D,%22sortColumn%22%3A%22IFINDEX%22,%22sortOrder%22%3A%22ifDesc%22%7D 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

华为乾坤接口管理北向API接口

华为乾坤-条件查询接口资源（兼容历史版本）:响应参数

响应参数返回状态码为200：接口信息查询成功表2 ApiIfQueryResponse对象的参数列表参数名称类型参数值域默认值参数说明参数示例 error_code int32 - 0 错误码。 "0" error_msg string - Successful. 错误消息。 "Successful" totalCount int32 - - 符合当前条件的总个数 1 nextmarker string - - 下一片反馈信息 "" ApiIfDataList ARRAY_REFERENCE 详细请参见表3。接口列表 - 表3 ApiIfData对象的参数列表参数名称类型参数值域默认值参数说明参数示例 nedn string 1~255个字符。 - 设备DN "e46412b1-003a-385c-bd10-6c218ce09ef4" interfaceId string 0~255个字符。 - 接口DN，一旦创建无法修改，必填 "4451b04d-64b7-4d5a-aadc-637387068d57" ifIndex integer - - 接口索引，从设备上获取，无法修改 "668" ifDesc string 1~255个字符。 - 接口名称，从设备上获取，无法修改 "XGigabitEthernet1/8/0/0" ifAlias string 0~255个字符。 - 接口别名，从设备上获取，可修改 "Link to remote" ipAddress string 0~255个字符。 - ip地址 "10.136.10.66/24" ifOperStatus string UP DOWN TESTING UNKNOWN DORMANT NOTPRESENT LOWLAYERDOWN - 接口运行态 "UP" ifAdminStatus string UP DOWN PLANNING - 接口管理态, 可修改 "DOWN" ifSpeed string 0~255个字符。 - 接口速率 "20G" ifRemark string 0~255个字符。 - 备注，可修改 - ifMtu string 0~255个字符。 - MTU "1500" ifDuplexMode string FULL HALF AUTO AUTOFULL AUTOHALF - 双工模式 "FULL" ifType string OTHER ETHERNET ETH-TRUNK VIRTUAL_ETHERNET ATM POS SERIAL VLANIF E1 T1 CPOS TUNNEL LOOPBACK IP-TRUNK VIRTUAL-TEMPLATE RING-IF MFR MP-GROUP AUX E3 T3 METH NULL RPR EPON WLAN-ESS GPON WLAN-DBSS WLAN-MESH VBDIF NVE CELLULAR - 接口类型 "ETHERNET" serviceType int32 - - 接口成员口类型 - providerNetwork string 0~255个字符。 - 供应商 - ifGroup string 0~255个字符。 - 所属分组 - ifMAC string 0~48个字符。 - MAC地址 "**-**-**-**-7E-9F"

华为乾坤接口管理北向API接口

华为乾坤-条件查询接口资源（兼容历史版本）:URI

URI /rest/openapi/networkinventoryservice/v1/interfaces 表1 query参数列表参数名称必选类型参数值域默认值参数说明参数示例 condition 是 string - - 必需字段： 01. neDn：网络设备dn，精确搜索。其他为非必需字段： 02. pageBegin：起始行数，正整数。 03. pageLength：10, 20, 50, 100, 500其中之一,默认500; 04. ifIndex：根据接口索引精确查询的关键字； 05. ifDesc：根据接口名称模糊查询的关键字； 06. ifAlias：根据接口别名模糊查询的关键字； 07. ipAddress：根据接口IP地址模糊查询的关键字； 08. ifSpeed：根据接口速率精确筛选的关键字； List，纯数字集合举例:"ifSpeed":["20000000000"] 09. ifRemark：根据接口备注模糊查询的关键字； 10. ifMtu：根据接口mtu精确筛选的关键字； 11. ifType：根据接口type精确筛选的关键字； List, 支持Ethernet,Eth-Trunk,Virtual-Ethernet,Atm,Pos,Serial,Vlanif,E1,T1,Cpos,Tunnel,LoopBack,Ip-Trunk,Virtual-Template,Ring-if,MFR,Mp-group,Aux,E3,T3,MEth,NULL,Rpr,Epon,Wlan-Ess,Gpon,Wlan-Dbss,Wlan-Mesh,Vbdif,Nve,Cellular,Other 举例:"ifType":["Ethernet","Eth-Trunk"] 12. ifOperStatus：List,根据接口运行态精确筛选的关键字； List,支持Up,Down,Testing,Unknown,Dormant,Notpresent,Lowlayerdown 举例:"ifOperStatus":["Up","Down"] 13. ifAdminStatus：根据接口管理态精确筛选的关键字； List,支持Up,Down,Planning 举例:"ifAdminStatus":["Up","Down"] 14. ifDuplexMode：根据接口双工模式精确筛选的关键字；List,支持full,half,auto,autoFull,autoHalf 15. queryType：指定查询的接口类型, 5仅查询物理口； 16. sortColumn：指定查询结果排序列;支持IFINDEX,IPADDRESS,IFDESC,IFALIAS,IFREMARK,IFPHYSADDRESS 17. sortOrder：指定查询结果排序;支持asc,desc "{\"neDn\": \"e46412b1-003a-385c-bd10-6c218ce09ef4\",\"IfDesc\": \"XGigabitEthernet\",\"ifSpee\":[\"20000000000\"],\"sortColumn\":\"IFINDEX\",\"sortOrder\":\"desc\"}"

华为乾坤接口管理北向API接口

华为乾坤-条件查询接口资源（仅乾坤云使用）:响应示例

响应示例返回状态码为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 { "error_code" : "0", "error_msg" : "Successful", "totalCount" : 1, "nextmarker" : "", "ApiIfDataList" : [ { "nedn" : "e46412b1-003a-385c-bd10-6c218ce09ef4", "interfaceId" : "4451b04d-64b7-4d5a-aadc-637387068d57", "ifIndex" : "668", "ifDesc" : "XGigabitEthernet1/8/0/0", "ifAlias" : "Link to remote", "ipAddress" : "10.136.10.66/24", "ifOperStatus" : "UP", "ifAdminStatus" : "DOWN", "ifSpeed" : "20G", "ifMtu" : "1500", "ifDuplexMode" : "FULL", "ifType" : "ETHERNET", "serviceType": 0, "providerNetwork": Huawei, "ifGroup": "1", "ifMAC" : "**-**-**-**-7E-9F" } ] }

华为乾坤接口管理北向API接口

华为乾坤-条件查询接口资源（仅乾坤云使用）:响应参数

响应参数返回状态码为200：接口信息查询成功表2 ApiIfQueryResponse对象的参数列表参数名称类型参数值域默认值参数说明参数示例 error_code int32 - 0 错误码。 "0" error_msg string 0-255个字符 Successful. 错误消息。 "Successful" totalCount int32 - - 符合当前条件的总个数 1 nextmarker string 0-255个字符 - 下一片反馈信息 "" ApiIfDataList ARRAY_REFERENCE 详细请参见表3。接口列表 - 表3 ApiIfData对象的参数列表参数名称类型参数值域默认值参数说明参数示例 nedn string 1~255个字符。 - 设备DN "e46412b1-003a-385c-bd10-6c218ce09ef4" interfaceId string 0~255个字符。 - 接口DN，一旦创建无法修改，必填 "4451b04d-64b7-4d5a-aadc-637387068d57" ifIndex integer - - 接口索引，从设备上获取，无法修改 "668" ifDesc string 1~255个字符。 - 接口名称，从设备上获取，无法修改 "XGigabitEthernet1/8/0/0" ifAlias string 0~255个字符。 - 接口别名，从设备上获取，可修改 "Link to remote" ipAddress string 0~255个字符。 - ip地址 "10.136.10.66/24" ifOperStatus string UP DOWN TESTING UNKNOWN DORMANT NOTPRESENT LOWLAYERDOWN - 接口运行态 "UP" ifAdminStatus string UP DOWN PLANNING - 接口管理态, 可修改 "DOWN" ifSpeed string 0~255个字符。 - 接口速率 "20G" ifRemark string 0~255个字符。 - 备注，可修改 "接口备注" ifMtu string 0~255个字符。 - MTU "1500" ifDuplexMode string FULL HALF AUTO AUTOFULL AUTOHALF - 双工模式 "FULL" ifType string OTHER ETHERNET ETH-TRUNK VIRTUAL_ETHERNET ATM POS SERIAL VLANIF E1 T1 CPOS TUNNEL LOOPBACK IP-TRUNK VIRTUAL-TEMPLATE RING-IF MFR MP-GROUP AUX E3 T3 METH NULL RPR EPON WLAN-ESS GPON WLAN-DBSS WLAN-MESH VBDIF NVE CELLULAR - 接口类型 "ETHERNET" serviceType int32 - - 接口成员口类型 0 providerNetwork string 0~255个字符。 - 供应商 Huawei ifGroup string 0~255个字符。 - 所属分组 1 ifMAC string 0~48个字符。 - MAC地址 "**-**-**-**-7E-9F"

华为乾坤接口管理北向API接口

华为乾坤-条件查询接口资源（仅乾坤云使用）:请求示例

请求示例 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-5hfumrpevvir04ph3vemg7rv3ynxdgumrwjvnyhh04k5gbnv9cums76mthpd2qek9f9ifw44juqns9dfti04oafz85upmm1hhitchj6o6neoalrx2r1e1dmqk8de7vnv' -G --data-urlencode 'condition={"neDn": "e46412b1-003a-385c-bd10-6c218ce09ef4","ifDesc": "XGigabitEthernet","ifSpee":["20000000000"],"sortColumn":"IFINDEX","sortOrder":"ifDesc"}' 'https://192.168.1.125:32102/rest/openapi/networkinventoryservice/v1/interfaces' HTTP的示例 GET /rest/openapi/networkinventoryservice/v1/interfaces?condition=%7B%22neDn%22%3A%20%22e46412b1-003a-385c-bd10-6c218ce09ef4%22,%22ifDesc%22%3A%20%22XGigabitEthernet%22,%22ifSpee%22%3A%5B%2220000000000%22%5D,%22sortColumn%22%3A%22IFINDEX%22,%22sortOrder%22%3A%22ifDesc%22%7D 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

华为乾坤接口管理北向API接口

华为乾坤-条件查询接口资源（仅乾坤云使用）:URI

URI /rest/openapi/networkinventoryservice/v3/interfaces 表1 query参数列表参数名称必选类型参数值域默认值参数说明参数示例 condition 是 string 0-500个字符 - 必需字段： 01. neDn：网络设备dn，精确搜索。其他为非必需字段： 02. pageBegin：起始行数，正整数。 03. pageLength：10, 20, 50, 100, 500其中之一,默认500; 04. ifIndex：根据接口索引精确查询的关键字； 05. ifDesc：根据接口名称模糊查询的关键字； 06. ifAlias：根据接口别名模糊查询的关键字； 07. ipAddress：根据接口IP地址模糊查询的关键字； 08. ifSpeed：根据接口速率精确筛选的关键字； List，纯数字集合举例:"ifSpeed":["20000000000"] 09. ifRemark：根据接口备注模糊查询的关键字； 10. ifMtu：根据接口mtu精确筛选的关键字； 11. ifType：根据接口type精确筛选的关键字； List, 支持Ethernet,Eth-Trunk,Virtual-Ethernet,Atm,Pos,Serial,Vlanif,E1,T1,Cpos,Tunnel,LoopBack,Ip-Trunk,Virtual-Template,Ring-if,MFR,Mp-group,Aux,E3,T3,MEth,NULL,Rpr,Epon,Wlan-Ess,Gpon,Wlan-Dbss,Wlan-Mesh,Vbdif,Nve,Cellular,Other 举例:"ifType":["Ethernet","Eth-Trunk"] 12. ifOperStatus：List,根据接口运行态精确筛选的关键字； List,支持Up,Down,Testing,Unknown,Dormant,Notpresent,Lowlayerdown 举例:"ifOperStatus":["Up","Down"] 13. ifAdminStatus：根据接口管理态精确筛选的关键字； List,支持Up,Down,Planning 举例:"ifAdminStatus":["Up","Down"] 14. ifDuplexMode：根据接口双工模式精确筛选的关键字；List,支持full,half,auto,autoFull,autoHalf 15. queryType：指定查询的接口类型, 5仅查询物理口； 16. sortColumn：指定查询结果排序列;支持IFINDEX,IPADDRESS,IFDESC,IFALIAS,IFREMARK,IFPHYSADDRESS 17. sortOrder：指定查询结果排序;支持asc,desc "{\"neDn\": \"e46412b1-003a-385c-bd10-6c218ce09ef4\",\"IfDesc\": \"XGigabitEthernet\",\"ifSpee\":[\"20000000000\"],\"sortColumn\":\"IFINDEX\",\"sortOrder\":\"desc\"}"

华为乾坤接口管理北向API接口

华为乾坤-查询接口同步任务进度:响应示例

响应示例返回状态码为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 { "error_code": 0, "error_msg": "Successful.", "syncResult": "SUCCESS", "syncDetails": [ { "itemName": "ipaddress", "itemProgress": "SUCCESS" }, { "itemName": "interface", "itemProgress": "SUCCESS" }, { "itemName": "trunkif", "itemProgress": "SUCCESS" } ] }

华为乾坤接口管理北向API接口

华为乾坤-查询接口同步任务进度:响应参数

响应参数返回状态码为200：任务进展表2 ApiIfSyncProgressResponse对象的参数列表参数名称类型参数值域默认值参数说明参数示例 error_code int32 - 0 错误码。 - error_msg string - Successful. 错误消息。 - syncResult string WAITING SYNCING PARSING SUCCESS FAILURE PARTLYSUCCESS DUPLICATETASK REACHLIMIT NENOTEXIST NEUNMANAGED NEOFFLINE FULLTASKRUNNING NECANNOTSYNCING TASKNOTEXIST PROTOCOLERROR - 同步的整体结果 - syncDetails ARRAY_REFERENCE 详细请参见表3。特性同步结果 - 表3 ApiIfItemResult对象的参数列表参数名称类型参数值域默认值参数说明参数示例 itemName string - - 特性名称 - itemProgress string WAITING SYNCING PARSING SUCCESS FAILURE - 特性同步结果 -

华为乾坤接口管理北向API接口

华为乾坤-查询接口同步任务进度:URI

URI /rest/openapi/networkinventoryservice/v1/interfaces/sync-task/action 表1 query参数列表参数名称必选类型参数值域默认值参数说明参数示例 id 是 string 1~36个字符。满足正则表达[a-zA-Z0-9_@\\-]{1,36}。 - 任务ID "00000000-0000-0000-0000-000000000000"

华为乾坤接口管理北向API接口

华为乾坤-查询接口同步任务进度:请求示例

请求示例 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/networkinventoryservice/v1/interfaces/sync-task/action?id=00000000-0000-0000-0000-000000000000' HTTP的示例 GET /rest/openapi/networkinventoryservice/v1/interfaces/sync-task/action?id=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-rwld6ng9vy2rg96llg85sbdisbmrfw1gdfamaoepoahcaq2nliams8s8epapiofx2r5druhi5g7wmmjzc5btftlduo7w88bybuqp7xmlup9htd5gpg4bmmrufvnt4aan

华为乾坤接口管理北向API接口

华为乾坤-修改接口描述信息:请求示例

请求示例 cURL的示例 curl -k -s -L -i -X PUT -H 'Content-Type: application/json' -H 'Accept: application/json' -H 'Accept-Language: en-US' -H 'X-ACCESS-TOKEN: x-mk5ciqtg7yg9qrqlvt09fubsgb45gbburt8aupqko4ulap7x87jtfwo6cbeo8agbgbqo6lvvvzuqtf9cvugak42pqphd2ptj3vsa3xhevzo76ks9piermrlddhurrtfv' 'https://192.168.1.125:18002/rest/openapi/networkinventoryservice/v1/interfaces/modify-tasks/action' -d '{ "nedn":"827714c8-8898-3f00-b7f3-77a489e6a3bc", "ifDesc":"100GE1/0/1", "ifAlias":"test" }' HTTP的示例 PUT /rest/openapi/networkinventoryservice/v1/interfaces/modify-tasks/action HTTP/1.1 Host: 192.168.1.125:18002 Content-Type: application/json Accept: application/json Accept-Language: en-US X-ACCESS-TOKEN: x-mk5ciqtg7yg9qrqlvt09fubsgb45gbburt8aupqko4ulap7x87jtfwo6cbeo8agbgbqo6lvvvzuqtf9cvugak42pqphd2ptj3vsa3xhevzo76ks9piermrlddhurrtfv { "nedn":"827714c8-8898-3f00-b7f3-77a489e6a3bc", "ifDesc":"100GE1/0/1", "ifAlias":"test" }

华为乾坤接口管理北向API接口

华为乾坤-修改接口描述信息:请求参数

请求参数表1 body参数列表参数名称必选类型参数值域默认值参数说明参数示例 modifyIfBody 是 REFERENCE 详细请参见表2。设备接口描述信息修改参数模型 - 表2 ApiModifyIfData对象的参数列表参数名称必选类型参数值域默认值参数说明参数示例 nedn 是 string 0~255个字符。 - 设备dn。说明：添加设备时分配的唯一标识 "00000000-0000-0000-0000-000000000000" interfaceId 否 string 1~255个字符。 - 接口id。说明：接口添加时分配的唯一标识。 "00000000-0000-0000-0000-000000000000" ifIndex 否 integer [1-65535] - 接口索引。说明：从设备上获取。 7 ifDesc 是 string 1~255个字符。 - 接口名称。说明：从设备上获取。 GigabitEthernet1/0/1 ifAlias 是 string 1~242个字符。 - 接口别名。说明：从设备上获取，可修改。如果设备不支持特殊字符和中文，接口返回错误码-3，错误信息为“snmp-error-set-10”。 "aaa"

华为乾坤接口管理北向API接口

华为乾坤-同步设备接口资源:URI

URI /rest/openapi/networkinventoryservice/v1/interfaces/sync-task/action 表1 query参数列表参数名称必选类型参数值域默认值参数说明参数示例 nedn 是 string 1~36个字符。满足正则表达[a-zA-Z0-9_@\\-]{1,36}。 - 设备id "00000000-0000-0000-0000-000000000000"

华为乾坤接口管理北向API接口

云服务器内容精选

接口管理北向API接口

7*24

备案

专业服务

退订

建议反馈

售前咨询热线