tencent cloud

TDSQL-C MySQL 版

DescribeLibraDBInstanceDetail

Download
聚焦模式
字号
最后更新时间: 2026-08-20 19:43:38

1. API Description

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

This API is used to query read-only analysis engine details.

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: DescribeLibraDBInstanceDetail.
Version Yes String Common Params. The value used for this API: 2019-01-07.
Region Yes String Common Params. For more information, please see the list of regions supported by the product. This API only supports: ap-bangkok, ap-beijing, ap-chengdu, ap-chongqing, ap-guangzhou, ap-hongkong, ap-jakarta, ap-nanjing, ap-seoul, ap-shanghai, ap-shenzhen-fsi, ap-singapore, ap-tokyo, eu-frankfurt, na-ashburn, na-siliconvalley, sa-saopaulo.
ClusterId Yes String

Cluster ID.

InstanceId Yes String

Read-only analysis engine instance ID

3. Output Parameters

Parameter Name Type Description
Uin String

Root account

AppId Integer

Account unique ID

ClusterId String

Cluster ID.

ClusterName String

Cluster name.

InstanceId String

Instance ID.

InstanceName String

Instance name.

ProjectId Integer

Project ID

Region String

Region.

Zone String

AZ.

Status String

Instance status

StatusDesc String

Status description

LibraDBVersion String

Libra analysis engine version

Cpu Integer

cpu cores.

Memory Integer

Memory size.

Storage Integer

Storage size

StorageType String

Storage type

InstanceType String

Instance type.

InstanceRole String

Instance role

UpdateTime String

Update time.

CreateTime String

Creation time.

PayMode Integer

Selling mode

PeriodStartTime String

Start time

PeriodEndTime String

Termination time

RenewFlag Integer

Renewal flag

NetType Integer

Network type

VpcId String

VPC ID

SubnetId String

Subnet ID.

Vip String

Virtual IP

Vport Integer

Port

InstanceNetInfo InstanceNetInfo

Instance network info

ResourceTags Array of Tag

Instance tag information

NodeInfo Array of LibraDBNodeInfo

Instance node information

NodeCount Integer

Number of instance nodes

AnalysisUpgradeVersionInfo UpgradeAnalysisInstanceVersionInfo

Analyze the information after the instance upgrade version

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 and analyzing instance information

Input Example

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

{
    "ClusterId": "cynosdbmysql-pehkn7u7",
    "InstanceId": "libradb-ins-6hmc6et4"
}

Output Example

{
    "Response": {
        "AppId": 251232065,
        "ClusterId": "cynosdbmysql-pehkn7u7",
"ClusterName": "cynos_libra regression v5.7_Monthly Subscription_202604161238"
        "Cpu": 4,
        "CreateTime": "2026-04-16 12:42:23",
        "InstanceId": "libradb-ins-6hmc6et4",
"InstanceName": "LIBRADB_AUTO_TEST_Monthly Subscription"
        "InstanceNetInfo": {
            "InstanceGroupId": "cynosdbmysql-grp-foszl979",
            "InstanceGroupType": "libradbRo",
            "InternalDomain": "",
            "InternalDomainStatus": "",
            "NetType": 1,
            "SubnetId": "subnet-c8tytrdg",
            "Vip": "10.0.5.177",
            "VpcId": "vpc-d3pif7pp",
            "Vport": 3306,
            "WanDomain": "",
            "WanIP": "",
            "WanPort": 0,
            "WanStatus": "init"
        },
        "InstanceRole": "libradbRo",
        "InstanceType": "common",
        "LibraDBVersion": "5.2512.1.0",
        "Memory": 16,
        "NetType": 0,
        "NodeCount": 1,
        "NodeInfo": [
            {
                "Cpu": 4,
                "DataStatus": "Running",
                "Memory": 16,
                "Message": "",
                "NodeId": "libradbn-0",
                "Status": "normal",
                "Storage": 50
            }
        ],
        "PayMode": 1,
        "PeriodEndTime": "2026-05-16 12:42:22",
        "PeriodStartTime": "2026-04-16 12:42:22",
        "ProjectId": 0,
        "Region": "ap-guangzhou",
        "RenewFlag": 0,
        "ResourceTags": [],
        "Status": "running",
"StatusDesc": "Running"
        "Storage": 50,
        "StorageType": "CLOUD_HSSD",
        "SubnetId": "",
        "Uin": "700000432793",
        "UpdateTime": "2026-04-16 12:45:47",
        "Vip": "",
        "VpcId": "",
        "Vport": 0,
        "Zone": "ap-guangzhou-4",
        "RequestId": "f18a0453-6340-4420-a0a0-a0857e84f4cf"
    }
}

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.DatabaseAccessError Failed to access the database. Please try again later. If the problem persists, please contact customer service.
FailedOperation.FlowCreateError Failed to create a task. Try again later. If the problem persists, contact customer service.
FailedOperation.OperationFailedError Operation failed. Try again later. If the problem persists, contact customer service.
InternalError.DbOperationFailed Failed to query the database.
InvalidParameterValue.InstanceNotFound The instance does not exist.
InvalidParameterValue.PrePayPayModeError This operation is not allowed for yearly/monthly subscribed instances.
OperationDenied.ClusterOpNotAllowedError The current cluster does not allow the operation.
ResourceNotFound.ClusterNotFoundError The cluster does not exist.
ResourceNotFound.ResourceError The resource corresponding to the parameter does not exist.
ResourceUnavailable.InstanceLockFail Failed to lock the instance, so the operation cannot be performed temporarily.
ResourceUnavailable.InstanceStatusAbnormal The instance is exceptional, so the operation cannot be performed temporarily.
UnauthorizedOperation.PermissionDenied CAM authentication failed.

帮助和支持

本页内容是否解决了您的问题?

填写满意度调查问卷,共创更好文档体验。

文档反馈