Add Parameter Template

Last updated: 2017-12-14 11:08:13

    1. API Description

    This API (AddCdbParamTemplate) is used to add a parameter template of the Cloud Database instance.
    You can also use API Query List of Parameter Templates to query the details of the list of parameter templates.
    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 AddCdbParamTemplate.

    Parameter Name Required Type Description
    name Yes String Template name, which must be unique.
    desc No String Template description
    engineVersion No String Database version number. Possible returned values include: 5.1, 5.5, and 5.6; if templateId field is not uploaded, this value is required.
    templateId No Int template ID; if the value is uploaded, the paramList field will be invalid.
    paramList.n No String Parameter list. Format: paramList.0.name=auto_increment_increment&paramList.0.value=1

    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
    templateId Int Template ID

    4. Error Codes

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

    Error Code Error Message Error Description
    9612 InternalError Database insert error
    9613 InternalError Database query error
    20001 InternalError.ReachedMaximum The maximum number of parameter templates is reached
    20002 InvalidParameter.DuplicateName A duplicate parameter template name exists

    5. Example

    Input

    https://cdb.api.qcloud.com/v2/index.php?Action=AddCdbParamTemplate
    &<Common request parameters>
    &engineVersion=5.6
    &name=test
    &paramList.0.name=connect_timeout
    &paramList.0.value=10
    

    Output

    {
        "code":"0",
        "message":"",
        "codeDesc":"Success",
        "data":{
            "templateId":"1"
        }
    }

    Was this page helpful?

    Was this page helpful?

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