Use DescribeDBInstanceEndpoints to query instance endpoints - ApsaraDB RDS - Alibaba Cloud - ApsaraDB RDS

Queries the information about the endpoints of an instance that runs RDS Cluster Edition.

Operation description

Supported database engine

MySQL

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:
- For mandatory resource types, indicate with a prefix of * .
- 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:DescribeDBInstanceEndpoints	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.	ETnLKlblzczshOTUbOC****
DBInstanceId	string	Yes	The instance ID. You can call the DescribeDBInstances operation to query the instance ID.	rm-u****
DBInstanceEndpointId	string	No	The endpoint ID of the instance. Note If this parameter is not specified, the information about all endpoints is returned.	ep-****-ro

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
Data	object	The data returned.
DBInstanceName	string	The name of the instance.	rm-u****
IpVersion	string	The version of the IP protocol. Valid values: ipv4 ipv6	ipv4
DBInstanceEndpoints	array<object>	The information of the endpoints of the instance.
DBInstanceEndpoint	object	The details of the endpoint.
EndpointId	string	The endpoint ID of the instance.	ep-****
EndpointType	string	The type of the endpoint. Valid values: Primary: the read/write endpoint of the instance Readonly: the read-only endpoint of the instance	Readonly
EndpointDescription	string	The user-defined description of the endpoint.	for readonly business
NodeItems	array<object>	The information about the node that is configured for the endpoint.
NodeItem	object	The details of the endpoint.
NodeId	string	The node ID.	rn-****13p6tum4289h
DBInstanceId	string	The instance ID.	rm-u****
Weight	integer	The weight of the node. Read requests are distributed based on the weight. Valid values: 0 to 100.	50
AddressItems	array<object>	The information about the endpoint.
AddressItem	object	The connection details.
VpcId	string	The VPC ID.	vpc-bp17xdic25d****
VSwitchId	string	The vSwitch ID.	vsw-bp12u14ecz****
IpType	string	The type of the IP address. Valid values: Public: Internet Private: internal network	Private
Port	string	The port number of the endpoint.	3306
ConnectionString	string	The endpoints of the instance.	rm****.mysql.rds.aliyuncs.com
IpAddress	string	The IP address.	10.71.XX.XX
RequestId	string	The ID of the request.	777C4593-8053-427B-****105593277CAB

Examples

Sample success responses

JSONformat

{
  "Data": {
    "DBInstanceName": "rm-u****",
    "IpVersion": "ipv4",
    "DBInstanceEndpoints": {
      "DBInstanceEndpoint": [
        {
          "EndpointId": "ep-****",
          "EndpointType": "Readonly",
          "EndpointDescription": "for readonly business",
          "NodeItems": {
            "NodeItem": [
              {
                "NodeId": "rn-****13p6tum4289h",
                "DBInstanceId": "rm-u****",
                "Weight": 50
              }
            ]
          },
          "AddressItems": {
            "AddressItem": [
              {
                "VpcId": "vpc-bp17xdic25d****",
                "VSwitchId": "vsw-bp12u14ecz****",
                "IpType": "Private",
                "Port": 3306,
                "ConnectionString": "rm****.mysql.rds.aliyuncs.com",
                "IpAddress": "10.71.XX.XX"
              }
            ]
          }
        }
      ]
    }
  },
  "RequestId": "777C4593-8053-427B-****105593277CAB"
}

Error codes

HTTP status code	Error code	Error message	Description
400	APICallingFailed	Meta db calling failed.	An internal error occurred.
400	InvalidSourceCategory	specified source category is invalid.	The specified source category is invalid.
400	InvalidDBInstanceConnType.Format	Specified DB instance conn type is not valid.	The operation failed. The operation is not supported for the connection type of the RDS instance.
400	Forbidden	User not authorized to operate on the specified resource, or this API does not support RAM.	The RAM user account does not have the required permissions. Grant the account the required permissions.
400	InvalidEngineVersion.NotSupport	The specified parameter "EngineVersion" is not valid.	The database engine version is not supported. If you select MySQL, MySQL 5.5, MySQL 5.6, and MySQL 5.7 are supported. If you select SQLServer, SQL Server 2008 R2 and SQL Server 2012 are supported. If you select PostgreSQL, only PostgreSQL 9.4 is supported. If you select PPAS, only PPAS 9.3 is supported.
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	RegionEndTimeDissolvedIndia	Cloud services in the India (Mumbai) region will be discontinued. Set the validity date to July 15, 2024 or earlier than July 15, 2024.	Hello customer, this area has been abolished.
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	BasicInfoUncompleted	Your information is incomplete, Complete your information before the operation.	-
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
403	IncorrectDBInstanceState	Current DB instance state does not support this operation.	-
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.	-
404	IncorrectDBInstanceLockMode	Current DB instance lock mode does not support this operation.	The operation failed. The RDS instance is locked.
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	InvalidDBInstance.NotFound	Specified instance does not exist or not support.	The RDS instance cannot be found, is deleted, or does not support the operation.
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).
500	ExternalFailure	The request processing has failed due to external service failure.	The request processing has failed due to external service failure.

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

Change history

Change time	Summary of changes	Operation
2023-05-09	The Error code has changed	View Change Details