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).
SNMPv3 Local User

SNMPv3 Local User

Create an SNMPv3 Local User

Operation

URI

Description

POST

/snmp/localUsers/localUser

Create an SNMPv3 local user.

  • Request example
    <?xml version="1.0" encoding="UTF-8"?>
    <localUser>
        <userName>rootabc</userName>
        <authProtocol>md5</authProtocol>
        <authKey>1234qwer</authKey>
        <privProtocol>des56</privProtocol>
        <privKey>1234qwer</privKey>
    </localUser>

    Table 3-362 describes elements in requests.

    Table 3-362  Elements

    Element

    Description

    userName

    Specifies an SNMPv3 user name.

    authProtocol

    Specifies an authentication mode.

    authKey

    Specifies an authentication key.

    privProtocol

    Specifies an encryption mode.

    privKey

    Specifies an encryption key.

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

    Table 3-363 describes status codes in responses.

    Table 3-363  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 Parameter Settings of an SNMPv3 Local User

Operation

URI

Description

GET

/snmp/localUsers/localUser

Query the parameter settings of an SNMPv3 local user.

  • Request example
    <?xml version="1.0" encoding="UTF-8"?>
    <localUser>
        <userName/>
        <authProtocol/>
        <authKey/>
        <privProtocol/>
        <privKey/>
        <activeStatus/>
        <leftLockTime/>
    </localUser>

    Table 3-364 describes elements in requests.

    Table 3-364  Elements

    Element

    Description

    userName

    Specifies an SNMPv3 user name.

    authProtocol

    Specifies an authentication mode.

    authKey

    Specifies an authentication key.

    privProtocol

    Specifies an encryption mode.

    privKey

    Specifies an encryption key.

    activeStatus

    Specifies whether a user is locked.

    leftLockTime

    Specifies the remaining time before a user is unlocked.

  • Response example (XML format)
    <?xml version="1.0" encoding="UTF-8"?>
    <localUser>
        <userName>abc</userName>
        <authProtocol>md5</authProtocol>
        <authKey/>
        <privProtocol>des56</privProtocol>
        <privKey/>
        <activeStatus>Active</activeStatus>
        <leftLockTime/>
    </localUser>

    Table 3-365 describes elements in responses.

    Table 3-365  Elements

    Element

    Description

    userName

    Specifies an SNMPv3 user name.

    authProtocol

    Specifies an authentication mode.

    authKey

    Specifies an authentication key.

    privProtocol

    Specifies an encryption mode.

    privKey

    Specifies an encryption key.

    activeStatus

    Specifies whether a user is locked.

    leftLockTime

    Specifies the remaining time before a user is unlocked.

    Table 3-366 describes status codes in responses.

    Table 3-366  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 SNMPv3 Local User

Operation

URI

Description

PUT

/snmp/localUsers/localUser

Modify an SNMPv3 local user.

  • Request example
    <?xml version="1.0" encoding="UTF-8"?>
    <localUser>
        <userName>rootabc</userName>
        <authProtocol>md5</authProtocol>
        <authKey>1234qwer</authKey>
        <privProtocol>des56</privProtocol>
        <privKey>1234qwer</privKey>
    </localUser>

    Table 3-367 describes elements in requests.

    Table 3-367  Elements

    Element

    Description

    userName

    Specifies an SNMPv3 user name.

    authProtocol

    Specifies an authentication mode.

    authKey

    Specifies an authentication key.

    privProtocol

    Specifies an encryption mode.

    privKey

    Specifies an encryption key.

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

    Table 3-368 describes status codes in responses.

    Table 3-368  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 SNMPv3 Local User

Operation

URI

Description

DELETE

/snmp/localUsers/localUser

Delete an SNMPv3 local user.

  • Request example
    <?xml version="1.0" encoding="UTF-8"?>
    <localUser>
        <userName>rootabc</userName>
        <authProtocol>md5</authProtocol>
        <authKey>1234qwer</authKey>
        <privProtocol>des56</privProtocol>
        <privKey>1234qwer</privKey>
    </localUser>

    Table 3-369 describes elements in requests.

    Table 3-369  Elements

    Element

    Description

    userName

    Specifies an SNMPv3 user name.

    authProtocol

    Specifies an authentication mode.

    authKey

    Specifies an authentication key.

    privProtocol

    Specifies an encryption mode.

    privKey

    Specifies an encryption key.

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

    Table 3-370 describes status codes in responses.

    Table 3-370  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: 27828

Downloads: 123

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