No relevant resource is found in the selected language.

This site uses cookies. By continuing to browse the site you are agreeing to our use of cookies. Read our privacy policy>Search

Reminder

To have a better experience, please upgrade your IE browser.

upgrade

RESTful API Reference

CloudEngine 8800, 7800, 6800, and 5800 V200R002C50

This document describes the OPS APIs supported by the device, including OPS-supported operations, request examples, elements in the requests, response examples, elements in the responses, and response status codes.
Rate and give feedback:
Huawei uses machine translation combined with human proofreading to translate this document to different languages in order to help you better understand the content of this document. Note: Even the most advanced machine translation cannot match the quality of professional translators. Huawei shall not bear any responsibility for translation accuracy and it is recommended that you refer to the English document (a link for which has been provided).
SNMP Target Host

SNMP Target Host

Create an SNMP Target Host

Operation

URI

Description

POST

/snmp/targetHosts/targetHost

Create a Trap or Inform target host.

  • Request example
    <?xml version="1.0" encoding="UTF-8"?>
    <targetHost>
        <nmsName>2</nmsName>
        <address>10.1.1.1</address>
        <portNumber>162</portNumber>
        <vpnInstanceName>_public_</vpnInstanceName>
        <securityName>public</securityName>
        <securityNameV3></securityNameV3>
        <securityModel>v2c</securityModel>
        <securityLevel>noAuthNoPriv</securityLevel>
        <notifyType>inform</notifyType>
        <domain>snmpUDPDomain</domain>
        <targetInformTimeout>15</targetInformTimeout>
        <targetInformResendTimes>3</targetInformResendTimes>
        <private-netmanager>false</private-netmanager>
        <ext-vb>false</ext-vb>
        <interface-name>LoopBack0</interface-name>
        <notifyFltrPrName></notifyFltrPrName>
        <isPublicNet>false</isPublicNet>
    </targetHost>

    Table 3-371 describes elements in requests.

    Table 3-371  Elements

    Element

    Description

    nmsName

    Specifies the name of an SNMP target host.

    address

    Specifies the address of an SNMP target host.

    portNumber

    Specifies a UDP port number.

    vpnInstanceName

    Specifies a VPN instance name.

    securityName

    Specifies a security name for an SNMPv1/SNMPv2c user.

    securityNameV3

    Specifies a security name for an SNMPv3 user.

    securityModel

    Specifies an SNMP security model.

    securityLevel

    Specifies an SNMP security level.

    notifyType

    Specifies a packet type.

    domain

    Specifies a transport protocol.

    targetInformTimeout

    Specifies a timeout period for Inform packets.

    targetInformResendTimes

    Specifies the maximum number of Inform packet retransmission times.

    private-netmanager

    Specifies whether the target host that receives trap packets is a Huawei NMS.

    ext-vb

    Specifies whether to carry extended bound variables in alarms sent to a target host.

    interface-name

    Specifies an interface name.

    notifyFltrPrName

    Specifies a notification filtering template.

    isPublicNet

    Specifies whether to connect to a target host through the public network.

  • Response example (XML format)
    <?xml version="1.0" encoding="UTF-8"?>
    <ok/>

    Table 3-372 describes status codes in responses.

    Table 3-372  Status codes

    Status Code

    Description

    200 OK

    The operation succeeded.

    400 Bad Request

    The request operation failed because the request is incorrect in syntax or the information attribute in the request is incorrect.

    500 Internal Server Error

    The request operation failed because of internal errors in services or unidentified processing errors.

Query the Configurations of an SNMP Target Host

Operation

URI

Description

GET

/snmp/targetHosts/targetHost

Query the configurations of an SNMP target host.

  • Request example
    <?xml version="1.0" encoding="UTF-8"?>
    <targetHost>
        <nmsName/>
        <domain/>
        <address/>
        <targetInformTimeout/>
        <targetInformResendTimes/>
        <notifyType/>
        <vpnInstanceName/>
        <portNumber/>
        <securityModel/>
        <securityName/>
        <securityNameV3/>
        <securityLevel/>
        <private-netmanager/>
        <isPublicNet/>
        <ext-vb/>
        <notifyFltrPrName/>
        <retriesNum/>
        <pendingNum/>
        <sentNum/>
        <droppedNum/>
        <failedNum/>
        <confirmedNum/>
        <interface-name/>
    </targetHost>

    Table 3-373 describes elements in requests.

    Table 3-373  Elements

    Element

    Description

    nmsName

    Specifies the name of an SNMP target host.

    domain

    Specifies a transport protocol.

    address

    Specifies the address of an SNMP target host.

    targetInformTimeout

    Specifies a timeout period for Inform packets.

    targetInformResendTimes

    Specifies the maximum number of Inform packet retransmission times.

    notifyType

    Specifies a packet type.

    vpnInstanceName

    Specifies a VPN instance name.

    portNumber

    Specifies a UDP port number.

    securityModel

    Specifies an SNMP security model.

    securityName

    Specifies a security name for an SNMPv1/SNMPv2c user.

    securityNameV3

    Specifies a security name for an SNMPv3 user.

    securityLevel

    Specifies an SNMP security level.

    private-netmanager

    Specifies whether the target host that receives trap packets is a Huawei NMS.

    isPublicNet

    Specifies whether a public network is used.

    ext-vb

    Specifies whether to carry extended bound variables in alarms sent to a target host.

    notifyFltrPrName

    Specifies the name of a notification filtering template.

    retriesNum

    Specifies the number of retransmission times.

    pendingNum

    Specifies the number of blocked packets.

    sentNum

    Specifies the number of sent packets.

    droppedNum

    Specifies the number of dropped packets.

    failedNum

    Specifies the number of failed packets.

    confirmedNum

    Specifies the number of confirmed packets.

    interface-name

    Specifies an interface name.

  • Response example (XML format)
    <?xml version="1.0" encoding="UTF-8"?>
    <targetHost>
        <nmsName>__targetHost_1_59745</nmsName>
        <address>10.1.1.1</address>
        <portNumber>162</portNumber>
        <vpnInstanceName>_public_</vpnInstanceName>
        <securityName/>
        <securityNameV3/>
        <securityModel>v2c</securityModel>
        <securityLevel>noAuthNoPriv</securityLevel>
        <notifyType>trap</notifyType>
        <domain>snmpUDPDomain</domain>
        <targetInformTimeout>15</targetInformTimeout>
        <targetInformResendTimes>3</targetInformResendTimes>
        <private-netmanager>false</private-netmanager>
        <ext-vb>false</ext-vb>
        <interface-name/>
        <notifyFltrPrName/>
        <retriesNum>0</retriesNum>
        <pendingNum>0</pendingNum>
        <sentNum>0</sentNum>
        <droppedNum>0</droppedNum>
        <failedNum>0</failedNum>
        <confirmedNum>0</confirmedNum>
        <isPublicNet>false</isPublicNet>
    </targetHost>

    Table 3-374 describes elements in responses.

    Table 3-374  Elements

    Element

    Description

    nmsName

    Specifies the name of an SNMP target host.

    domain

    Specifies a transport protocol.

    address

    Specifies the address of an SNMP target host.

    targetInformTimeout

    Specifies a timeout period for Inform packets.

    targetInformResendTimes

    Specifies the maximum number of Inform packet retransmission times.

    notifyType

    Specifies a packet type.

    vpnInstanceName

    Specifies a VPN instance name.

    portNumber

    Specifies a UDP port number.

    securityModel

    Specifies an SNMP security model.

    securityName

    Specifies a security name for an SNMPv1/SNMPv2c user.

    securityNameV3

    Specifies a security name for an SNMPv1/SNMPv2c user.

    securityLevel

    Specifies an SNMP security level.

    private-netmanager

    Specifies whether the target host that receives trap packets is a Huawei NMS.

    ext-vb

    Specifies whether to carry extended bound variables in alarms sent to a target host.

    interface-name

    Specifies an interface name.

    notifyFltrPrName

    Specifies a notification filtering template.

    isPublicNet

    Specifies that a target host is connected through the public network.

    Table 3-375 describes status codes in responses.

    Table 3-375  Status codes

    Status Code

    Description

    200 OK

    The operation succeeded.

    400 Bad Request

    The request operation failed because the request is incorrect in syntax or the information attribute in the request is incorrect.

    500 Internal Server Error

    The request operation failed because of internal errors in services or unidentified processing errors.

Modify an SNMP Target Host

Operation

URI

Description

PUT

/snmp/targetHosts/targetHost

Modify an SNMP target host.

  • Request example
    <?xml version="1.0" encoding="UTF-8"?>
    <targetHost>
        <nmsName>2</nmsName>
        <address>10.1.1.1</address>
        <portNumber>10000</portNumber>
        <vpnInstanceName>_public_</vpnInstanceName>
        <securityName>public</securityName>
        <securityModel>v2c</securityModel>
        <securityLevel>noAuthNoPriv</securityLevel>
        <notifyType>inform</notifyType>
        <domain>snmpUDPDomain</domain>
        <targetInformTimeout>15</targetInformTimeout>
        <targetInformResendTimes>3</targetInformResendTimes>
        <private-netmanager>false</private-netmanager>
        <ext-vb>false</ext-vb>
        <interface-name>LoopBack0</interface-name>
        <notifyFltrPrName>1</notifyFltrPrName>
        <isPublicNet>false</isPublicNet>
    </targetHost>

    Table 3-376 describes elements in requests.

    Table 3-376  Elements

    Element

    Description

    nmsName

    Specifies the name of an SNMP target host.

    address

    Specifies the address of an SNMP target host.

    portNumber

    Specifies a UDP port number.

    vpnInstanceName

    Specifies a VPN instance name.

    securityName

    Specifies a security name for an SNMPv1/SNMPv2c user.

    securityNameV3

    Specifies a security name for an SNMPv3 user.

    securityModel

    Specifies an SNMP security model.

    securityLevel

    Specifies an SNMP security level.

    notifyType

    Specifies a packet type.

    domain

    Specifies a transport protocol.

    targetInformTimeout

    Specifies a timeout period for Inform packets.

    targetInformResendTimes

    Specifies the maximum number of Inform packet retransmission times.

    private-netmanager

    Specifies whether the target host that receives trap packets is a Huawei NMS.

    ext-vb

    Specifies whether to carry extended bound variables in alarms sent to a target host.

    interface-name

    Specifies an interface name.

    notifyFltrPrName

    Specifies a notification filtering template.

    isPublicNet

    Specifies whether to connect to a target host through the public network.

  • Response example (XML format)
    <?xml version="1.0" encoding="UTF-8"?>
    <ok/>

    Table 3-377 describes status codes in responses.

    Table 3-377  Status codes

    Status Code

    Description

    200 OK

    The operation succeeded.

    400 Bad Request

    The request operation failed because the request is incorrect in syntax or the information attribute in the request is incorrect.

    500 Internal Server Error

    The request operation failed because of internal errors in services or unidentified processing errors.

Delete an SNMP Target Host

Operation

URI

Description

DELETE

/snmp/targetHosts/targetHost

Delete an SNMP target host.

  • Request example
    <?xml version="1.0" encoding="UTF-8"?>
    <targetHost>
        <nmsName>TargetHost1</nmsName>
    </targetHost>

    Table 3-378 describes elements in requests.

    Table 3-378  Elements

    Element

    Description

    nmsName

    Specifies the name of an SNMP target host.

  • Response example (XML format)
    <?xml version="1.0" encoding="UTF-8"?>
    <ok/>

    Table 3-379 describes status codes in responses.

    Table 3-379  Status codes

    Status Code

    Description

    200 OK

    The operation succeeded.

    400 Bad Request

    The request operation failed because the request is incorrect in syntax or the information attribute in the request is incorrect.

    500 Internal Server Error

    The request operation failed because of internal errors in services or unidentified processing errors.

Translation
Download
Updated: 2019-03-21

Document ID: EDOC1000166567

Views: 27683

Downloads: 123

Average rating:
This Document Applies to these Products
Related Documents
Related Version
Share
Previous Next