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).
Proxy Target Host

Proxy Target Host

Create a Proxy Target Host

Operation

URI

Description

POST

/snmp/proxy/targetHosts/targetHost

Create a proxy target host.

  • Request example
    <?xml version="1.0" encoding="UTF-8"?>
    <targetHost>
        <targetName>dddd</targetName>
        <domain>snmpUDPDomain</domain>
        <address>10.1.1.1</address>
        <timeout>16</timeout>
        <vpnInstanceName>_public_</vpnInstanceName>
        <portNumber>33333</portNumber>
        <securityModel>v2c</securityModel>
        <securityName>public</securityName>
        <isPublicNet>true</isPublicNet>
    </targetHost>

    Table 3-396 describes elements in requests.

    Table 3-396  Elements

    Element

    Description

    targetName

    Specifies the name of a target host for which the SNMP agent is configured.

    domain

    Specifies a transport protocol.

    address

    Specifies the IP address of a target host for which the SNMP agent is configured.

    timeout

    Specifies a timeout period for the NMS to reply Inform packets to the SNMP agent.

    vpnInstanceName

    Specifies the VPN instance bound to a target host.

    portNumber

    Specifies the number of a UDP port through which the NMS sends SNMP packets.

    securityModel

    Specifies an SNMP security model.

    securityName

    Specifies a security name for an SNMPv1/SNMPv2c user.

    isPublicNet

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

    If vpnInstanceName is not set to _public_, the value of this element can only be false.

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

    Table 3-397 describes status codes in responses.

    Table 3-397  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 a Proxy Target Host

Operation

URI

Description

GET

/snmp/proxy/targetHosts/targetHost

Query a proxy target host.

  • Request example
    <?xml version="1.0" encoding="UTF-8"?>
    <targetHost>
        <targetName/>
        <domain/>
        <address/>
        <timeout/>
        <vpnInstanceName/>
        <portNumber/>
        <securityModel/>
        <securityName/>
        <securityNameV3/>
        <securityLevel/>
        <interface-name/>
        <isPublicNet/>
    </targetHost>

    Table 3-398 describes elements in requests.

    Table 3-398  Elements

    Element

    Description

    targetName

    Specifies the name of a target host for which the SNMP agent is configured.

    domain

    Specifies a transport protocol.

    address

    Specifies the IP address of a target host for which the SNMP agent is configured.

    timeout

    Specifies a timeout period for the NMS to reply Inform packets to the SNMP agent.

    vpnInstanceName

    Specifies the VPN instance bound to a target host.

    portNumber

    Specifies the number of a UDP port through which the NMS sends SNMP packets.

    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.

    interface-name

    Specifies the name of a source interface from which trap packets are sent.

    isPublicNet

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

    If vpnInstanceName is not set to _public_, the value of this element can only be false.

  • Response example (XML format)
    <?xml version="1.0" encoding="UTF-8"?>
    <targetHost>
        <targetName>abc</targetName>
        <domain>snmpUDPDomain</domain>
        <address>10.1.1.1</address>
        <timeout>15</timeout>
        <vpnInstanceName>_public_</vpnInstanceName>
        <portNumber>11111</portNumber>
        <securityModel>v2c</securityModel>
        <securityName/>
        <securityNameV3/>
        <securityLevel>noAuthNoPriv</securityLevel>
        <interface-name/>
        <isPublicNet>false</isPublicNet>
    </targetHost>

    Table 3-399 describes elements in responses.

    Table 3-399  Elements

    Element

    Description

    targetName

    Specifies the name of a target host for which the SNMP agent is configured.

    domain

    Specifies a transport protocol.

    address

    Specifies the IP address of a target host for which the SNMP agent is configured.

    timeout

    Specifies a timeout period for the NMS to reply Inform packets to the SNMP agent.

    vpnInstanceName

    Specifies the VPN instance bound to a target host.

    portNumber

    Specifies the number of a UDP port through which the NMS sends SNMP packets.

    securityModel

    Specifies an SNMP security model.

    securityName

    Specifies a security name for an SNMPv1/SNMPv2c user.

    isPublicNet

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

    If vpnInstanceName is not set to _public_, the value of this element can only be false.

    Table 3-400 describes status codes in responses.

    Table 3-400  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 a Proxy Target Host

Operation

URI

Description

PUT

/snmp/proxy/targetHosts/targetHost

Modify a proxy target host.

  • Request example
    <?xml version="1.0" encoding="UTF-8"?>
    <targetHost operation="merge">
        <targetName>abc</targetName>
        <address>10.1.1.1</address>
        <portNumber>22222</portNumber>
        <securityModel>v3</securityModel>
        <securityNameV3>huawei</securityNameV3>
    </targetHost>

    Table 3-401 describes elements in requests.

    Table 3-401  Elements

    Element

    Description

    targetName

    Specifies the name of a target host for which the SNMP agent is configured.

    address

    Specifies the IP address of a target host for which the SNMP agent is configured.

    portNumber

    Specifies the number of a UDP port through which the NMS sends SNMP packets.

    securityModel

    Specifies an SNMP security model.

    securityNameV3

    Specifies a security name for an SNMPv3 user.

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

    Table 3-402 describes status codes in responses.

    Table 3-402  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 a Proxy Target Host

Operation

URI

Description

DELETE

/snmp/proxy/targetHosts/targetHost

Delete a proxy target host.

  • Request example
    <?xml version="1.0" encoding="UTF-8"?>
    <targetHost operation="delete">
        <targetName>abc</targetName>
    </targetHost>

    Table 3-403 describes elements in requests.

    Table 3-403  Elements

    Element

    Description

    targetName

    Specifies the name of a target host for which the SNMP agent is configured.

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

    Table 3-404 describes status codes in responses.

    Table 3-404  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: 21185

Downloads: 116

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