tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeDCDBInstanceDetail

Last updated: 2024-07-19 14:30:33

    1. API Description

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

    This API is used to get the details of a TDSQL 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: DescribeDCDBInstanceDetail.
    Version Yes String Common Params. The value used for this API: 2018-04-11.
    Region No String Common Params. This parameter is not required for this API.
    InstanceId Yes String Instance ID, such as dcdbt-7oaxtcb7.

    3. Output Parameters

    Parameter Name Type Description
    InstanceId String Instance ID, such as dcdbt-7oaxtcb7.
    InstanceName String Instance name
    Status Integer Instance status. Valid values: 0 (creating), 1 (running task), 2 (running), 3 (uninitialized), -1 (isolated).
    StatusDesc String Current status of the instance
    Vip String Instance private IP address
    Vport Integer Private port of instance
    NodeCount Integer Number of instance nodes. Valid values: 2 (1-source-1-replica), 3 (1-source-2-replica).
    Region String Instance region, such as ap-guangzhou.
    VpcId String Instance VPC ID, such as vpc-r9jr0de3.
    SubnetId String VPC subnet ID of an instance, such as subnet-6rqs61o2.
    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 access port
    ProjectId Integer Project ID of the instance
    AutoRenewFlag Integer Automatic renewal flag for an instance. Valid values: 0 (normal renewal), 1 (auto-renewal), 3 (no renewal upon expiration).
    ExclusterId String Dedicated cluster ID
    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
    PeriodEndTime Timestamp Expiration time of the instance in the format of 2006-01-02 15:04:05
    DbVersion String Database version information
    IsAuditSupported Integer Whether the instance supports audit. Valid values: 1 (yes), 0 (no).
    IsEncryptSupported Integer Whether data encryption is supported for an instance. Valid values: 1 (yes), 0 (no).
    Machine String Instance machine model
    Memory Integer Instance memory size in GB, which is the sum of the memory of all shards.
    Storage Integer Instance disk storage size in GB, which is the sum of the disk size of all shards.
    StorageUsage Float Instance storage space utilization. It is calculated by dividing the sum of the used disk size of all shards by the total disk size of all shards.
    LogStorage Integer Size of log storage space in GB
    Pid Integer Product type ID
    MasterZone String Source AZ
    SlaveZones Array of String Replica AZ
    Shards Array of ShardBriefInfo Shard information
    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.
    Note: This field may return null, indicating that no valid values can be obtained.
    Qps Integer Instance QPS
    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.
    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.
    ResourceTags Array of ResourceTag Tag information
    DcnFlag Integer DCN type. Valid values: 0 (N/A), 1 (source 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 The number of DCN disaster recovery 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.
    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.
    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 the TDSQL instance dcdbt-21dfpcv1.

    Input Example

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

{
    "InstanceId": "dcdbt-21dfpcv1"
}

    Output Example

    {
    "Response": {
        "AutoRenewFlag": 0,
        "Cpu": 3,
        "CreateTime": "2016-07-13 11:08:38",
        "DbEngine": "MariaDB",
        "DbVersion": "10.0.10",
        "DcnDstNum": 0,
        "DcnFlag": 0,
        "DcnStatus": 0,
        "ExclusterId": "",
        "InstanceId": "dcdbt-21dfpcv1",
        "InstanceName": "dcdbt-21dfpcv1",
        "InstanceType": 2,
        "Ipv6Flag": 0,
        "IsAuditSupported": 1,
        "IsEncryptSupported": 0,
        "LogStorage": 16,
        "Machine": "TS85",
        "MasterZone": "ap-guangzhou-1",
        "Memory": 6,
        "NodeCount": 2,
        "PayMode": "prepaid",
        "PeriodEndTime": "2023-01-01 11:12:24",
        "Pid": 1001670,
        "ProjectId": 0,
        "Qps": 4000,
        "Region": "ap-guangzhou",
        "RequestId": "e1828feb-9a21-409a-8964-309215615d84",
        "ResourceTags": [],
        "Shards": [
            {
                "Cpu": 2,
                "CreateTime": "2021-12-01 11:49:54",
                "LogDisk": 8,
                "Memory": 4,
                "NodeCount": 2,
                "NodesInfo": [
                    {
                        "NodeId": "85409b834943",
                        "Role": "master"
                    },
                    {
                        "NodeId": "9de9c0321ccd",
                        "Role": "slave"
                    }
                ],
                "ProxyVersion": "\"1.17.6-M-V2.0R723D002\"",
                "ShardInstanceId": "shard-ngbrea6b",
                "ShardMasterZone": "ap-guangzhou-1",
                "ShardSerialId": "set_1643096858_1",
                "ShardSlaveZones": [
                    "ap-guangzhou-1"
                ],
                "Status": 2,
                "StatusDesc": "Running",
                "Storage": 10,
                "StorageUsage": 0.01
            },
            {
                "Cpu": 1,
                "CreateTime": "2021-12-01 11:49:54",
                "LogDisk": 8,
                "Memory": 2,
                "NodeCount": 2,
                "NodesInfo": [
                    {
                        "NodeId": "1e2025d21782",
                        "Role": "master"
                    },
                    {
                        "NodeId": "b228c46e9b63",
                        "Role": "slave"
                    }
                ],
                "ProxyVersion": "\"1.17.6-M-V2.0R723D002\"",
                "ShardInstanceId": "shard-5zf65smf",
                "ShardMasterZone": "ap-guangzhou-1",
                "ShardSerialId": "set_1643096949_3",
                "ShardSlaveZones": [
                    "ap-guangzhou-1"
                ],
                "Status": 2,
                "StatusDesc": "Running",
                "Storage": 10,
                "StorageUsage": 0.011
            }
        ],
        "SlaveZones": [
            "ap-guangzhou-1"
        ],
        "Status": 2,
        "StatusDesc": "Running",
        "Storage": 20,
        "StorageUsage": 0.0105,
        "SubnetId": "subnet-ovkcc9x6",
        "Vip": "10.1.0.5",
        "Vip6": "",
        "VpcId": "vpc-j97vcvb5",
        "Vport": 3306,
        "WanDomain": "",
        "WanPort": 0,
        "WanPortIpv6": 0,
        "WanStatus": 0,
        "WanStatusIpv6": 0,
        "WanVip": "",
        "WanVipv6": "",
        "IsMaxUserConnectionsSupported": true,
        "DbVersionId": "5.7",
        "EncryptStatus": 0,
        "ExclusterType": 0,
        "RsAccessStrategy": 0,
        "ReservedNetResources": [
            {
                "VpcId": "vpc-p6alckzx",
                "SubnetId": "subnet-3pz073lq",
                "Vip": "172.16.0.40",
                "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
    FailedOperation.OssOperationFailed Failed to request the backend API.
    InternalError.GetSubnetFailed Failed to query the VPC subnet information.
    InternalError.OperateDatabaseFailed Database operation failed.
    InvalidParameter Parameter error.
    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