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).
SNMPv1/SNMPv2c Community Name

SNMPv1/SNMPv2c Community Name

Create an SNMPv1/SNMPv2c Community Name

Operation

URI

Description

POST

/snmp/communitys/community

Create an SNMPv1/SNMPv2c community name.

  • Request example
    <?xml version="1.0" encoding="UTF-8"?>
    <community>
        <communityName>community_write</communityName>
        <accessRight>write</accessRight>
        <mibViewName>internet</mibViewName>
        <aclNumber>2323</aclNumber>
    </community>

    Table 3-335 describes elements in requests.

    Table 3-335  Elements

    Element

    Description

    communityName

    Specifies an SNMPv1/SNMPv2c community name.

    accessRight

    Specifies the access permission.

    mibViewName

    Specifies the name of the MIB view that can be accessed by the community name.

    aclNumber

    Specifies an ACL number.

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

    Table 3-336 describes status codes in responses.

    Table 3-336  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 an SNMPv1/SNMPv2c Community Name

Operation

URI

Description

GET

/snmp/communitys/community

Query an SNMPv1/SNMPv2c community name.

  • Request example
    <?xml version="1.0" encoding="UTF-8"?>
    <community>
        <communityName/>
        <accessRight/>
        <mibViewName/>
        <aclNumber/>
    </community>

    Table 3-337 describes elements in requests.

    Table 3-337  Elements

    Element

    Description

    communityName

    Specifies an SNMPv1/SNMPv2c community name.

    accessRight

    Specifies the access permission.

    mibViewName

    Specifies the name of the MIB view that can be accessed by the community name.

    aclNumber

    Specifies an ACL number.

  • Response example (XML format)
    <?xml version="1.0" encoding="UTF-8"?>
    <community>
        <communityName>******</communityName>
        <accessRight>read</accessRight>
        <mibViewName>iso</mibViewName>
        <aclNumber/>
    </community>

    Table 3-338 describes elements in responses.

    Table 3-338  Elements

    Element

    Description

    communityName

    Specifies an SNMPv1/SNMPv2c community name.

    accessRight

    Specifies the access permission.

    mibViewName

    Specifies the name of the MIB view that can be accessed by the community name.

    aclNumber

    Specifies an ACL number.

    Table 3-339 describes status codes in responses.

    Table 3-339  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 SNMPv1/SNMPv2c Community Name

Operation

URI

Description

PUT

/snmp/communitys/community

Modify an SNMPv1/SNMPv2c community name.

  • Request example
    <?xml version="1.0" encoding="UTF-8"?>
    <community>
        <communityName>community_write</communityName>
        <accessRight>write</accessRight>
        <mibViewName>internet</mibViewName>
        <aclNumber>2323</aclNumber>
    </community>

    Table 3-340 describes elements in requests.

    Table 3-340  Elements

    Element

    Description

    communityName

    Specifies an SNMPv1/SNMPv2c community name.

    accessRight

    Specifies the access permission.

    mibViewName

    Specifies the name of the MIB view that can be accessed by the community name.

    aclNumber

    Specifies an ACL number.

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

    Table 3-341 describes status codes in responses.

    Table 3-341  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 SNMPv1/SNMPv2c Community Name

Operation

URI

Description

DELETE

/snmp/communitys/community

Delete an SNMPv1/SNMPv2c community name.

  • Request example
    <?xml version="1.0" encoding="UTF-8"?>
    <community>
        <communityName>community_write</communityName>
        <accessRight>write</accessRight>
        <mibViewName>internet</mibViewName>
        <aclNumber>2323</aclNumber>
    </community>

    Table 3-342 describes elements in requests.

    Table 3-342  Elements

    Element

    Description

    communityName

    Specifies an SNMPv1/SNMPv2c community name.

    accessRight

    Specifies the access permission.

    mibViewName

    Specifies the name of the MIB view that can be accessed by the community name.

    aclNumber

    Specifies an ACL number.

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

    Table 3-343 describes status codes in responses.

    Table 3-343  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: 30349

Downloads: 127

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