tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeDBInstanceConfig

Last updated: 2024-01-30 10:26:06

    1. API Description

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

    This API (DescribeDBInstanceConfig) is used to query the configuration information of a TencentDB instance, such as its synchronization mode and deployment mode.

    A maximum of 100 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: DescribeDBInstanceConfig.
    Version Yes String Common Params. The value used for this API: 2017-03-20.
    Region No String Common Params. This parameter is not required for this API.
    InstanceId Yes String Instance ID in the format of cdb-c1nl9rpv. It is the same as the instance ID displayed on the TencentDB Console page.

    3. Output Parameters

    Parameter Name Type Description
    ProtectMode Integer Data protection mode of the primary instance. Value range: 0 (async replication), 1 (semi-sync replication), 2 (strong sync replication).
    DeployMode Integer Master instance deployment mode. Value range: 0 (single-AZ), 1 (multi-AZ)
    Zone String Instance AZ information in the format of "ap-shanghai-1".
    SlaveConfig SlaveConfig Configurations of the replica node
    Note: null may be returned for this field, indicating that no valid values can be obtained.
    BackupConfig BackupConfig Configurations of the second replica node of a strong-sync instance
    Note: null may be returned for this field, indicating that no valid values can be obtained.
    Switched Boolean This parameter is only available for multi-AZ instances. It indicates whether the source AZ is the same as the one specified upon purchase. true: not the same, false: the same.
    RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

    4. Example

    Example1 Querying the configuration information of a TencentDB instance

    Input Example

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

{
    "InstanceId": "cdb-f35wr6wj"
}

    Output Example

    {
    "Response": {
        "RequestId": "6EF60BEC-0242-43AF-BB20-270359FB54A7",
        "SlaveConfig": {
            "ReplicationMode": "async",
            "Zone": "ap-guangzhou-3"
        },
        "BackupConfig": {
            "ReplicationMode": "sync",
            "Vip": "",
            "Vport": 0,
            "Zone": "ap-guangzhou-3"
        },
        "ProtectMode": 0,
        "Zone": "ap-guangzhou-3",
        "DeployMode": 1,
        "Switched": false
    }
}

    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.
    CdbError Backend or process error.
    InternalError.CdbError System error.
    InternalError.DBOperationError Database operation failed.
    InternalError.InternalHttpServerError An exception occurred while executing the request.
    InternalError.JSONError Failed to parse JSON.
    InternalError.NetworkError Network error
    InternalError.UndefinedError Unknown error
    InternalError.UnknownError Unknown error
    InvalidParameter Parameter error.
    InvalidParameter.ControllerNotFoundError This API was not found.
    InvalidParameter.InstanceNotFound The instance does not exist.
    InvalidParameterValue.InvalidParameterValueError Invalid parameter value
    OperationDenied Operation denied.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy