Last updated: 2019-11-29 16:42:21

    1. API Description

    Domain name for API request:

    This API (VerifyRootAccount) is used to verify whether the ROOT account of a database instance has sufficient permissions for authorization.

    A maximum of 20 requests can be initiated per second for this API.

    Note: This API supports Finance regions. Since Finance regions and non-Finance regions are isolated and not interconnected. If the common parameter Region is a Finance region (such as ap-shanghai-fsi), you need to specify a domain name containing the Finance region that should be identical to the value of Region field, for example:

    2. Input Parameters

    The following request parameter list only provides API request parameters and some common parameters.

    Parameter Name Required Type Description
    Action Yes String Common parameter. The value used for this API: VerifyRootAccount
    Version Yes String Common parameter. The value used for this API: 2017-03-20
    Region Yes String Common parameter.
    InstanceId Yes String Instance ID, such as cdb-c1nl9rpv. It is identical to the instance ID displayed in the database console page.
    Password Yes String Password of the ROOT account of the instance.

    3. Output Parameters

    Parameter Name Type Description
    AsyncRequestId String ID of an async task request, which can be used to query the execution result of an async task.
    RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

    4. Error Codes

    The following only lists the error codes related to the API business logic.

    Error Code Description
    InvalidParameter Parameter error.
    InvalidParameter.InstanceNotFound The instance does not exist.
    OperationDenied The operation is not allowed.

    5. Example

    Example 1 Verify the permissions of the root account

    Input example
    &<Common request parameters>

    Output example

      "Response": {
        "AsyncRequestId": "256117ed-efa08b54-61784d44-91781bbd",
        "RequestId": "6EF60BEC-0242-43AF-BB20-270359FB54A7"

    6. Other Resources

    Cloud API 3.0 comes with the following development tools to make it easier to call the API.

    Was this page helpful?

    Was this page helpful?

    • Not at all
    • Not very helpful
    • Somewhat helpful
    • Very helpful
    • Extremely helpful
    Send Feedback