DescribeDBInstanceNetInfo - 查询实例网络信息_云数据库 SelectDB 版(SelectDB)-阿里云帮助中心

查询指定云数据库SelectDB版实例的网络信息。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

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	实例网络信息。
NetType	string	实例的网络类型，取值如下： VPC：表示专有网络 VPC。 PUBLIC：表示公网。	VPC
VpcInstanceId	string	VPC 实例 ID。	selectdb-cn-h033cnd****-fe-20230816101006
VpcId	string	VPC ID。	vpc-wz90scxq6ods388ft****
VswitchId	string	交换机 ID。	vsw-uf6mlqti065rer6m0****
UserVisible	boolean	用户是否可见，取值说明： true：用户可见。 false：用户不可见。	true
ConnectionString	string	连接地址。	selectdb-cn-h033cnd****-fe.selectdbfe.pre.rds.aliyuncs.com
Ip	string	IP 地址。	172.16.XX.XX
PortList	array	端口对象。
	object	端口详情。
Protocol	string	端口类型，取值说明： HttpPort：Http 协议端口。 MySQLPort：MySQL 协议端口。	9030
Port	integer	连接端口号。	MySQLPort
ClusterId	string	集群 ID。	selectdb-cn-****-be
DBClustersNetInfos	array	BE 实例的网络列表。
	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	端口信息。
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.
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.
404	InvalidClusterInstance.NotFound	Specified cluster instance does not exist.
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.

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。