DescribeDBInstanceNetInfo - ApsaraDB RDS - Alibaba Cloud Documentation Center

You can call the DescribeDBInstanceNetInfo operation to query the endpoints of an ApsaraDB RDS instance.

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	Association operation
rds:DescribeDBInstanceNetInfo	READ	RDS 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 generated token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.	ETnLKlblzczshOTUbOC*****
DBInstanceId	string	Yes	The ID of the instance.	rm-uf6wjk5*****
Flag	integer	No	A reserved parameter.	none
DBInstanceNetRWSplitType	string	No	The type of the endpoint. Valid values: Normal: regular endpoint ReadWriteSplitting: read/write splitting endpoint NoteBy default, the system returns both types of endpoints.	Normal
GeneralGroupName	string	No	The name of the dedicated cluster to which the instance belongs. This parameter takes effect only when the instance runs MySQL on RDS Standard Edition and is created in a dedicated cluster.	rgc-2ze*****

Response parameters

Parameter	Type	Description	Example
	object
SecurityIPMode	string	The whitelist mode of the instance. Valid values: normal: standard whitelist mode safety: enhanced whitelist mode	safety
RequestId	string	The ID of the request.	777C4593-8053-427B-99E2-105593277CAB
InstanceNetworkType	string	The network type of the instance. Valid values: Classic VPC	VPC
DBInstanceNetInfos	array	Details of the endpoints of the instance.
	object
VSwitchId	string	The ID of the vSwitch.	vsw-uf6adz52c2p*****
ConnectionStringType	string	The type of the endpoint. Valid values: Normal: regular endpoint ReadWriteSplitting: read/write splitting endpoint	Normal
ConnectionString	string	The endpoint of the instance.	rm-uf6w*****.mysql.rds.aliyuncs.com
ExpiredTime	string	The remaining validity period of the instance of the classic network in hybrid access mode. Unit: seconds.	1209534
Upgradeable	string	Indicates whether the IP version can be updated. Valid values: Enable: The IP version can be updated. Disabled: The IP version cannot be updated. NoteThe IP version can be updated from IPv4 to IPv6.	Disabled
MaxDelayTime	string	The latency threshold. This parameter is returned only for a read/write splitting endpoint. Unit: seconds. NoteIf the latency on a read-only instance exceeds the specified threshold, ApsaraDB RDS no longer forwards read requests to the read-only instance.	12
IPType	string	The network type. Valid values when the instance resides in the classic network: Inner:: internal network Public: Internet Valid values when the instance resides in a virtual private cloud (VPC): Private: internal network Public: Internet	Public
Port	string	The port that is used to connect to the instance.	3306
BabelfishPort	string	The Tabular Data Stream (TDS) port of the instance for which Babelfish is enabled. NoteThis parameter applies only to ApsaraDB RDS for PostgreSQL instances. For more information about Babelfish for ApsaraDB RDS for PostgreSQL, see Introduction to Babelfish.	1433
VPCId	string	The ID of the VPC to which the instance belongs.	vpc-uf6f7l4fg90*****
DistributionType	string	The policy that is used to assign read weights. This parameter is returned only for a read/write splitting endpoint. Valid values: Standard: ApsaraDB RDS automatically assigns read weights to the instance and its read-only instances based on the specifications of these instances. Custom: You must manually assign read weights to the instance and its read-only instances.	Standard
IPAddress	string	The IP address of the instance.	192.168.XX.XX
SecurityIPGroups	array	Details about the IP whitelists of the instance.
	object
SecurityIPs	string	The IP addresses contained in the IP address whitelist.	127.0.XX.XX
SecurityIPGroupName	string	The name of the IP address whitelist.	Default
DBInstanceWeights	array	Details of the weight. This parameter is returned only when the read/write splitting feature is enabled for the instance.
	object
Availability	string	The availability of the instance. Valid values: Unavailable Available	Unavailable
Weight	string	The weight of the instance.	100
DBInstanceId	string	The ID of the instance.	rm-uf6wjk5*****
Role	string	A deprecated parameter.	none
DBInstanceType	string	The role of the instance. Valid values: Master: primary instance Readonly: read-only instance	Master

Examples

Sample success responses

JSONformat

{
  "SecurityIPMode": "safety",
  "RequestId": "777C4593-8053-427B-99E2-105593277CAB",
  "InstanceNetworkType": "VPC",
  "DBInstanceNetInfos": {
    "DBInstanceNetInfo": [
      {
        "VSwitchId": "vsw-uf6adz52c2p*****",
        "ConnectionStringType": "Normal",
        "ConnectionString": "rm-uf6w*****.mysql.rds.aliyuncs.com",
        "ExpiredTime": "1209534",
        "Upgradeable": "Disabled",
        "MaxDelayTime": "12",
        "IPType": "Public",
        "Port": "3306",
        "BabelfishPort": "1433",
        "VPCId": "vpc-uf6f7l4fg90*****",
        "DistributionType": "Standard",
        "IPAddress": "192.168.XX.XX",
        "SecurityIPGroups": {
          "securityIPGroup": [
            {
              "SecurityIPs": "127.0.XX.XX",
              "SecurityIPGroupName": "Default"
            }
          ]
        },
        "DBInstanceWeights": {
          "DBInstanceWeight": [
            {
              "Availability": "Unavailable",
              "Weight": "100",
              "DBInstanceId": "rm-uf6wjk5*****",
              "Role": "none",
              "DBInstanceType": "Master"
            }
          ]
        }
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	TimeoutRetryLater	Timeout, retry later.	-
400	InvalidDBInstanceName.NotFound	DB instance name not found.	-
400	IllegalParameter	Illegal parameter	The values of some parameters are invalid.
400	Readins.NotFound	Readonly instance not found.	-

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

Change history

Change time

Summary of changes

Operation

2021-12-28

The error codes of the API operation change.,The response structure of the API operation changes.

Change item	Change content
Error Codes	The error codes of the API operation change.
	delete Error Codes: 400
Output Parameters	The response structure of the API operation changes.