Onvif功能接口.docx

Onvif功能接口.docx

《Onvif功能接口.docx》由会员分享，可在线阅读，更多相关《Onvif功能接口.docx（183页珍藏版）》请在冰豆网上搜索。

Onvif功能接口

Onvif功能接口

1设备管理

1.1功能

1.1.1获取WSDL的URL

表1：

GetWSDLURL命令

GetWsdlUrl

请求与应答

信息名称

相应功能及参数描述

GetWsdlUrlRequest

请求信息中不含有任何信息

GetWsdlUrlResponse

应答信息包含请求的URL

xs:

anyURIWsdlUrl[1][1]

错误代码

原因分析

没有与命令相关的错误代码

1.1.2交换的功能

表2：

GetCapabilities命令

GetCapabilities

请求与应答

信息名称

信息容以及功能

GetCapabilitiesRequest

请求信息包含对设备功能查询的请求。

客户端既可以查询设备拥有的所有功能或者仅仅其中具体一种服务的功能。

如果没有指定要查询的类别，那设备就会在应答信息中包含设备所有功能。

tt:

CapabilityCategoryCategory[0][unbounded

GetCapabilitiesResponse

在应答的信息中包含一个采用XML分层能力结构体，用这个结构体来表示要查询设备功能

tt:

CapabilitiesCapabilities[1][1]

错误代码

原因分析

env:

Receiver

ter:

ActionNotSupported

ter:

NoSuchService

设备不支持请求信息提到的WSDL服务类别

1.2网络

1.2.1交换的功能

表3：

GetHostname指令

GetHostname

请求与应答

信息名称

相应功能以及参数描述

GetHostnameRequest

请求信息不带任何参数

GetHostnameResponse

应答信息包括：

“FromDHCP”：

如果主机名是通过DHCP（动态主机分配协议）获得

“NAME”：

主机名。

在DHCP的主机名的情况下,主机名是通过从DHCP服务获得

xs:

booleanFromDHCP[1][1]

xs:

tokenName[0][1]

错误代码

原因分析

没有与此命令相关错误代码

1.2.2设置主机名

表4：

SetHostname指令

SetHostname

请求与应答

信息名称

相应功能及参数描述

SetHostnameRequest

请求信息包含：

“Name”：

将要设置的主机名称

xs：

tokenName[1][1]

SetHostnameResponse

应答信息中不包含任何容

错误代码

原因分析

env:

Sender

ter:

InvalidArgVal

ter:

InvalidHostname

设备不能接受请求信息中设定的主机名

1.2.3获取DNS配置

表5：

GetDNS命令

GetDNS

请求与应答

信息名称

相应功能以及参数描述

GetDNSRequest

请求信息中不包含任何参数

GetDNSResponse

应答信息包含：

1.“FromDHCP”：

如果是通过DHCP获得的DNS服务器。

2.“SearchDomain”：

如果主机名没资格，进行域搜索.

3.“DNSFromDHCP”：

如果能够通过“FromDHCP来获取DNS，”DNS”服务清单也通过“FromDHCP”来获取：

这意味着：

在DNSFromDHCP领域的解析地址是来源于DHCP以及配置状态描述

4．“DNSManual”手动给定的DNS服务器列表

xs:

booleanFromDHCP[1][1]

xs:

tokenSearchDomain[0][unbounded]

tt:

IPAddressDNSFromDHCP[0][unbounded]

tt:

IPAddressDNSManual[0][unbounded]

错误代码

原因分析

没有与此命令相关的错误代码

1.2.4设置DNS

表6:

SetDNS命令

SetDNS

请求与应答

信息名称

相应功能以及参数描述

SetDNSRequest

请求信息包括：

1.“FromDHCP”：

如果是通过DHCP能够获得的DNS服务2.“SearchDomain”：

如果hostname是不完整，进行域搜索。

3.“DNSManual”：

手动DNS服务器列表

xs:

booleanFromDHCP[1][1]

xs:

tokenSearchDomain[0][unbounded]

tt:

IPAddressDNSManual[0][unbounded]

SetDNSResponse

应答信息不包含任何信息

错误编码

原因分析

env:

Sender

ter:

InvalidArgVal

ter:

InvalidIPv6Address

建议的IPv6地址是无效的。

env:

Sender

ter:

InvalidArgVal

ter:

InvalidIPv4Address

建议的IPv4地址是无效的

1.2.5获取NTP配置信息

表7：

GetNTP指令

GetNTP

请求与应答

信息名称

相应功能以及参数描述

GetNTPRequest

请求信息不含有任何参数

GetNTPResponse

应答信息包括：

1.“FromDHCP”：

如果能通过DHCP获得NTP服务。

2.“NTPFromDHCP”：

如果通过“FromDHCP来获取NTP，”NTP”服务清单也通过“FromDHCP”来获取；这意味着：

在NTPFromDHCP领域的地址解决是来源于DHCP以及配置状态描述

3.“NTPManual”：

手动给NTP服务器列表。

xs:

booleanFromDHCP[1][1]

tt:

NetworkHostNTPFromDHCP[0][unbounded]

tt:

NetworkHostNTPManual[0][unbounded]

可能的错误

原因分析

没有与此命令相关的错误

1.2.6对设备设置NTP

表8:

SetNTP指令

SetNTP

请求与应答

信息名称

相应功能以及参数描述

SetNTPRequest

请求信息包含：

1.“FromDHCP”：

如果通过DHCP获得NTP服务。

2.“NTPManual”：

当没能通过DHCP获取NTP服务，手动创建的NTP服务器列表。

xs:

booleanFromDHCP[1][1]

tt:

NetworkHostNTPManual[0][unbounded

SetNTPResponse

应答信息是一条空信息，

错误代码

原因分析

env:

Sender

ter:

InvalidArgVal

ter:

InvalidIPv4Address

建议的IPv4地址是无效的

env:

Sender

ter:

InvalidArgVal

ter:

InvalidIPv6Address

建议的IPv4地址是无效的

env:

Sender

ter:

InvalidArgVal

ter:

InvalidDnsName

建议的NTP服务名是无效的

1.2.7获取动态的DNS设置

表9：

GetDynamicDNS指令

GetDynamicDNS

请求与响应

信息名称

相应功能以及参数描述

GetDynamicDNSRequest

请求信息不包含任何参数

GetDynamicDNSResponse

应答信息包含：

1.“Type”：

更新类型。

可能有三种类型：

1设备的本身没有更新（NOUPDATE）；2.DHCP服务器更新（ServerUpdates）；3.设备更新（ClientUpdates）。

2.“Name”:

：

在设备未有更新的情况下，DNS名称。

3.“TTL”：

生存时间。

tt:

DynamicDNSTypeType[1][1]

tt:

DNSNameName[0][1]

xs:

durationTTL[0][1]

错误代码

原因分析

没有与这类命令相关的错误代码

1.2.8设置设备动态DNS

表10：

SetDynamicDNS指令

SetDynamicDNS

请求与应答

信息名称

相应功能以及参数描述

SetDynamicDNSRequest

请求信息包含：

1.“Type”：

更新类型。

有三种类型：

1设备的期望没有更新（NOUPDATE）2设备需要DHCP服务器更新（ServerUpdates）3设备更新本（ClientUpdates）。

2.“Name”：

在设备更新情况下，DNS名称。

3.“TTL”：

生存时间。

tt:

DynamicDNSTypeType[1][1]

tt:

DNSNameName[0][1]

xs:

durationTTL[0][1]

SetDynamicDNSResponse

应答信息不包含任何信息

错误代码

原因分析

没有与这类命令相关的错误代码

1.2.9获取网络接口配置

表11：

GetNetworkInterfaces指令

GetNetworkInterfaces

请求与应答

信息名称

相应功能以及参数描述

GetNetworkInterfacesRequest

请求信息是一条空信息

GetNetworkInterfacesResponse

应答信号包含一个设备的网络接口的矩阵

tt:

NetworkInterfaceNetworkInterfaces[0][unbounded]

错误代码

原因分析

没有与此命令相关错误代码

1.2.10设置网络接口配置

表12：

SetNetworkInterfaces命令

SetNetworkInterfaces

请求与应答

信息名称

相应功能以及参数描述

SetNetworkInterfacesRequest

请求信息包括：

“InterfaceToken”：

要打开的网络令牌接口。

“NetworkInterface”：

需要配置网络接口。

tt:

ReferenceTokenInterfaceToken[1][1]

tt:

NetworkInterfaceSetConfigurationNetworkInterface[1][1]

SetNetworkInterfacesResponse

应答信息包括：

“RebootNeeded”：

表明：

当网络的配置改变，需要进行从新启动

xs:

booleanRebootNeeded[1][1]

错误代码

原因分析

env:

Sender

ter:

InvalidArgVal

ter:

InvalidNetworkInterface

提供的网络接口令牌不存在

env:

Sender

ter:

InvalidArgVal

ter:

InvalidMtuValue

MTU值是无效的

env:

Sender

ter:

InvalidArgVal

ter:

InvalidInterfaceSpeed

不支持建议的速度

env:

Sender

ter:

InvalidArgVal

ter:

InvalidInterfaceT

不支持建议的网络接口类型

env:

Sender

ter:

InvalidArgVal

ter:

InvalidIPv4Address

建议的IPV4地址是无效的

env:

Sender

ter:

InvalidArgVal

ter:

InvalidIPv6Address

建议的IPV6地址是无效的

env:

Receiver

ter:

ActionNotSupported

ter:

InvalidDot11

不支持IEEE802.11配置

env:

Sender

ter:

InvalidArgVal

ter:

InvalidSecurityMode

不支持选用的安全模式

env:

Senderter:

InvalidArgVal

ter:

InvalidStationMode

不支持选择的站模式

env:

Sender

ter:

InvalidArgVal

ter:

MissingDot11

在安全配置中IEEE802.11的值丢失或者不存在

env:

Sender

ter:

InvalidArgVal

ter:

MissingPSK

在安全配置中PSK值丢失

env:

Sender

ter:

InvalidArgVal

ter:

MissingDot1X

在安全配置中IEEE802.1X值丢失或者根本就不存在

env:

Sender

ter:

InvalidArgVal

ter:

IncompatibleDot1X

在网络接口安全配置中IEEE802.1X值与网络接口不兼容

1.2.11获取网络协议

表13：

GetNetworkProtocols命令

GetNetworkProtocols

请求与应答

信息名称

相应功能以及参数描述

GetNetworkProtocolsRequest

请求信息是一条空信息

GetNetworkProtocolsResponse

应答消息返回一个设备支持协议的矩阵。

有三个已定义的协议，HTTP，HTTPS和RTSP。

对于每个协议，可以检索以下参数：

PortEnable/disable

tt:

NetworkProtocolNetworkProtocols[0][unbounded]

错误代码

原因分析

没有与这类命令相关的错误

1.2.12设置网络协议

表14：

SetNetworkProtocols命令

SetNetworkProtocols

请求与应答

信息名称

相应功能及参数描述

SetNetworkProtocolsReques

请求信息能够配置一个或者多个设备支持的网络协议。

就目前存在三个已定义的信息：

HTTP,HTTPS,RTSP；下面分别是对每个协议需要设定的参数：

PortEnable/disable

tt:

NetworkProtocolNetworkProtocols[1][unbounde]

SetNetworkProtocolsResponse

应答信息是一条空信息

错误代码

原因分析

env:

Sender

ter:

InvalidArgVal

ter:

ServiceNotSupported

不支持提供的网络协议

1.2.13获取默认网关

表15：

GetNetworkDefaultGateway命令

GetNetworkDefaultGateway

请求与应答

信息名称

相应功能以及参数描述

GetNetworkDefaultGatewayRequest

请求信息是一条空信息

GetNetworkDefaultGatewayResponse

应答信息包含：

“IPv4Address：

默认网关IPV4地址

IPV6Address：

默认的网关IPV6地址

tt:

IPv4AddressIPv4Address[0][unbounded]

tt:

IPv6AddressIPv6Address[0][unbounded]

错误代码

原因分析

没有与此相关的错误

1.2.14设置默认网关

表16：

SetNetworkDefaultGateway命令

SetNetworkDefaultGateway

请求与回答

信息名称

描述

SetNetworkDefaultGatewayRequest

请求信息包含：

“IPv4Address”:

设置默认IPV4网关地址

“IPv6Address”:

设置默认IPV5网关地址

tt:

IPv4AddressIPv4Address[0][unbounded]

tt:

IPv6AddressIPv6Address[0][unbounded]

SetNetworkDefaultGatewayResponse

应答信息是一条空信息

错误的代码

描述原因

env:

Sender

ter:

InvalidArgVal

ter:

InvalidGatewayAddress

所提供的网关地址是无效

1.2.15获取0配置

表17：

GetZeroConfiguration命令

GetZeroConfiguration

请求与应答

信息名称

相应功能以及参数描述

GetZeroConfigurationRequest

请求信息是一条空信息

GetZeroConfigurationResponse

应答信息包括：

“InterfaceToken”:

网络接口令牌环

“Enabled”如果0配置被使能或者没有

“Addresses”IPV40配置地址

tt:

ReferenceTokenInterfaceToken[1][1]

xs:

booleanEnabled[1][1]

tt:

IPv4AddressesAddress[0][unbounded]

错误代码

原因分析

没有与此命令相关的错误代码

1.2.16设置0配置

表18：

SetZeroConfiguration命令

GetZeroConfiguration

请求与应答

信息名称

描述

GetZeroConfigurationRequest

请求信息包含：

“InterfaceToken”令牌网络接口操作

“Enabled”:

0配置使能与否

tt:

ReferenceTokenInterfaceToken[1][1]

xs:

booleanEnabled[1][1]

GetZeroConfigurationRespon

se

应答信息是一条空信息

可能存在的错误

原因分析

env:

Sender

ter:

InvalidArgVal

ter:

InvalidNetworkInterface

所提供的网络接口令牌不存在

1.2.17获取IP地址过滤

表19：

GetIPAddressFilter指令

GetIPAddressFilter

请求与应答

信息名称

相应功能以及参数描述

GetIPAddressFilterRequest

请求信息是一条空信息

GetIPAddressFilterResponse

应答信息包括：

“Type”:

设置是否允许访问过滤.

“IPv4Address”:

IPv4滤波器地址

“IPv6Address”:

IPv6滤波器地址tt:

IPAddressFilterTypeType[1][1]

tt:

PrefixedIPv4AddressIPv4Address[0][unbounded]

tt:

PrefixedIPv6AddressIPv6Address[0][unbounded

错误代码

原因分析

没有与此命令相关的错误代码

1.2.18对IP地址过滤进行配置

表20：

SetIPAddressFilter指令

SetIPAddressFilter

请求与应答

信息名称

相应功能以及参数描述

SetIPAddressFilterRequest

请求信息包括：

“Type”:

设置类型如果滤波器允许访问.

“IPv4Address”:

IPv4滤波器地址

“IPv6Address”:

IPv6滤波器地址tt:

IPAddressFilterTypeType[1][1]

tt:

PrefixedIPv4AddressIPv4Address[0][unbounded]

tt:

PrefixedIPv6AddressIPv6Address[0][unbounded

SetIPAddressFilterResponse

应答信息为空

错误代码

原因分析

env:

Sender

ter:

InvalidArgVal

ter:

InvalidIPv6Address

建议的IPV6地址无效

env:

Sender

ter:

InvalidArgVal

ter:

InvalidIPv4Address

建议的IPV4地址无效

1.2.19增加IP地址过滤

表21：

AddIPAddressFilter指令

AddIPAddressFilter

请求与应答

信息名称

相应功能以及参数描述

AddIPAddressFilterRequest

请求信息包含：

“IPv4Address”:

增加的IPv4滤波地址

“IPv6Address”:

增加的IPv46滤波地址

tt:

PrefixedIPv4AddressIPv4Address[0][unbounded]

tt:

PrefixedIPv6AddressIPv6Address[0][unbounded]

SetIPAddressFilterResponse

应答信息是一条空信息

可能的存在的错误

原因分析

env:

Sender

ter:

InvalidArgVal

ter:

IPFilterListIsFulls

IPfilter清单已满，不能够继续添加IP滤波地址

env:

Sender

ter:

InvalidArgVal

ter:

InvalidIPv6Address

建议的IPV6地址是无效的

env:

Sender

ter:

InvalidArgVal

ter:

InvalidIPv4Address

建议的IPV4地址是无效的

1.2.20移除IP地址过滤

表22：

RemoveIPAddressFilter命令

RemoveIPAddressFilter

请求与应答

信息名称

相应功能以及参数描述

RemoveIPAddressFilterRequest

请求信息包含：

“IPv4Address”:

增加的IPv4滤波器地址

“IPv6Address”:

增加的IPv46滤波器地址

tt:

PrefixedIPv4AddressIPv4Address[0][unbounded]

tt:

PrefixedIPv6AddressIPv6Address[0][unbounded]

RemoveIPAddressFilterResponse

应答信息不存在或者不包含任何信息

错误代码

原因分析

env:

Sender

ter:

InvalidArgVal

ter:

InvalidIPv6Address

请求信息中要移除的IPV6地址无效的

env:

Sender

ter:

InvalidArgVal

ter:

InvalidIPv6Address

请求信息中要移除的IPV4地址是无效

env:

Sender

ter:

InvalidArgVal

ter:

NoIPv6Address

请求信息要移除的IPV6地址不存在

env:

Sender

ter:

InvalidArgVal

ter:

NoIPv4Address

请求信息要移除的IPV4地址不存在

1.2.21获取DOT11的性能

表23：

GetDot11Capabilities

GetIEEE802.11Capabilities

请求与应答

信息名称

相应功能以及参数描述

GetDot11CapabilitiesRequest

请