PrevNext
search by keyword

Recent Pages

Documentation
TencentDB for DBbrain
    Documentation
    Download PDF

    DescribeMySqlProcessList

    Last updated: 2022-01-06 14:27:54
    Download PDF

    1. API Description

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

    This API is used to query the real-time thread list of a relational database.

    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 parameter. The value used for this API: DescribeMySqlProcessList.
    Version Yes String Common parameter. The value used for this API: 2021-05-27.
    Region Yes String Common parameter. For more information, please see the list of regions supported by the product.
    InstanceId Yes String Instance ID.
    ID No Integer Thread ID, which is used to filter the thread list.
    User No String Thread operation account name, which is used to filter the thread list.
    Host No String Thread operation host address, which is used to filter the thread list.
    DB No String Thread operation database, which is used to filter the thread list.
    State No String Thread operation status, which is used to filter the thread list.
    Command No String Thread execution type, which is used to filter the thread list.
    Time No Integer Minimum operation duration of the thread in seconds, which is used to filter the list of threads whose operation duration is greater than this value.
    Info No String Thread operation statement, which is used to filter the thread list.
    Limit No Integer Number of returned results. Default value: 20.
    Product No String Service type. Valid values: mysql (TencentDB for MySQL), cynosdb (TDSQL-C for MySQL). Default value: mysql.

    3. Output Parameters

    Parameter Name Type Description
    ProcessList Array of MySqlProcess List of real-time threads.
    RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

    4. Example

    Example1 Querying the list of real-time threads

    Input Example

    https://dbbrain.tencentcloudapi.com/?Action=DescribeMySqlProcessList
&Product=mysql
&InstanceId=cdb-test
&User=root
&<Common request parameters>

    Output Example

    {
  "Response": {
    "RequestId": "24665720-8c93-11eb-bee6-e98cea0e6794",
    "ProcessList": [
      {
        "Host": "127.0.0.1:42036",
        "State": "",
        "Command": "Sleep",
        "Time": "1179",
        "ID": "171588317",
        "User": "root",
        "Info": "",
        "DB": "test"
      }
    ]
  }
}

    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 Error with CAM signature/authentication.
    FailedOperation Operation failed.
    InternalError Internal error.
    InvalidParameter Incorrect parameter.
    InvalidParameterValue Incorrect parameter value.
    LimitExceeded The quota limit is exceeded.
    MissingParameter Missing parameter.
    OperationDenied Operation denied.
    OperationDenied.UserHasNoStrategy Error with CAM authentication.
    ResourceNotFound The resource does not exist.
    UnauthorizedOperation The operation is unauthorized.
    UnknownParameter Unknown parameter.
    UnsupportedOperation Unsupported operation.
    tencent
    Copyright © 2013-2022 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy