tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

ModifyInstanceParam

Last updated: 2024-11-26 16:33:02

    1. API Description

    Domain name for API request: sqlserver.intl.tencentcloudapi.com.

    This API is used to modify instance parameters.
    Note: if the instance needs to be restarted for the modified parameter to take effect, it will be restarted immediately or during the maintenance time according to the WaitSwitch parameter.
    Before you modify a parameter, you can use the DescribeInstanceParams API to query whether the instance needs to be restarted.

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

    We recommend you to use API Explorer
    Try it
    API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

    2. Input Parameters

    The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

    Parameter Name Required Type Description
    Action Yes String Common Params. The value used for this API: ModifyInstanceParam.
    Version Yes String Common Params. The value used for this API: 2018-03-28.
    Region Yes String Common Params. For more information, please see the list of regions supported by the product.
    InstanceIds.N Yes Array of String Instance ID list.
    ParamList.N Yes Array of Parameter List of modified parameters. Each list element has two fields: Name and CurrentValue. Set Name to the parameter name and CurrentValue to the new value after modification. Note: if the instance needs to be restarted for the modified parameter to take effect, it will be restarted immediately or during the maintenance time. Before you modify a parameter, you can use the DescribeInstanceParams API to query whether the instance needs to be restarted.
    WaitSwitch No Integer When to execute the parameter modification task. Valid values: 0 (execute immediately), 1 (execute during maintenance time). Default value: 0.

    3. Output Parameters

    Parameter Name Type Description
    RequestId String The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

    4. Example

    Example1 Modifying instance parameters

    Input Example

    https://sqlserver.intl.tencentcloudapi.com/?Action=ModifyInstanceParam
&WaitSwitch=0
&InstanceIds.0=mssql-bm5e51kb
&InstanceIds.1=mssql-p2yli7gv
&InstanceIds.2=mssql-9ahw2qp9
&ParamList.0.Name=fill factor(%)
&ParamList.0.CurrentValue=50
&ParamList.1.Name=cost threshold for parallelism
&ParamList.1.CurrentValue=0
&<Common request parameters>

    Output Example

    {
    "Response": {
        "RequestId": "74172b7e-139c-4eed-b237-856f56e67f48"
    }
}

    5. Developer Resources

    SDK

    TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

    Command Line Interface

    6. Error Code

    The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

    Error Code Description
    AuthFailure CAM signature/authentication error
    InternalError.DBError Database error
    InternalError.SystemError System error.
    InvalidParameter.InputIllegal Input error.
    ResourceNotFound.InstanceNotFound The instance does not exist.
    UnauthorizedOperation.PermissionDenied CAM authentication error.
    UnknownParameter Unknown parameter error
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy