创建终端节点规则 - CreateEndpointRule
功能介绍
创建终端节点规则,创建后LakeFormation会异步创建VPCEP,打通LakeFormation实例与租户VPC之间的网络。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限,具体权限要求请参见权限和授权项。
URI
POST /v1/{project_id}/endpoint-rules
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 参数解释: 项目编号 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| endpoint_service | 是 | String | 参数解释: 终端节点服务名称 约束限制: 长度为1~64个字符 取值范围: 长度为1~64个字符 默认取值: 不涉及 |
| instance_id | 否 | String | 参数解释: LakeFormation实例ID。创建实例时自动生成。例如:2180518f-42b8-4947-b20b-adfc53981a25 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
响应参数
状态码:201
| 参数 | 参数类型 | 描述 |
|---|---|---|
| endpoint_rule_id | String | 参数解释: 终端节点规则ID |
| endpoint_service | String | 参数解释: 终端节点服务名称 |
| connection_state | String | 参数解释: 连接状态 约束限制: 不涉及 取值范围: CREATING:创建中 ESTABLISHED:已接受 DELETING:删除中 DELETED:删除完成 CREATE_FAIL:创建失败 DELETE_FAIL:删除失败 默认取值: 不涉及 |
| create_time | String | 参数解释: 创建时间 |
| update_time | String | 参数解释: 更新时间 |
| error_message | String | 参数解释: 错误信息 |
| vpc_endpoint_id | String | 参数解释: VPC终端节点ID |
| vpc_endpoint_ip | String | 参数解释: VPC终端节点IP |
| instance_id | String | 参数解释: LakeFormation实例ID。创建实例时自动生成。例如:2180518f-42b8-4947-b20b-adfc53981a25 |
请求示例
POST https://{endpoint}/v1/{project_id}/endpoint-rules
{
"endpoint_service" : "endpoint_service_name",
"instance_id" : "2180518f-42b8-4947-b20b-adfc53981a25"
} 响应示例
状态码:201
Created
{
"endpoint_rule_id" : "string",
"endpoint_service" : "endpoint-service-name",
"connection_state" : "ESTABLISHED",
"create_time" : "2026-05-25T03:16:25.830Z",
"update_time" : "2026-05-25T03:16:25.830Z",
"error_message" : "string",
"vpc_endpoint_id" : "id",
"vpc_endpoint_ip" : "ip",
"instance_id" : "2180518f-42b8-4947-b20b-adfc53981a25"
} 状态码
| 状态码 | 描述 |
|---|---|
| 201 | Created |
错误码
请参见错误码。