DescribeDBInstanceNetInfoForChannel - ApsaraDB RDS - Alibaba Cloud Documentation Center

Queries all endpoints of an instance.

Operation description

Supported database engines

MySQL
PostgreSQL
SQL Server
MariaDB

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.

Debug

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.

Operation	Access level	Resource type	Condition key	Associated operation
rds:DescribeDBInstanceNetInfoForChannel	get	*DBInstance `acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}`	rds:ResourceTag	none

Request parameters

Parameter	Type	Required	Description	Example
ClientToken	string	No	The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is 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.	None
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 parameters

Parameter	Type	Description	Example
	object	The response parameters.
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****
DBInstanceNetInfos	array<object>	The information about the instance connection.
DBInstanceNetInfo	object
Upgradeable	string	An internal parameter. You do not need to specify this parameter.	Disabled
expiredTime	string	The expiration time of the endpoint of the classic network type. Unit: seconds.	5183779
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
Port	string	The port number of the instance.	6379
VPCId	string	The VPC ID of the instance.	vpc-bp1nme44gek34slfc****
Availability	string	The availability of the instance. Valid values: Unavailable Available	Unavailable
VSwitchId	string	The vSwitch ID of the instance.	vsw-bp1e7clcw529l773d****
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
ConnectionString	string	The endpoint of the instance.	rm-uf6w*****.mysql.rds.aliyuncs.com
MaxDelayTime	string	The latency threshold that is allowed for read/write splitting of the shared proxy feature. Unit: seconds. Note This parameter is returned only when ConnectionStringType is set to ReadWriteSplitting.	12
IPAddress	string	The IP address of the instance.	172.16.XX.XX
DistributionType	string	The policy that is used to assign read weights. This parameter is returned only for a read/write splitting endpoint that is 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
SecurityIPGroups	array<object>	The details of the IP address whitelist.
securityIPGroup	object
SecurityIPs	string	The IP addresses that is contained in the IP address whitelist.	127.0.XX.XX
SecurityIPGroupName	string	The name of the IP address whitelist.	Default
DBInstanceWeights	array<object>	The information about read weights to implement read/write splitting after the shared proxy feature is enabled.
DBInstanceWeight	object
Availability	string	The availability of the instance. Valid values: Unavailable Available	Unavailable
Weight	string	The weight of the instance.	100
DBInstanceId	string	The instance ID.	rm-uf6wjk5*****
DBInstanceType	string	The instance type. Valid values: Master: primary instance Readonly: read-only instance	Master

Examples

Sample success responses

JSONformat

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

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.	-
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.
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.

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

Change history

Change time	Summary of changes	Operation
2024-11-20	API Description Update. The Error code has changed	View Change Details
2022-10-28	The Error code has changed	View Change Details
2022-06-20	Add Operation	View Change Details