DescribeInstanceEndpoints - ApsaraDB RDS - Alibaba Cloud Documentation Center

Queries the endpoint of an RDS Supabase instance.

Operation description

Supported database engine

RDS PostgreSQL

References

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
rdsai:DescribeInstanceEndpoints	get	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The operation that you want to perform. Set the value to DescribeInstanceEndpoints.	cn-beijing
InstanceName	string	No	The region ID.	ra-supabase-8moov5lxba****

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	32DEFB4A-861F-5D1D-ADD5-918E4FD7AB8C
InstanceName	string	The ID of the RDS Supabase instance.	ra-supabase-8moov5lxba****
InstanceEndpoints	array<object>	The information about the endpoints of the RDS Supabase instance.
instanceEndpoints	object
ConnectionString	string	The endpoint of the RDS Supabase instance.	8.152.XXX.XXX:8000
IpType	string	The network type of the RDS Supabase instance. Valid values: public: Internet vpc: VPC	public
IP	string	The IP address used to access the RDS Supabase instance.	8.152.XXX.XXX
Port	string	The port used to access the RDS Supabase instance.	8000
DBInstanceEndpoints	array<object>	The information about the endpoints of the RDS instance.
dbInstanceEndpoints	object
ConnectionString	string	The endpoint of the RDS instance.	pgm-xxxx.rds.aliyuncs.com
IpType	string	The network type of the RDS instance. Valid values: public: Internet vpc: VPC	vpc
Port	string	The port used to access the RDS instance.	5432

Examples

Sample success responses

JSONformat

{
  "RequestId": "32DEFB4A-861F-5D1D-ADD5-918E4FD7AB8C\n",
  "InstanceName": "ra-supabase-8moov5lxba****",
  "InstanceEndpoints": [
    {
      "ConnectionString": "8.152.XXX.XXX:8000",
      "IpType": "public",
      "IP": "8.152.XXX.XXX",
      "Port": 8000
    }
  ],
  "DBInstanceEndpoints": [
    {
      "ConnectionString": "pgm-xxxx.rds.aliyuncs.com",
      "IpType": "vpc",
      "Port": 5432
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
400	IncorrectInstanceState	Current instance status does not support this operation.	The operation is not supported in the current instance state.
400	InvalidGroupName	Specified group name is not valid.	Invalid group name
400	InvalidParameter	The provided parameter is invalid.	Invalid parameter.
400	MasterInstanceNotExist	Master instance does not exist.	The primary instance does not exist.
403	InsufficientResourceCapacity	There is not enough host resource inventory.	Insufficient resources

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

Change history

Change time	Summary of changes	Operation
2025-12-23	The Error code has changed. The response structure of the API has changed	View Change Details