Change Parameter

Last updated: 2017-12-14 10:59:41

    1. API Description

    This API (ModifyCdbParams) is used to modify the parameters of the Cloud Database instance.
    You can also use API Query Parameter List to get the parameter information of the instance.
    Domain for API request: cdb.api.qcloud.com

    2. Input Parameters

    The following request parameter list only provides API request parameters. Common request parameters need to be added when the API is called. For more information, refer to Common Request Parameters. The Action field for this API is ModifyCdbParams.

    Parameter Name Required Type Description
    cdbInstanceIds.n Yes String One or more instance IDs (n represents array subscript starting with 0). Instance ID, such as: cdb-c1nl9rpv. It is identical to the instance ID displayed in the Cloud Database console page and can be obtained using API Query List of Instances. Its value equals to the uInstanceId field value in the output parameter.
    paramList.n (paramList is an array, whose elements need to be entered as input parameters) Yes String Each element is a combination of name and value. Name is the parameter name, and value is the value to be modified to.

    3. Output Parameters

    Parameter Name Type Description
    code Int Common error code; 0: Succeeded; other values: Failed. For more information, please refer to Common Error Codes on the Error Code page.
    message String Module error message description depending on API.
    codeDesc String Error description
    data Array Returned data
    Parameter data is composed of the following parameters:
    Parameter Name Type Description
    jobId Int Task ID

    4. Error Codes

    The following error codes only include the business logic error codes for this API.

    Error Code Error Message Error Description
    9003 InvalidParameter Incorrect parameter
    9006 InternalError Database internal error
    9016 InternalError System internal error
    9543 NameNotExists Instance name does not exist
    9590 InternalFailure Task database access error
    9593 IncorrectInstanceStatus Abnormal instance status

    5. Example

    Input

    https://cdb.api.qcloud.com/v2/index.php?Action=ModifyCdbParams
    &<Common request parameters>
    &cdbInstanceIds.0=cdb-c1nl9rpv
    &paramList.0.name=connect_timeout
    &paramList.0.value=11
    

    Output

    {
        "code": 0,
        "message": "",
        "codeDesc": "Success",
        "data": {
            "jobId": 122
        }
    }

    Was this page helpful?

    Was this page helpful?

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