tencent cloud

APIs

文档APIsTDSQL-C for MySQLRead-Only Analysis Engine APIsDescribeLibraDBInstanceDetail

DescribeLibraDBInstanceDetail

下载
聚焦模式
字号
最后更新时间： 2026-05-29 10:54:46

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


Note: This field may return null, indicating that no valid values can be obtained.
AppId Integer

Account unique ID


Note: This field may return null, indicating that no valid values can be obtained.
ClusterId String

Cluster ID.


Note: This field may return null, indicating that no valid values can be obtained.
ClusterName String

Cluster name.


Note: This field may return null, indicating that no valid values can be obtained.
InstanceId String

Instance ID.


Note: This field may return null, indicating that no valid values can be obtained.
InstanceName String

Instance name.


Note: This field may return null, indicating that no valid values can be obtained.
ProjectId Integer

Project ID.


Note: This field may return null, indicating that no valid values can be obtained.
Region String

Region


Note: This field may return null, indicating that no valid values can be obtained.
Zone String

AZ.


Note: This field may return null, indicating that no valid values can be obtained.
Status String

Instance status.


Note: This field may return null, indicating that no valid values can be obtained.
StatusDesc String

Status description


Note: This field may return null, indicating that no valid values can be obtained.
LibraDBVersion String

Libra analysis engine version


Note: This field may return null, indicating that no valid values can be obtained.
Cpu Integer

cpu cores


Note: This field may return null, indicating that no valid values can be obtained.
Memory Integer

Memory size


Note: This field may return null, indicating that no valid values can be obtained.
Storage Integer

Storage size


Note: This field may return null, indicating that no valid values can be obtained.
StorageType String

Storage type


Note: This field may return null, indicating that no valid values can be obtained.
InstanceType String

Instance type


Note: This field may return null, indicating that no valid values can be obtained.
InstanceRole String

Instance role


Note: This field may return null, indicating that no valid values can be obtained.
UpdateTime String

Update time.


Note: This field may return null, indicating that no valid values can be obtained.
CreateTime String

Creation time.


Note: This field may return null, indicating that no valid values can be obtained.
PayMode Integer

Selling mode


Note: This field may return null, indicating that no valid values can be obtained.
PeriodStartTime String

Start time


Note: This field may return null, indicating that no valid values can be obtained.
PeriodEndTime String

End time of sale


Note: This field may return null, indicating that no valid values can be obtained.
RenewFlag Integer

Renewal flag


Note: This field may return null, indicating that no valid values can be obtained.
NetType Integer

Network type


Note: This field may return null, indicating that no valid values can be obtained.
VpcId String

VPC ID


Note: This field may return null, indicating that no valid values can be obtained.
SubnetId String

Subnet ID.


Note: This field may return null, indicating that no valid values can be obtained.
Vip String

Virtual IP


Note: This field may return null, indicating that no valid values can be obtained.
Vport Integer

Port


Note: This field may return null, indicating that no valid values can be obtained.
InstanceNetInfo InstanceNetInfo

Instance network information


Note: This field may return null, indicating that no valid values can be obtained.
ResourceTags Array of Tag

Instance tag information


Note: This field may return null, indicating that no valid values can be obtained.
NodeInfo Array of LibraDBNodeInfo

Instance node information
NodeCount Integer

Number of instance nodes
AnalysisUpgradeVersionInfo UpgradeAnalysisInstanceVersionInfo

Analyze the information after instance upgrade version


Note: This field may return null, indicating that no valid values can be obtained.
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 analysis instance info

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",
            "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.
上一篇: AddLibraDBInstances下一篇: DescribeLibraDBInstanceSpecs

帮助和支持

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

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

文档反馈