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 12800 and 12800E V200R003C00

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-389 describes elements in requests.

    Table 3-389  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-390 describes status codes in responses.

    Table 3-390  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-391 describes elements in requests.

    Table 3-391  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-392 describes elements in responses.

    Table 3-392  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-393 describes status codes in responses.

    Table 3-393  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-394 describes elements in requests.

    Table 3-394  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-395 describes status codes in responses.

    Table 3-395  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-396 describes elements in requests.

    Table 3-396  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-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.

Translation
Download
Updated: 2019-05-05

Document ID: EDOC1100004147

Views: 60003

Downloads: 28

Average rating:
This Document Applies to these Products

Related Version

Related Documents

Share
Previous Next