You need to enable JavaScript to run this app.
RDS for PostgreSQL

RDS for PostgreSQL

Copy page
Download PDF
Managing connections
CreateDBEndpoint
Copy page
Download PDF
CreateDBEndpoint
Call the CreateDBEndpoint API to create an endpoint for the specified instance.​
Request type​
Asynchronous request.​
Debug​
API Explorer
You can initiate calls online through API Explorer without paying attention to the signature generation process and quickly obtain the call results.
​
Request parameters​
​
Parameter​
Type​
Required?​
Example​
Description​
InstanceId​
String​
Yes​
postgres-21a3333b****​
Instance ID.​
EndpointType​
String​
Yes​
Custom​
Endpoint type, currently only supports the value Custom, meaning custom type.​
ReadWriteMode​
String​
No​
ReadOnly​
Read/Write mode:​
  • ReadWrite: Read/write.​
  • ReadOnly: read-only. Default value.​
EndpointName​
String​
No​
EndpointName​
Instance endpoint name.​
  • It cannot start with a digit or hyphen (-).​
  • It can contain only Chinese characters, letters, digits, underscores (_), and hyphens (-).​
  • The length must be between 1 and 64 characters.​
tip​
If not provided, the endpoint will be automatically named "Customized_endpoint".​
Nodes​
String​
No​
Primary,postgres-ca7b7019****-rocbcb​
Node list for endpoint configuration.​
tip​
  • Required when EndpointType is Custom.​
  • No node ID is needed for the primary node. Use the primary string.​
​
Response parameter​
null​
Sample​
Sample request​
​
POST /?Action=CreateDBEndpoint&Version=2022-01-01 HTTP/1.1​
Content-Type: application/json​
Host: rds-postgresql.cn-beijing.volcengineapi.com​
X-Date: 20231002T101010Z​
Authorization: HMAC-SHA256 Credential=AKLTN2I0MmFiNzMxNWE5NDgzMzk4MmVjMTVkODlkZTZ****/20211202/cn-beijing/rds_postgresql/request,SignedHeaders=x-date, Signature=71d31fc7bcf990142851c9833c5656391486cda0ae2e0b8ada733b7c6458****​
{​
"InstanceId": "postgres-ca7b7019****",​
"EndpointName": "自定义终端",​
"EndpointType": "Custom",​
"Nodes": "postgres-ca7b7019****-rocbcb",​
"ReadWriteMode": "ReadOnly"​
}​
​
Sample response​
​
{​
"ResponseMetadata": {​
"RequestId": "202308021119002CCE8C74AFEBB9023B8E",​
"Action": "CreateDBEndpoint",​
"Version": "2022-01-01",​
"Service": "rds_postgresql",​
"Region": "cn-beijing"​
},​
"Result": null​
}​
​
Last updated: 2026.03.31 10:45:18