tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeDBInstanceDetail

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

    1. API Description

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

    This API is used to query the details of a specified instance.

    A maximum of 200 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: DescribeDBInstanceDetail.
    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 in the format of tdsql-ow728lmc

    3. Output Parameters

    Parameter Name Type Description
    InstanceId String Instance ID
    InstanceName String Instance name
    Status Integer Instance status
    StatusDesc String Current status of the instance
    Vip String Private IP address
    Vport Integer Private port
    IsTmp Integer Whether it is a temp instance. Valid values: 0 (no), non-zero value (yes).
    NodeCount Integer Number of nodes. Valid values: 2 (1 primary-1 replica), 3 (1 primary-2 replicas).
    Region String Instance region name, such as ap-shanghai.
    Zone String Instance AZ name, such as ap-guangzhou-1.
    VpcId String VPC ID in string type
    SubnetId String VPC subnet ID in string type
    WanStatus Integer Public network status. Valid values: 0 (not enabled), 1 (enabled), 2 (disabled), 3: (enabling), 4 (disabling).
    WanDomain String Domain name for public network access, which can be resolved by the public network.
    WanVip String Public IP address, which can be accessed over the public network.
    WanPort Integer Public network port
    ProjectId Integer Project ID of the instance
    TdsqlVersion String TDSQL version information
    Memory Integer Instance memory capacity in GB
    Storage Integer Instance storage capacity in GB
    MasterZone String Primary AZ, such as ap-shanghai-1.
    SlaveZones Array of String List of replica AZs, such as ap-shanghai-2.
    AutoRenewFlag Integer Auto-renewal flag. Valid values: 0 (no), 1 (yes).
    ExclusterId String Dedicated cluster ID, which is empty for a non-dedicated cluster instance.
    PayMode String Billing mode. Valid values: prepaid (monthly subscription), postpaid (pay-as-you-go).
    CreateTime Timestamp Creation time of the instance in the format of 2006-01-02 15:04:05
    IsAuditSupported Boolean Whether the instance supports audit
    PeriodEndTime Timestamp Expiration time of the instance in the format of 2006-01-02 15:04:05
    Machine String Model information
    StorageUsage String Storage space utilization
    LogStorage Integer Size of log storage space in GB
    IsEncryptSupported Integer Whether data encryption is supported. Valid values: 1 (yes), 0: (no).
    Vip6 String Private network IPv6 address
    Note: This field may return null, indicating that no valid values can be obtained.
    Cpu Integer Number of CPU cores of an instance.
    Pid Integer Product type ID
    Qps Integer Max QPS
    Ipv6Flag Integer Whether IPv6 is supported.
    Note: This field may return null, indicating that no valid values can be obtained.
    WanVipv6 String Public IPv6 address, which can be accessed over the public network
    Note: This field may return null, indicating that no valid values can be obtained.
    WanStatusIpv6 Integer Public network status. Valid values: 0 (not enabled), 1 (enabled), 2 (disabled), 3: (enabling), 4 (disabling).
    Note: This field may return null, indicating that no valid values can be obtained.
    WanPortIpv6 Integer Public network IPv6 port
    Note: This field may return null, indicating that no valid values can be obtained.
    DbEngine String Database engine
    Note: This field may return null, indicating that no valid values can be obtained.
    DbVersion String Database version
    Note: This field may return null, indicating that no valid values can be obtained.
    ResourceTags Array of ResourceTag Tag information
    DcnFlag Integer DCN type. Valid values: 0 (N/A), 1 (primary instance), 2 (disaster recovery read-only instance)
    Note: This field may return null, indicating that no valid values can be obtained.
    DcnStatus Integer DCN status. Valid values: 0 (N/A), 1 (creating), 2 (syncing), 3 (disconnected)
    Note: This field may return null, indicating that no valid values can be obtained.
    DcnDstNum Integer Number of disaster recovery read-only instances
    Note: This field may return null, indicating that no valid values can be obtained.
    InstanceType Integer Instance type. Valid values: 1 (dedicated primary instance), 2 (non-dedicated primary instance), 3 (non-dedicated disaster recovery read-only instance), 4 (dedicated disaster recovery read-only instance)
    Note: This field may return null, indicating that no valid values can be obtained.
    NodesInfo Array of NodeInfo Instance node information
    Note: This field may return null, indicating that no valid values can be obtained.
    IsMaxUserConnectionsSupported Boolean Whether the instance supports setting the connection limit, which is not supported for kernel version 10.1.
    Note: This field may return null, indicating that no valid values can be obtained.
    DbVersionId String The displayed database version
    Note: This field may return null, indicating that no valid values can be obtained.
    EncryptStatus Integer Encryption status. Valid values: 0 (disabled), 1 (enabled).
    Note: This field may return null, indicating that no valid values can be obtained.
    ReplicaConfig DCNReplicaConfig Configuration information of DCN
    Note: This field may return null, indicating that no valid values can be obtained.
    ReplicaStatus DCNReplicaStatus Running status of DCN
    Note: This field may return null, indicating that no valid values can be obtained.
    ExclusterType Integer Type of dedicated cluster. Valid values: 0 (public cloud), 1 (finance cage), 2 (CDC cluster).
    Note: This field may return null, indicating that no valid values can be obtained.
    RsAccessStrategy Integer Nearby VPC access
    Note: This field may return null, indicating that no valid values can be obtained.
    ReservedNetResources Array of ReservedNetResource Unclaimed network resource
    IsPhysicalReplicationSupported Boolean Whether physical replication is supported.
    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 details of an instance

    This example shows you how to query the details of a centralized (non-distributed) instance.

    Input Example

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

{
    "InstanceId": "tdsql-h178kq75"
}

    Output Example

    {
    "Response": {
        "AutoRenewFlag": 0,
        "Cpu": 1,
        "CreateTime": "2023-02-27 17:58:50",
        "DbEngine": "MySQL",
        "DbVersion": "8.0.24",
        "DbVersionId": "8.0",
        "DcnDstNum": 1,
        "DcnFlag": 1,
        "DcnStatus": 2,
        "EncryptStatus": 0,
        "ExclusterId": "",
        "ExclusterType": 0,
        "InstanceId": "tdsql-h178kq75",
        "InstanceName": "cdz",
        "InstanceType": 2,
        "Ipv6Flag": 0,
        "IsAuditSupported": true,
        "IsEncryptSupported": 0,
        "IsMaxUserConnectionsSupported": true,
        "IsTmp": 0,
        "LogStorage": 8,
        "Machine": "TS85",
        "MasterZone": "ap-guangzhou-3",
        "Memory": 2,
        "NodeCount": 2,
        "NodesInfo": [
            {
                "NodeId": "60af5538060f",
                "Role": "master"
            },
            {
                "NodeId": "12c58811dbfd",
                "Role": "slave"
            }
        ],
        "PayMode": "postpaid",
        "PeriodEndTime": "0001-01-01 00:00:00",
        "Pid": 1002231,
        "ProjectId": 0,
        "Qps": 2100,
        "Region": "ap-guangzhou",
        "ReplicaConfig": null,
        "ReplicaStatus": null,
        "RequestId": "40b4a902-5217-4e18-8db1-10e0ff01be62",
        "ResourceTags": [],
        "RsAccessStrategy": 0,
        "SlaveZones": [
            "ap-guangzhou-3"
        ],
        "Status": 2,
        "StatusDesc": "Running",
        "Storage": 10,
        "StorageUsage": "0.010",
        "SubnetId": "subnet-8ve8m3xy",
        "TdsqlVersion": "Designed based on MySQL 8.0.24 (compatible with MySQL 8.0)Mysql 8.0)",
        "Vip": "10.1.0.13",
        "Vip6": "",
        "VpcId": "vpc-0rjtvrlz",
        "Vport": 3306,
        "WanDomain": "",
        "WanPort": 0,
        "WanPortIpv6": 0,
        "WanStatus": 0,
        "WanStatusIpv6": 0,
        "WanVip": "",
        "WanVipv6": "",
        "Zone": "ap-guangzhou-3",
        "ReservedNetResources": [
            {
                "VpcId": "vpc-5rske1or",
                "SubnetId": "subnet-0z3os0xe",
                "Vip": "10.1.0.6",
                "Vports": [
                    3306
                ],
                "RecycleTime": "2023-05-19 16:12:32"
            }
        ],
        "IsPhysicalReplicationSupported": true
    }
}

    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
    InternalError.DbOperationFailed Failed to query the database.
    InternalError.GetInstanceDetailFailed Failed to get the instance details.
    InternalError.GetSubnetFailed Failed to query the VPC subnet information.
    InternalError.OperateDatabaseFailed Database operation failed.
    InvalidParameter.InstanceNotFound Failed to find the requested instance.
    UnauthorizedOperation.PermissionDenied You have no permission to manipulate this API or resource.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy