All Products
Search
Document Center

ApsaraDB RDS:DescribeDBInstanceNetInfoForChannel

Last Updated:Aug 28, 2026

Queries all endpoint information of an ApsaraDB RDS instance.

Operation description

Supported database engines

  • MySQL

  • PostgreSQL

  • SQL Server

  • MariaDB

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

rds:DescribeDBInstanceNetInfoForChannel

get

*DBInstance

acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}

  • rds:ResourceTag
  • rds:ResourceTag
  • rds:ResourceTag
None

Request parameters

Parameter

Type

Required

Description

Example

ClientToken

string

No

The client token used to ensure the idempotence of the request. You can use the client to generate the token, but it must be unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.

0c593ea1-3bea-11e9-b96b-88****

DBInstanceId

string

Yes

The ID of the instance. You can call the DescribeDBInstances operation to query the instance ID.

rm-bp1k8s41l2o52****

Flag

string

No

An internal parameter. You do not need to specify this parameter.

无

DBInstanceNetRWSplitType

string

No

The type of the endpoint to query. Valid values:

  • 0: a regular endpoint. This is the default value.

  • 1: a read/write splitting endpoint that is assigned after the shared proxy feature is enabled.

0

Response elements

Element

Type

Description

Example

object

The response parameters.

DBInstanceNetInfos

object

DBInstanceNetInfo

array<object>

The instance connection information.

array<object>

Availability

string

The availability of the instance. Valid values:

  • Unavailable

  • Available

Unavailable

ConnectionString

string

The endpoint of the instance.

rm-uf6w****.mysql.rds.aliyuncs.com

ConnectionStringType

string

The type of the endpoint. Valid values:

  • Normal: a regular endpoint

  • ReadWriteSplitting: a read/write splitting endpoint that is assigned after the shared proxy feature is enabled.

Normal

DBInstanceWeights

object

DBInstanceWeight

array<object>

The read weight information for read/write splitting after the shared proxy feature is enabled.

object

Availability

string

The availability of the instance. Valid values:

  • Unavailable

  • Available

Unavailable

DBInstanceId

string

The instance ID.

rm-uf6wjk5****

DBInstanceType

string

The instance type. Valid values:

  • Master: primary instance

  • Readonly: read-only instance

Master

Weight

string

The weight of the instance.

100

DistributionType

string

The policy used to assign read weights. Returned only for a read/write splitting endpoint assigned after the shared proxy feature is enabled. Valid values:

  • Standard: The system automatically allocates read weights to the instance and its read-only instances based on the specifications of the instances.

  • Custom: You must manually allocate read weights to the instance and its read-only instances.

Standard

IPAddress

string

The IP address of the instance.

172.16.XX.XX

IPType

string

The network type of the IP address. Valid values:

  • Public: the Internet

  • Inner: the classic network

  • Private: a virtual private cloud (VPC)

Inner

MaxDelayTime

string

The latency threshold for read/write splitting of the shared proxy feature. Unit: seconds.

Note

This parameter is returned only when ConnectionStringType is set to ReadWriteSplitting.

12

Port

string

The port number of the instance.

6379

SecurityIPGroups

object

securityIPGroup

array<object>

The details of the IP address whitelist.

object

SecurityIPGroupName

string

The name of the IP address whitelist.

Default

SecurityIPs

string

The IP addresses contained in the IP address whitelist.

127.0.XX.XX

Upgradeable

string

An internal parameter. You do not need to specify this parameter.

Disabled

VPCId

string

The VPC ID of the instance.

vpc-bp1nme44gek34slfc****

VSwitchId

string

The vSwitch ID of the instance.

vsw-bp1e7clcw529l773d****

expiredTime

string

The expiration time of the endpoint of the classic network type. Unit: seconds.

5183779

InstanceNetworkType

string

The network type of the instance. Valid values:

  • VPC: a virtual private cloud (VPC)

  • Classic: classic network

VPC

RequestId

string

The ID of the request.

61DF1F28-F409-50C0-B90A-CCE82D44****

Examples

Success response

JSON format

{
  "DBInstanceNetInfos": {
    "DBInstanceNetInfo": [
      {
        "Availability": "Unavailable",
        "ConnectionString": "rm-uf6w****.mysql.rds.aliyuncs.com",
        "ConnectionStringType": "Normal",
        "DBInstanceWeights": {
          "DBInstanceWeight": [
            {
              "Availability": "Unavailable",
              "DBInstanceId": "rm-uf6wjk5****",
              "DBInstanceType": "Master",
              "Weight": "100"
            }
          ]
        },
        "DistributionType": "Standard",
        "IPAddress": "172.16.XX.XX",
        "IPType": "Inner",
        "MaxDelayTime": "12",
        "Port": "6379",
        "SecurityIPGroups": {
          "securityIPGroup": [
            {
              "SecurityIPGroupName": "Default",
              "SecurityIPs": "127.0.XX.XX"
            }
          ]
        },
        "Upgradeable": "Disabled",
        "VPCId": "vpc-bp1nme44gek34slfc****",
        "VSwitchId": "vsw-bp1e7clcw529l773d****",
        "expiredTime": "5183779"
      }
    ]
  },
  "InstanceNetworkType": "VPC",
  "RequestId": "61DF1F28-F409-50C0-B90A-CCE82D44****"
}

Error codes

HTTP status code

Error code

Error message

Description

400 Forbidden.RAM User not authorized to operate on the specified resource, or this API does not support RAM.
400 Order.ComboInstanceNotAllowOperate A package instance is not allowed to operate independently. A package instance is not allowed to operate independently.
400 Price.PricingPlanResultNotFound Pricing plan price result not found. Pricing plan price result not found.
400 Order.NoRealNameAuthentication You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication. You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.
400 InsufficientAvailableQuota Your account quota limit is less than 0, please recharge before trying to purchase. Your account available limit is less than 0, please recharge before trying to purchase.
400 CommodityServiceCalling.Exception Failed to call commodity service. Failed to call commodity service return.
400 RegionDissolvedEOM Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support. Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.
400 Commodity.InvalidComponent The module you purchased is not legal, please buy it again. The module you purchased is not legal, please buy it again.
400 RegionEndTimeDissolvedAustralia Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024. Hello customer, this area has been abolished.
400 Price.CommoditySys Commodity system call exception. Commodity system call exception.
400 Pay.InsufficientBalance Insufficient available balance. Insufficient available balance.
400 Order.PeriodInvalid There is a problem with the period you selected, please choose again. There is a problem with the period you selected, please choose again.
400 pay.noCreditCard Account not bound to credit card.
400 Order.InstHasUnpaidOrder There is an unpaid order for the service you have purchased. Please pay or void it before placing the order. There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.
400 noAvailablePaymentMethod No payment method is specified for your account. We recommend that you add a payment method. No payment method has been specified for your account. We recommend that you add a payment method.
400 BasicInfoUncompleted Your information is incomplete. Complete your information before the operation. Your basic information is not complete, please complete your basic information before operation.
400 Risk.RiskControlRejection Your account is abnormal, please contact customer service for details. Your account is abnormal, please contact customer service for details.
400 Api.NotSupport Specified api is not supported. The current interface does not support.
400 ContainForbiddenLabelError There is a label that prohibits placing orders. Please contact your distributor for assistance. You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.
400 InvalidDBInstanceId.NotFound The DBInstanceId provided does not exist in records. The DBInstanceId provided does not exist.
400 InvalidInstanceLevel.DiskType Specified instance level not support request disk type The current instance type does not support the specified storage type.
400 InvalidParam Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica. The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.
400 KmsApiError User secret key invalid. The user key is invalid.
400 System.SaleValidateFailed Sales expression validation system error. A system error occurs when the sales expression is verified.
400 Abs.InvalidAccount.NotFound account is not found. The account does not exist.
400 SqlExecuteFailedOrTimeout sql command execution failed or timed out:%s. SQL command execution failed or timed out
400 ColdData.EngineVersionNotSupport The current instance engine version not support coldDataEnabled. The current instance engine version not support coldDataEnabled.
400 ColdData.MinorVersionNotSupport The current instance minor version not support coldDataEnabled. The current instance minor version not support coldDataEnabled.
400 IncorrectTargetClasscode The current instance type does not support this operation. This operation is not supported by the instance type.
400 InvalidConnectionString.Duplicate Specified connection string already exists in the RDS. The link address name is duplicate. Please reset the connection string.
400 RequiredParam.NotFound Required input param is not found.
400 Parameters.Invalid Parameter error, please check the parameters. Parameter error, please check the parameters.
400 BackupPolicyNotSupport Cold Data won't open with CrossBackup or Flash Backup, please check Backup Policy. Cold Data won't open with CrossBackup or Flash Backup, please check Backup Policy.
400 InvalideStatus.Format The instance status does not support this operation.
400 InvalidReleasedKeepPolicy.Format Specified Released Keep Policy is not valid. Specified Released Keep Policy is not valid.
400 InvalidDBInstanceEngineType.Format the DB instance engine type does not support this operation. This operation is not supported for the database engine of the instance.
400 Pay.NoCreditCard No credit cards. No credit cards.
400 VpcNetworkTypeNotSupport The vpc network type instance does not support this operation. The vpc network type instance does not support this operation.
400 MirrorInsExists Specified DB instance mirror ins already existed. Specified DB instance mirror ins already existed.
400 UnsupportedClassCode The specified DB instance class stops selling. The specified DB instance class stops selling.
400 InvalidBackupSet The specified database does not exist in the backup set. The specified database does not exist in the backup set.
400 OrdTCommodityQueryError Failed to query for product. Failed to query product.
400 ProductInstanceReleased The instance has been released. Please check before placing the order. The instance has been released, please verify and place an order.
400 RegionEndTimeDissolvedIndia The region is no longer supported. The region is no longer supported.
400 AccountLeastAssociateOneDB Retain at least one account in a DB. At least one authorized account must be retained for the database.
500 ExternalFailure The request processing has failed due to external service failure. The request processing has failed due to external service failure.
500 RequestMetaDataFailed The service request failed. Please try again later or contact service personnel. The service request failed. Please try again later or contact service personnel.
500 InvokeProxyFailure The request processing has failed due to service failure of rds api. The request failed to be processed due to an RDS API failure.
403 IncorrectDBInstanceCharacterType Current DB Instance character_type does not support this operation. This operation is not supported for the character type of the current instance.
403 OrderStatus.UnPaid The specified db instance has unpaid order. The instance has an unpaid order. Please pay first and try again.
403 InvalidReduceDiskSize The storage capacity after the scale-down must be larger than the used amount. The scale-in target capacity cannot be less than the current storage space usage
403 CloudSSDNotSupport Cloud ssd does not support this operation, please upgrade to essd.
403 InvalidUserOperatorPermission The user permission does not support this operation. The user is not authorized to perform this operation.
403 InvalidVswitchId Specified conn vswitch id is not valid.
403 IncorrectMinorVersion Current engine minor version does not support operations. This operation is not supported for the current minor engine version.
403 OperationDenied.ZoneResource There is no available zone for inventory. There is no available zone for inventory.
403 NotInFlowController Sorry,no permission. Sorry,no permission.
403 InvalidKmsKey Kms key is disabled.
403 InvalidInstanceLevel.Malformed Current DB instance level does not support this operation. The specified database instance type does not support this operation.
404 InvalidDBInstanceName.NotFound The database instance does not exist. The name of the RDS instance cannot be found. Check the name of the RDS instance.
404 Readins.NotFound The current instance does not contain any read only instance. The operation is not supported. The operation failed. The RDS instance is not attached with read-only RDS instances.
404 InvalidRwSplitNetType.NotFound The RwSplitNetType is not found. The operation failed. Create an RDS instance for which read/write splitting is enabled and try again.
404 InvalidClusterKms The current instance does not authorized to access the Key Management Service. The instance does not have permissions to access Key Management Service (KMS).
404 Request.NotFound The requested resource is not available. The requested resources are unavailable.
404 HostInfo.NotFound The specified host info is not found.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.