DescribeAgenticDBBranchEndpoints

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request syntax

POST  HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes		cn-hangzhou
DBClusterId	string	Yes		pagc-bp1abcdef1234567
TenantId	string	Yes		t-4b83e0da66674951
ProjectId	string	Yes		proj-a1b2c3d4e5f6
BranchId	string	Yes		br-7g8h9i0j1k2l

Response elements

Element	Type	Description	Example
	object
RequestId	string		E5F6A7B8-C9D0-1234-EFAB-567890123EFA
Items	array<object>
	object
EndpointId	string		ep-3m4n5o6p7q8r
EndpointType	string		ReadWrite
Address	string		10.0.1.100
Port	integer		5432
Database	string		neondb
Account	string		cloud_admin
Password	string		******
ConnectionString	string		postgresql://cloud_admin:******@10.0.1.100:5432/neondb

Examples

Success response

JSON format

{
  "RequestId": "E5F6A7B8-C9D0-1234-EFAB-567890123EFA",
  "Items": [
    {
      "EndpointId": "ep-3m4n5o6p7q8r",
      "EndpointType": "ReadWrite",
      "Address": "10.0.1.100",
      "Port": 5432,
      "Database": "neondb",
      "Account": "cloud_admin",
      "Password": "******",
      "ConnectionString": "postgresql://cloud_admin:******@10.0.1.100:5432/neondb"
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.