查询指定云数据库SelectDB版实例的网络信息。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
selectdb:DescribeDBInstanceNetInfo |
none |
*全部资源
|
无 | 无 |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| DBInstanceId |
string |
是 |
实例 ID。 |
selectdb-cn-7213cjv**** |
| RegionId |
string |
是 |
地域 ID。 |
cn-hangzhou |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
Schema of Response。 |
||
| RequestId |
string |
请求 ID。 |
ADF42B18-43FD-5100-83A9-BE81AB70C863 |
| DBInstanceNetInfos |
array<object> |
实例网络信息。 |
|
|
array<object> |
实例网络信息。 |
||
| NetType |
string |
实例的网络类型,取值如下:
|
VPC |
| VpcInstanceId |
string |
VPC 实例 ID。 |
selectdb-cn-h033cnd****-fe-20230816101006 |
| VpcId |
string |
VPC ID。 |
vpc-wz90scxq6ods388ft**** |
| VswitchId |
string |
交换机 ID。 |
vsw-uf6mlqti065rer6m0**** |
| UserVisible |
boolean |
用户是否可见,取值说明:
|
true |
| ConnectionString |
string |
连接地址。 |
selectdb-cn-h033cnd****-fe.selectdbfe.pre.rds.aliyuncs.com |
| Ip |
string |
IP 地址。 |
172.16.XX.XX |
| PortList |
array<object> |
端口对象。 |
|
|
object |
端口详情。 |
||
| Protocol |
string |
端口类型,取值说明:
|
9030 |
| Port |
integer |
连接端口号。 |
MySQLPort |
| ClusterId |
string |
集群 ID。 |
selectdb-cn-****-be |
| DBClustersNetInfos |
array<object> |
BE 实例的网络列表。 |
|
|
array<object> |
BE 实例的网络信息。 |
||
| NetType |
string |
网络类型。 |
VPC/PUBLIC |
| VpcInstanceId |
string |
VPC 实例 ID。 |
selectdb-cn-****-fe-20230816101006 |
| VpcId |
string |
VPC ID。 |
vpc-**** |
| VswitchId |
string |
交换机 ID。 |
vsw-**** |
| UserVisible |
boolean |
用户是否可见。 |
true/false |
| ConnectionString |
string |
连接地址。 |
selectdb-cn-****-fe.selectdbfe.pre.rds.aliyuncs.com |
| Ip |
string |
IP 地址。 |
8.131.***.*** |
| PortList |
array<object> |
端口列表。 |
|
|
object |
端口信息。 |
||
| Protocol |
string |
端口类型。 |
MySQLPort/HttpPort |
| Port |
integer |
连接端口号。 |
9030/8080 |
| ClusterId |
string |
集群 ID。 |
selectdb-cn-****-be |
示例
正常返回示例
JSON格式
{
"RequestId": "ADF42B18-43FD-5100-83A9-BE81AB70C863",
"DBInstanceNetInfos": [
{
"NetType": "VPC",
"VpcInstanceId": "selectdb-cn-h033cnd****-fe-20230816101006",
"VpcId": "vpc-wz90scxq6ods388ft****",
"VswitchId": "vsw-uf6mlqti065rer6m0****",
"UserVisible": true,
"ConnectionString": "selectdb-cn-h033cnd****-fe.selectdbfe.pre.rds.aliyuncs.com",
"Ip": "172.16.XX.XX",
"PortList": [
{
"Protocol": "9030",
"Port": 0
}
],
"ClusterId": "selectdb-cn-****-be"
}
],
"DBClustersNetInfos": [
{
"NetType": "VPC/PUBLIC",
"VpcInstanceId": "selectdb-cn-****-fe-20230816101006",
"VpcId": "vpc-****",
"VswitchId": "vsw-****",
"UserVisible": true,
"ConnectionString": "selectdb-cn-****-fe.selectdbfe.pre.rds.aliyuncs.com",
"Ip": "8.131.***.***",
"PortList": [
{
"Protocol": "MySQLPort/HttpPort",
"Port": 0
}
],
"ClusterId": "selectdb-cn-****-be"
}
]
}
错误码
|
HTTP status code |
错误码 |
错误信息 |
描述 |
|---|---|---|---|
| 400 | DocumentConvertFailed.ExceedFileSizeLimit | The conversion has been failed, exceed file size limit. | 文档转换失败,文件大小超过系统限额。 |
| 400 | Forbidden | User not authorized to operate on the specified resource, or this API does not support RAM. | 子账号权限不足,请先获取授权。 |
| 400 | InvalidDBName | The specified database name is not allowed. | 数据库名称不符合要求,请确认数据名称是否正确。 |
| 400 | CreateOrderFailed | Failed to create order. | 创建订单失败。 |
| 403 | DBClusterNotSupported | The requested operation can not be performed while the cluster is not sale. | 当集群未运行时,无法执行请求的操作。 |
| 403 | IncorrectDBInstanceState | Current DB instance state does not support this operation. | 当前实例状态不支持此操作。 |
| 403 | InstanceEngineType.NotSupport | The instance engine and type does not support operations. | 操作失败,实例引擎和类型不支持该操作。 |
| 403 | InvalidDBInstanceState.NotSupport | The specified instance state does't support this operation. | 指定的实例状态不支持此操作。 |
| 403 | MoneyLessThan100 | The Account Monet less Than 100. | 当前阿里云账号余额不足100,请充值。 |
| 403 | OperationDenied.DBNameAndAccountPrivilegeCount | The operation is not permitted due to count of database or account privilege. | 操作失败,数据库与权限的数量不一致。 |
| 403 | InsufficientResourceCapacity | The resource is out of usage. | 资源不足,请您稍后再试。 |
| 404 | InvalidDBInstanceId.NotFound | The DBInstanceId provided does not exist in our records. | SelectDB实例不存在。 |
| 404 | InvalidClusterInstance.NotFound | Specified cluster instance does not exist. | SelectDB实例不存在。 |
| 404 | DBInstanceLocked | The current instance lock mode does not support this operation. | 操作失败,当前实例已锁定。 |
| 404 | IncorrectVswitchId | The specified parameter VSwitchId is not valid. | 交换机参数无效。 |
| 404 | InvalidApi.NotFound | Specified api is not found, please check your url and method. | |
| 404 | InvalidDBInstance.NotFound | The specified instance is not found. | 没有找到指定的实例,请检查实例的正确性。 |
| 404 | InvalidDBInstanceClass.NotFound | The specified instance classic does not exist. | 当前选择的配置或规格不存在或已停售,请重新选择。 |
| 404 | InvalidRegionId.NotFound | The provided RegionId does not exist in our records. | 操作失败,输入的地域及可用区不存在。 |
| 404 | QueryPrice.Failed | The inquiry failed. Contact Alibaba Cloud customer service representatives. | 询价失败,请联系客服同学。 |
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。