通过实例的连接地址获取实例的基本信息
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
polardbx:DescribeDBInstanceViaEndpoint |
none |
*全部资源
|
无 | 无 |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| Endpoint |
string |
是 |
实例的连接地址。 |
pxc-hz*******.polarx.rds.aliyuncs.com |
| RegionId |
string |
是 |
地域 ID。 |
cn-hangzhou |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
|||
| RequestId |
string |
请求 ID。 |
14036EBE-CF2E-44DB-ACE9-AC6157D3A6FC |
| DBInstance |
object |
实例信息 |
|
| Type |
string |
实例类型：
|
ReadWrite |
| Status |
string |
实例状态，详情请参见实例状态表。 |
Running |
| RightsSeparationStatus |
string |
三权分立状态：
|
disabled |
| DBNodeCount |
integer |
实例节点数量。 |
2 |
| Expired |
string |
是否过期：
|
false |
| CreateTime |
string |
创建时间。 |
2021-08-31T08:56:25.000+0000 |
| PayType |
string |
实例付费方式，取值：
|
Postpaid |
| Port |
string |
实例连接端口 |
3306 |
| LockMode |
string |
实例锁定模式：
|
Unlock |
| Description |
string |
实例描述。 |
test instance |
| ConnectionString |
string |
实例连接地址 |
pxc-sprpx766vo****.polarx.singapore.rds.aliyuncs.com |
| StorageUsed |
integer |
已经使用的存储，单位为 B。 |
17042505728 |
| ExpireDate |
string |
到期时间。格式为 yyyy-MM-ddTHH:mm:ss.sss+0000（UTC 时间）。 |
2022-08-31T16:00:00.000+0000 |
| CommodityCode |
string |
实例商品种类，固定取值为 drds_polarxpost_public_cn。 |
drds_polarxpost_public_cn |
| MaintainStartTime |
string |
实例可维护开始时间，此处为 UTC 时间，加 8 小时才是控制台上显示的可维护时间段。 |
06:00 |
| DBInstanceType |
string |
实例类型：
|
ReadWrite |
| DBNodeClass |
string |
实例节点规格。 |
polarx.x4.large.2e |
| LatestMinorVersion |
string |
当前实例支持的最新内核版本。 |
polarx-kernel_5.4.11-16301083_xcluster-20210805 |
| MaintainEndTime |
string |
实例可维护结束时间，此处为 UTC 时间，加 8 小时为控制台上显示的可维护时间段。 |
06:00 |
| DBType |
string |
数据库类型，固定取值为 polarx。 |
polarx |
| RightsSeparationEnabled |
boolean |
三权分立状态：
|
false |
| VPCId |
string |
VPC ID。 |
vpc-xxxxx |
| MinorVersion |
string |
当前内核版本。 |
polarx-kernel_5.4.11-16301083_xcluster-20210805 |
| RegionId |
string |
实例所在地域。 |
cn-hangzhou |
| Network |
string |
实例的网络类型，仅支持取值 VPC，表示专有网络。 |
VPC |
| DBVersion |
string |
数据库版本。 |
5.5 |
| VSwitchId |
string |
交换机 ID。 |
vsw-******** |
| ZoneId |
string |
实例所在可用区。 |
cn-hangzhou-a |
| Engine |
string |
数据库类型，固定取值为 MySQL。 |
MySQL |
| KindCode |
integer |
实例引擎版本，内部参数。 |
18 |
| Id |
string |
主实例的 ID，如果没有返回此参数则表示该实例是主实例。 |
pxc-zkralxpc5d**** |
| DBNodes |
array<object> |
数据库节点信息。 |
|
|
object |
数据库节点信息。 |
||
| ComputeNodeId |
string |
计算节点名称。 |
pxc-i-******** |
| NodeClass |
string |
节点规格。 |
polarx.x4.large.2e |
| DataNodeId |
string |
存储节点名称。 |
pxc-xdb-xxxxxx |
| ZoneId |
string |
节点所在可用区名称。 |
cn-hangzhou-a |
| Id |
string |
逻辑节点 ID。 |
pxi-********* |
| RegionId |
string |
节点所在地域 ID。 |
cn-hangzhou |
| ConnAddrs |
array<object> |
连接地址信息。 |
|
|
object |
连接地址信息。 |
||
| Type |
string |
连接的种类，VPC 为内网连接，PUBLIC 为公网连接。 |
VPC |
| VSwitchId |
string |
交换机 ID。 |
vsw-********* |
| Port |
integer |
连接端口号。 |
3306 |
| VPCId |
string |
VPC ID。 |
vpc-xxxxxx |
| ConnectionString |
string |
连接地址。 |
polardbx-xxx.aliyuncs.com |
| VpcInstanceId |
string |
vpc 内部 CloudInstanceId，可以忽略 |
pxc-zkralxpc5d**** |
| ReadDBInstances |
array |
只读实例名称。 |
|
|
string |
只读实例名称。 |
pxr-********* |
|
| ResourceGroupId |
string |
资源组 ID |
rg-xxxx |
| TagSet |
array<object> |
标签集合 |
|
|
object |
标签集合。 |
||
| Key |
string |
标签名称 |
key2 |
| Value |
string |
标签值 |
value2 |
| CnNodeCount |
integer |
CN 节点数量。 |
2 |
| DnNodeCount |
integer |
DN 节点数量。 |
2 |
| CnNodeClassCode |
string |
CN 节点规格：
|
polarx.x4.xlarge.2e |
| DnNodeClassCode |
string |
DN 节点规格：
|
mysql.x8.large.25 |
| Series |
string |
实例系列，取值如下：
|
enterprise |
| LTSVersions |
array |
LTS 版本号。 |
|
|
string |
LTS 版本号。 |
X.X.X.X |
示例
正常返回示例
JSON格式
{
"RequestId": "14036EBE-CF2E-44DB-ACE9-AC6157D3A6FC",
"DBInstance": {
"Type": "ReadWrite",
"Status": "Running",
"RightsSeparationStatus": "disabled",
"DBNodeCount": 2,
"Expired": "false",
"CreateTime": "2021-08-31T08:56:25.000+0000",
"PayType": "Postpaid",
"Port": "3306",
"LockMode": "Unlock",
"Description": "test instance",
"ConnectionString": "pxc-sprpx766vo****.polarx.singapore.rds.aliyuncs.com",
"StorageUsed": 17042505728,
"ExpireDate": "2022-08-31T16:00:00.000+0000",
"CommodityCode": "drds_polarxpost_public_cn",
"MaintainStartTime": "06:00",
"DBInstanceType": "ReadWrite",
"DBNodeClass": "polarx.x4.large.2e",
"LatestMinorVersion": "polarx-kernel_5.4.11-16301083_xcluster-20210805",
"MaintainEndTime": "06:00",
"DBType": "polarx",
"RightsSeparationEnabled": false,
"VPCId": "vpc-xxxxx",
"MinorVersion": "polarx-kernel_5.4.11-16301083_xcluster-20210805",
"RegionId": "cn-hangzhou",
"Network": "VPC",
"DBVersion": "5.5",
"VSwitchId": "vsw-********",
"ZoneId": "cn-hangzhou-a",
"Engine": "MySQL",
"KindCode": 18,
"Id": "pxc-zkralxpc5d****",
"DBNodes": [
{
"ComputeNodeId": "pxc-i-********",
"NodeClass": "polarx.x4.large.2e",
"DataNodeId": "pxc-xdb-xxxxxx",
"ZoneId": "cn-hangzhou-a",
"Id": "pxi-*********",
"RegionId": "cn-hangzhou"
}
],
"ConnAddrs": [
{
"Type": "VPC",
"VSwitchId": "vsw-*********",
"Port": 3306,
"VPCId": "vpc-xxxxxx",
"ConnectionString": "polardbx-xxx.aliyuncs.com",
"VpcInstanceId": "pxc-zkralxpc5d****"
}
],
"ReadDBInstances": [
"pxr-*********"
],
"ResourceGroupId": "rg-xxxx",
"TagSet": [
{
"Key": "key2",
"Value": "value2"
}
],
"CnNodeCount": 2,
"DnNodeCount": 2,
"CnNodeClassCode": "polarx.x4.xlarge.2e",
"DnNodeClassCode": "mysql.x8.large.25",
"Series": "enterprise",
"LTSVersions": [
"X.X.X.X"
]
}
}错误码
访问错误中心查看更多错误码。
变更历史
更多信息，参考变更详情。