All Products
Search
Document Center

ApsaraDB RDS:DescribeDBInstanceNetInfo

Last Updated:May 22, 2024

Queries all endpoints of an instance.

Operation description

Supported database engines

  • MySQL
  • PostgreSQL
  • SQL Server
  • MariaDB

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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
rds:DescribeDBInstanceNetInfoRead
  • DBInstance
    acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}
  • rds:ResourceTag
none

Request parameters

ParameterTypeRequiredDescriptionExample
ClientTokenstringNo

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.

ETnLKlblzczshOTUbOC*****
DBInstanceIdstringYes

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

rm-uf6wjk5*****
FlagintegerNo

A reserved parameter. You do not need to specify this parameter.

None
DBInstanceNetRWSplitTypestringNo

The type of the endpoint. Valid values:

  • Normal: regular endpoint
  • ReadWriteSplitting: read/write splitting endpoint
Note By default, the system returns both types of endpoints.
Normal
GeneralGroupNamestringNo

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

ParameterTypeDescriptionExample
object
SecurityIPModestring

The whitelist mode of the instance. Valid values:

  • normal: standard whitelist mode
  • safety: enhanced whitelist mode
safety
RequestIdstring

The ID of the request.

777C4593-8053-427B-99E2-105593277CAB
InstanceNetworkTypestring

The network type of the instance. Valid values:

  • Classic: classic network
  • VPC: virtual private cloud (VPC)
VPC
DBInstanceNetInfosobject []

The information about the endpoints of the instance.

VSwitchIdstring

The vSwitch ID.

vsw-uf6adz52c2p*****
ConnectionStringTypestring

The type of the endpoint. Valid values:

  • Normal: a regular endpoint
  • ReadWriteSplitting: a read/write splitting endpoint
Normal
ConnectionStringstring

The endpoint of the instance.

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

The remaining validity period of the instance in the classic network in hybrid access mode. Unit: seconds.

1209534
Upgradeablestring

Indicates whether the IP version can be updated. Valid values:

  • Enable
  • Disabled
Note The IP version can be updated from IPv4 to IPv6.
Disabled
MaxDelayTimestring

The latency threshold. This parameter is returned only for a read/write splitting endpoint. Unit: seconds.

Note If the latency on a read-only instance exceeds the specified threshold, ApsaraDB RDS no longer forwards read requests to the read-only instance.
12
IPTypestring

The network type.

  • Valid values when the instance resides in the classic network:

    • Inner
    • Public
  • Valid values when the instance resides in a virtual private cloud (VPC):

    • Private
    • Public
Public
Portstring

The port that is used to connect to the instance.

3306
BabelfishPortstring

The Tabular Data Stream (TDS) port of the instance for which Babelfish is enabled.

Note This parameter applies only to ApsaraDB RDS for PostgreSQL instances. For more information about Babelfish for ApsaraDB RDS for PostgreSQL, see Introduction to Babelfish.
1433
VPCIdstring

The VPC ID of the instance.

vpc-uf6f7l4fg90*****
DistributionTypestring

The policy that is used to assign read weights. This parameter is returned only for a read/write splitting endpoint. 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
IPAddressstring

The IP address.

192.168.XX.XX
SecurityIPGroupsobject []

The IP addresses in the whitelist for the instance.

SecurityIPsstring

The IP address in the whitelist.

127.0.XX.XX
SecurityIPGroupNamestring

The name of the IP address whitelist.

Default
DBInstanceWeightsobject []

The information about the instance weight.

Note This parameter is returned only when the read/write splitting feature is enabled for the instance.
Availabilitystring

The availability of the instance. Valid values:

  • Unavailable
  • Available
Unavailable
Weightstring

The weight of the instance.

100
DBInstanceIdstring

The instance ID.

rm-uf6wjk5*****
Rolestring

A deprecated parameter.

None
DBInstanceTypestring

The type of the instance. Valid values:

  • Master: primary instance
  • Readonly: read-only instance
Master
PGBouncerPortstring

The PgBouncer port.

Note This parameter is returned only when PgBouncer is enabled for the instance that runs PostgreSQL.
6432

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\n",
              "DBInstanceType": "Master"
            }
          ]
        },
        "PGBouncerPort": "6432"
      }
    ]
  }
}

Error codes

HTTP status codeError codeError messageDescription
400TimeoutRetryLaterTimeout, retry later.-
400InvalidDBInstanceName.NotFoundDB instance name not found.-
400IllegalParameterIllegal parameterThe values of some parameters are invalid.
400Readins.NotFoundReadonly instance not found.-
400Order.ComboInstanceNotAllowOperateA package instance is not allowed to operate independently.A package instance is not allowed to operate independently.
400Price.PricingPlanResultNotFoundPricing plan price result not found.Pricing plan price result not found.
400Order.NoRealNameAuthenticationYou 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 user center for real-name authentication.
400InsufficientAvailableQuotaYour 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.
400CommodityServiceCalling.ExceptionFailed to call commodity service.Failed to call commodity service return.

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

Change history

Change timeSummary of changesOperation
2023-06-27The Error code has changed. The response structure of the API has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 400
Output ParametersThe response structure of the API has changed.
2021-12-28The Error code has changed. The response structure of the API has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 400
Output ParametersThe response structure of the API has changed.