tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeInstanceNodeInfo

Last updated: 2024-11-20 12:15:09

    1. API Description

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

    This API is used to query the information of primary and replica nodes 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: DescribeInstanceNodeInfo.
    Version Yes String Common Params. The value used for this API: 2017-03-12.
    Region Yes String Common Params. For more information, please see the list of regions supported by the product.
    InstanceId Yes String Instance ID, such as tdsql-6ltok4u9
    Limit No Integer The maximum number of results returned at a time. By default, there is no upper limit to this value, that is, all results can be returned.
    Offset No Integer Offset of the returned results. Default value: 0.

    3. Output Parameters

    Parameter Name Type Description
    TotalCount Integer Total number of nodes
    NodesInfo Array of NodeInfo Node information
    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 the information of primary and replica nodes of an instance

    Input Example

    POST / HTTP/1.1
Host: mariadb.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeInstanceNodeInfo
<Common request parameters>

{
    "InstanceId": "tdsql-b43f8yjl"
}

    Output Example

    {
    "Response": {
        "RequestId": "186315",
        "NodesInfo": [
            {
                "Role": "master",
                "NodeId": "5c2af09aeeb701fef6d5fef4329bb62d61f211ac"
            },
            {
                "Role": "slave",
                "NodeId": "dbedea66f4ba2b71e6816e3f9d0c2936e5448786"
            },
            {
                "Role": "slave",
                "NodeId": "1b40c8a28bec5c4af666d31b24119e319d68773e"
            }
        ],
        "TotalCount": 3
    }
}

    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.OssOperationFailed Failed to request the backend API.
    InternalError.InnerSystemError Internal system error.
    InvalidParameter.InstanceNotFound Failed to find the requested instance.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy