All Products
Search
Document Center

ApsaraDB for SelectDB:DescribeDBInstanceNetInfo

Last Updated:Dec 18, 2024

Queries the network information about an ApsaraDB for SelectDB instance.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
selectdb:DescribeDBInstanceNetInfonone
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
DBInstanceIdstringYes

The instance ID.

selectdb-cn-7213cjv****
RegionIdstringYes

The region ID of the instance.

cn-hangzhou

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

RequestIdstring

The request ID.

ADF42B18-43FD-5100-83A9-BE81AB70C863
DBInstanceNetInfosarray<object>

The network information about the instance.

DBInstanceNetInfosobject
NetTypestring

The network type of the instance. Valid values:

  • VPC: indicates a virtual private cloud (VPC)-connected instance.
  • PUBLIC: indicates an Internet-connected instance.
VPC
VpcInstanceIdstring

The ID of the VPC-connected instance.

selectdb-cn-h033cnd****-fe-20230816101006
VpcIdstring

The VPC ID.

vpc-wz90scxq6ods388ft****
VswitchIdstring

The vSwitch ID.

vsw-uf6mlqti065rer6m0****
UserVisibleboolean

Indicates whether the network information is visible to users. Valid values:

  • true
  • false
true
ConnectionStringstring

The connection string of the instance.

selectdb-cn-h033cnd****-fe.selectdbfe.pre.rds.aliyuncs.com
Ipstring

The IP address of the instance.

172.16.XX.XX
PortListarray<object>

The ports.

PortListobject
Protocolstring

The protocol of the port. Valid values:

  • HttpPort: HTTP port.
  • MySQLPort: MySQL port.
9030
Portinteger

The port that is used to connect to the instance.

MySQLPort
ClusterIdstring

The cluster ID.

selectdb-cn-****-be
DBClustersNetInfosarray<object>

The network information about the backend (BE) clusters.

DBClustersNetInfosobject
NetTypestring

The network type of the BE cluster.

VPC/PUBLIC
VpcInstanceIdstring

The VPC ID.

selectdb-cn-****-fe-20230816101006
VpcIdstring

VPC ID

vpc-****
VswitchIdstring

The vSwitch ID.

vsw-****
UserVisibleboolean

Indicates whether the network information is visible to users.

true/false
ConnectionStringstring

The connection string of the BE cluster.

selectdb-cn-****-fe.selectdbfe.pre.rds.aliyuncs.com
Ipstring

The IP address of the BE cluster.

8.131.***.***
PortListarray<object>
PortListobject
Protocolstring

The protocol of the port.

9030/8080
Portinteger

The port that is used to connect to the BE cluster.

MySQLPort/HttpPort
ClusterIdstring

The cluster ID.

selectdb-cn-****-be

Examples

Sample success responses

JSONformat

{
  "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": "9030/8080",
          "Port": 0
        }
      ],
      "ClusterId": "selectdb-cn-****-be"
    }
  ]
}

Error codes

HTTP status codeError codeError messageDescription
400DocumentConvertFailed.ExceedFileSizeLimitThe conversion has been failed, exceed file size limit.english description1
400ForbiddenUser not authorized to operate on the specified resource, or this API does not support RAM.english description1
400InvalidDBNameThe specified database name is not allowed.english description1
400CreateOrderFailedFailed to create order.Failed to create order.
403DBClusterNotSupportedThe requested operation can not be performed while the cluster is not sale.The requested operation cannot be performed while the cluster is not running.
403IncorrectDBInstanceStateCurrent DB instance state does not support this operation.english description1
403InstanceEngineType.NotSupportThe instance engine and type does not support operations.english description1
403InvalidDBInstanceState.NotSupportThe specified instance state does't support this operation.The instance is in a state that does not support the current operation.
403MoneyLessThan100The Account Monet less Than 100.english description1
403OperationDenied.DBNameAndAccountPrivilegeCountThe operation is not permitted due to count of database or account privilege.english description1
403InsufficientResourceCapacityThe resource is out of usage.Not enough resources, please try again later.
404InvalidDBInstanceId.NotFoundThe DBInstanceId provided does not exist in our records.Instance does not exist.
404InvalidClusterInstance.NotFoundSpecified cluster instance does not exist.SelectDB instance does not exist.
404DBInstanceLockedThe current instance lock mode does not support this operation.english description1
404IncorrectVswitchIdThe specified parameter VSwitchId is not valid.english description1
404InvalidApi.NotFoundSpecified api is not found, please check your url and method.-
404InvalidDBInstance.NotFoundThe specified instance is not found.english description1
404InvalidDBInstanceClass.NotFoundThe specified instance classic does not exist.english description1
404InvalidRegionId.NotFoundThe provided RegionId does not exist in our records.english description1
404QueryPrice.FailedThe inquiry failed. Contact Alibaba Cloud customer service representatives.english description1

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2024-07-10The Error code has changedView Change Details
2024-06-24The Error code has changedView Change Details
2024-01-04The response structure of the API has changedView Change Details