tencent cloud

피드백

DescribeParamsEvent

마지막 업데이트 시간:2024-06-17 14:26:05

    1. API Description

    Domain name for API request: postgres.tencentcloudapi.com.

    This API is used to query the parameter modification event.

    A maximum of 1000 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: DescribeParamsEvent.
    Version Yes String Common Params. The value used for this API: 2017-03-12.
    Region No String Common Params. This parameter is not required for this API.
    DBInstanceId Yes String Instance ID

    3. Output Parameters

    Parameter Name Type Description
    TotalCount Integer Total number of modified parameters
    EventItems Array of EventItem Details of parameter modification events
    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 Getting the list of instance parameter modification events

    This example shows you how to get the statuses and records of parameter modification events.

    Input Example

    POST / HTTP/1.1
    Host: postgres.tencentcloudapi.com
    Content-Type: application/json
    X-TC-Action: DescribeParamsEvent
    <Common request parameters>
    
    {
        "DBInstanceId": "postgres-nbvqjlhf"
    }
    

    Output Example

    {
        "Response": {
            "EventItems": [
                {
                    "EventCount": 1,
                    "EventDetail": [
                        {
                            "EffectiveTime": "0001-01-01 00:00:00",
                            "EventLog": "",
                            "ModifyTime": "2021-08-11 21:51:12",
                            "NewValue": "off",
                            "OldValue": "on",
                            "Operator": "100130115276",
                            "ParamName": "array_nulls",
                            "State": "success"
                        }
                    ],
                    "ParamName": "array_nulls"
                },
                {
                    "EventCount": 1,
                    "EventDetail": [
                        {
                            "EffectiveTime": "2021-08-16 15:33:41",
                            "EventLog": "Pause: Paused. Internal error, in manual processing",
                            "ModifyTime": "2021-08-16 15:28:13",
                            "NewValue": "7",
                            "OldValue": "8",
                            "Operator": "100000115276",
                            "ParamName": "max_worker_processes",
                            "State": "paused"
                        }
                    ],
                    "ParamName": "max_worker_processes"
                }
            ],
            "RequestId": "",
            "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
    FailedOperation.CamAuthFailed CAM authentication failed.
    FailedOperation.FailedOperationError Operation failed. Please try again later.
    FailedOperation.OssOperationFailed Failed to request the backend API.
    InternalError.InternalHttpServerError An exception occurred while executing the request.
    InvalidParameterValue.InvalidParameterValueError Incorrect parameter value
    OperationDenied.CamDeniedError This operation cannot be performed.
    OperationDenied.InstanceAccessDeniedError You do not have the permission to operate this resource.
    ResourceNotFound.InstanceNotFoundError The instance does not exist.