DescribeDBInstanceNetInfo - ApsaraDB for SelectDB - Alibaba Cloud Documentation Center

Queries the network information for a specified SelectDB instance.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

selectdb:DescribeDBInstanceNetInfo

none

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
DBInstanceId	string	Yes	The instance ID.	selectdb-cn-7213cjv****
RegionId	string	Yes	The region ID.	cn-hangzhou

Response elements

Element	Type	Description	Example
	object	The response schema.
RequestId	string	The request ID.	ADF42B18-43FD-5100-83A9-BE81AB70C863
DBInstanceNetInfos	array<object>	The network information of the instance.
	array<object>	The network information of the instance.
NetType	string	The network type of the instance. Valid values: VPC: Virtual Private Cloud (VPC) PUBLIC: public network	VPC
VpcInstanceId	string	The VPC instance ID.	selectdb-cn-h033cnd****-fe-20230816101006
VpcId	string	The VPC ID.	vpc-wz90scxq6ods388ft****
VswitchId	string	The vSwitch ID.	vsw-uf6mlqti065rer6m0****
UserVisible	boolean	Indicates whether the endpoint is visible to the user. Valid values: true: The endpoint is visible. false: The endpoint is not visible.	true
ConnectionString	string	The endpoint.	selectdb-cn-h033cnd****-fe.selectdbfe.pre.rds.aliyuncs.com
Ip	string	The IP address.	172.16.XX.XX
PortList	array<object>	The port object.
	object	The port details.
Protocol	string	The protocol type of the port. Valid values: HttpPort: HTTP protocol port. MySQLPort: MySQL protocol port.	9030
Port	integer	The port number.	MySQLPort
ClusterId	string	The cluster ID.	selectdb-cn-****-be
DBClustersNetInfos	array<object>	A list of network information for the BE cluster.
	array<object>	The network information of the BE cluster.
NetType	string	The network type.	VPC/PUBLIC
VpcInstanceId	string	The VPC instance ID.	selectdb-cn-****-fe-20230816101006
VpcId	string	The VPC ID.	vpc-****
VswitchId	string	The vSwitch ID.	vsw-****
UserVisible	boolean	Indicates whether the endpoint is visible to the user.	true/false
ConnectionString	string	The endpoint.	selectdb-cn-****-fe.selectdbfe.pre.rds.aliyuncs.com
Ip	string	The IP address.	8.131.*.*
PortList	array<object>	A list of ports.
	object	The port information.
Protocol	string	The protocol type of the port.	MySQLPort/HttpPort
Port	integer	The port number.	9030/8080
ClusterId	string	The cluster ID.	selectdb-cn-****-be

Examples

Success response

JSON format

{
  "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"
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
400	DocumentConvertFailed.ExceedFileSizeLimit	The conversion has been failed, exceed file size limit.	english description1
400	Forbidden	User not authorized to operate on the specified resource, or this API does not support RAM.	english description1
400	InvalidDBName	The specified database name is not allowed.	english description1
400	CreateOrderFailed	Failed to create order.	Failed to create order.
403	DBClusterNotSupported	The requested operation can not be performed while the cluster is not sale.	The requested operation cannot be performed while the cluster is not running.
403	IncorrectDBInstanceState	Current DB instance state does not support this operation.	english description1
403	InstanceEngineType.NotSupport	The instance engine and type does not support operations.	english description1
403	InvalidDBInstanceState.NotSupport	The specified instance state does't support this operation.	The instance is in a state that does not support the current operation.
403	MoneyLessThan100	The Account Monet less Than 100.	english description1
403	OperationDenied.DBNameAndAccountPrivilegeCount	The operation is not permitted due to count of database or account privilege.	english description1
403	InsufficientResourceCapacity	The resource is out of usage.	Not enough resources, please try again later.
404	InvalidDBInstanceId.NotFound	The DBInstanceId provided does not exist in our records.	Instance does not exist.
404	InvalidClusterInstance.NotFound	Specified cluster instance does not exist.	SelectDB instance does not exist.
404	DBInstanceLocked	The current instance lock mode does not support this operation.	english description1
404	IncorrectVswitchId	The specified parameter VSwitchId is not valid.	english description1
404	InvalidApi.NotFound	Specified api is not found, please check your url and method.
404	InvalidDBInstance.NotFound	The specified instance is not found.	english description1
404	InvalidDBInstanceClass.NotFound	The specified instance classic does not exist.	english description1
404	InvalidRegionId.NotFound	The provided RegionId does not exist in our records.	english description1
404	QueryPrice.Failed	The inquiry failed. Contact Alibaba Cloud customer service representatives.	english description1

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.