[ PROMPT_NODE_23600 ]
Neon REST API 端点
[ SKILL_DOCUMENTATION ]
## 概述
本节提供管理项目中与分支关联的计算端点的规则。计算端点是 Neon 计算实例,允许您连接并与数据库进行交互。
## 管理计算端点
### 创建计算端点
1. 操作:创建一个新的计算端点(Neon 计算实例)并将其与指定分支关联。
2. 端点:`POST /projects/{project_id}/endpoints`
3. 路径参数:
- `project_id` (string, 必填): 项目的唯一标识符。
4. 请求体参数:
`endpoint` (object, 必填): 新端点属性的容器。
- `branch_id` (string, 必填): 要关联端点的分支 ID。
- `type` (string, 必填): 端点类型。一个分支只能有一个 `read_write` 端点,但可以有多个 `read_only` 端点。允许的值:`read_write`, `read_only`。
- `region_id` (string, 可选): 创建端点的区域。必须与项目的区域匹配。
- `autoscaling_limit_min_cu` (number, 可选): 最小计算单元 (CU)。最小值为 `0.25`。
- `autoscaling_limit_max_cu` (number, 可选): 最大计算单元 (CU)。最小值为 `0.25`。
- `provisioner` (string, 可选): 计算资源配置器。指定 `k8s-neonvm` 以启用自动扩缩容。允许的值:`k8s-pod`, `k8s-neonvm`。
- `suspend_timeout_seconds` (integer, 可选): 计算资源挂起前的非活动持续时间(秒)。范围从 -1(从不挂起)到 604800(1 周)。
- `disabled` (boolean, 可选): 如果为 `true`,则限制对该端点的连接。
请求示例:
bash
curl 'https://console.neon.tech/api/v2/projects/hidden-river-50598307/endpoints'
-H 'Accept: application/json'
-H "Authorization: Bearer $NEON_API_KEY"
-H 'Content-Type: application/json'
-d '{
"endpoint": {
"branch_id": "br-your-branch-id",
"type": "read_only"
}
}'
响应示例:
{
"endpoint": {
"host": "ep-proud-mud-adwmnxz4.c-2.us-east-1.aws.neon.tech",
"id": "ep-proud-mud-adwmnxz4",
"project_id": "hidden-river-50598307",
"branch_id": "br-super-wildflower-adniii9u",
"autoscaling_limit_min_cu": 0.25,
"autoscaling_limit_max_cu": 2,
"region_id": "aws-us-east-1",
"type": "read_only",
"current_state": "init",
"pending_state": "active",
"settings": {},
"pooler_enabled": false,
"pooler_mode": "transactio