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 Rule

Proxy Rule

Create a Proxy Rule

Operation

URI

Description

POST

/snmp/proxy/rules/rule

Create a proxy rule.

  • Request example
    <?xml version="1.0" encoding="UTF-8"?>
    <rule>
        <proxyName>r2</proxyName>
        <type>read</type>
        <remoteEngineID>111111111111</remoteEngineID>
        <targetHostName>2</targetHostName>
        <securityName>test</securityName>
        <securityModel>v1</securityModel>
        <securityLevel>noAuthNoPriv</securityLevel>
    </rule>

    Table 3-405 describes elements in requests.

    Table 3-405  Elements

    Element

    Description

    proxyName

    Specifies a proxy rule name for SNMP packets.

    type

    Specifies an SNMP packet type.

    remoteEngineID

    Specifies a remote SNMP engine ID.

    targetHostName

    Specifies a target host 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 a security level.

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

    Table 3-406 describes status codes in responses.

    Table 3-406  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 Rule

Operation

URI

Description

GET

/snmp/proxy/rules/rule

Query a proxy rule.

  • Request example
    <?xml version="1.0" encoding="UTF-8"?>
    <rule>
        <proxyName/>
        <type/>
        <remoteEngineID/>
        <targetHostName/>
        <securityName/>
        <securityNameV3/>
        <securityModel/>
        <securityLevel/>
    </rule>

    Table 3-407 describes elements in requests.

    Table 3-407  Elements

    Element

    Description

    proxyName

    Specifies a proxy rule name for SNMP packets.

    type

    Specifies an SNMP packet type.

    remoteEngineID

    Specifies a remote SNMP engine ID.

    targetHostName

    Specifies a target host 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 a security level.

  • Response example (XML format)
    <?xml version="1.0" encoding="UTF-8"?><rule>
    <proxyName>r2</proxyName>
    <type>read</type>
    <remoteEngineID>111111111111</remoteEngineID>
    <targetHostName>2</targetHostName>
    <securityName>%^%#QQJ[X2K{S&*3&]A#paxG=-nqDFWG90,+FY:=ae[W%^%#</securityName>
    <securityNameV3>
    </securityNameV3>
    <securityModel>v1</securityModel>
    <securityLevel>noAuthNoPriv</securityLevel>
    </rule>

    Table 3-408 describes elements in responses.

    Table 3-408  Elements

    Element

    Description

    proxyName

    Specifies a proxy rule name for SNMP packets.

    type

    Specifies an SNMP packet type.

    remoteEngineID

    Specifies a remote SNMP engine ID.

    targetHostName

    Specifies a target host 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 a security level.

    Table 3-409 describes status codes in responses.

    Table 3-409  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 Rule

Operation

URI

Description

PUT

/snmp/proxy/rules/rule

Modify a proxy rule.

  • Request example
    <?xml version="1.0" encoding="UTF-8"?>
    <rule>
        <proxyName>r2</proxyName>
        <type>read</type>
        <remoteEngineID>111111111111</remoteEngineID>
        <targetHostName>2</targetHostName>
        <securityName>test</securityName>
        <securityModel>v1</securityModel>
        <securityLevel>noAuthNoPriv</securityLevel>
    </rule>

    Table 3-410 describes elements in requests.

    Table 3-410  Elements

    Element

    Description

    proxyName

    Specifies a proxy rule name for SNMP packets.

    type

    Specifies an SNMP packet type.

    remoteEngineID

    Specifies a remote SNMP engine ID.

    targetHostName

    Specifies a target host 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 a security level.

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

    Table 3-411 describes status codes in responses.

    Table 3-411  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 Rule

Operation

URI

Description

DELETE

/snmp/proxy/rules/rule

Delete a proxy rule.

  • Request example
    <?xml version="1.0" encoding="UTF-8"?>
    <rule>
        <proxyName>r2</proxyName>
        <type>read</type>
        <remoteEngineID>111111111111</remoteEngineID>
        <targetHostName>2</targetHostName>
        <securityName>test</securityName>
        <securityModel>v1</securityModel>
        <securityLevel>noAuthNoPriv</securityLevel>
    </rule>

    Table 3-412 describes elements in requests.

    Table 3-412  Elements

    Element

    Description

    proxyName

    Specifies a proxy rule name for SNMP packets.

    type

    Specifies an SNMP packet type.

    remoteEngineID

    Specifies a remote SNMP engine ID.

    targetHostName

    Specifies a target host 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 a security level.

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

    Table 3-413 describes status codes in responses.

    Table 3-413  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: 30718

Downloads: 127

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