tencent cloud

Feedback

DescribeInstanceParamRecords

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

    1. API Description

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

    This API is used to query the parameter modification records of an instance.

    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: DescribeInstanceParamRecords.
    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.
    InstanceId Yes String Instance ID in the format of mssql-dj5i29c5n. It is the same as the instance ID displayed in the TencentDB console and the response parameter InstanceId of the DescribeDBInstances API.
    Offset No Integer Page number. Default value: 0.
    Limit No Integer The maximum number of results returned per page. Maximum value: 100. Default value: 20.

    3. Output Parameters

    Parameter Name Type Description
    TotalCount Integer Number of eligible records
    Items Array of ParamRecord Parameter modification records
    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 Querying instance parameter modification records

    Input Example

    https://sqlserver.intl.tencentcloudapi.com/?Action=DescribeInstanceParamRecords
    &InstanceId=mssql-bm5e51kb
    &Offset=0
    &Limit=100
    &<Common request parameters>
    

    Output Example

    {
        "Response": {
            "Items": [
                {
                    "InstanceId": "mssql-bm5e51kb",
                    "ModifyTime": "2021-04-09 19:04:12",
                    "NewValue": "60",
                    "OldValue": "80",
                    "ParamName": "fill factor(%)",
                    "Status": 3
                },
                {
                    "InstanceId": "mssql-bm5e51kb",
                    "ModifyTime": "2021-04-09 20:26:57",
                    "NewValue": "60",
                    "OldValue": "80",
                    "ParamName": "fill factor(%)",
                    "Status": 3
                }
            ],
            "RequestId": "10684c55-95b7-40de-b070-23f02c6746d2",
            "TotalCount": 2
        }
    }
    

    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 The operation is unauthorized.
    UnauthorizedOperation.PermissionDenied CAM authentication error.