查询端点规则列表 - ListEndpointRules
功能介绍
查询端点规则列表。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限,具体权限要求请参见权限和授权项。
URI
GET /v1/{project_id}/endpoint-rules
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 参数解释: 项目ID 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| offset | 否 | Integer | 参数解释: 分页查询时的偏移量。默认值为0。最小值为0,最大值为1000 约束限制: 取值为0~1000 取值范围: 取值为0~1000 默认取值: 0 |
| limit | 否 | Integer | 参数解释: 分页一页显示数。默认值为10。最小值为1,最大值为100 约束限制: 取值为1~100 取值范围: 取值为1~100 默认取值: 10 |
| endpoint_rule_id | 否 | String | 参数解释: 终端节点规则ID 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| endpoint_service | 否 | String | 参数解释: 终端节点服务名称 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| connection_status | 否 | String | 参数解释: 连接状态 约束限制: 不涉及 取值范围: CREATING:创建中 ESTABLISHED:已连接 DELETING:删除中 DELETED:删除完成 CREATE_FAIL:创建失败 DELETE_FAIL:删除失败 默认取值: 不涉及 |
| instance_id | 否 | String | 参数解释: LakeFormation实例ID 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
请求参数
无
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| total | Integer | 参数解释: 终端节点规则总数 |
| endpoint_rules | Array of EndpointRule objects | 参数解释: 终端节点规则列表 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| 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 |
请求示例
GET https://{endpoint}/v1/{project_id}/endpoint-rules 响应示例
状态码:200
终端节点信息列表
{
"total" : 1,
"endpoint_rules" : [ {
"endpoint_service" : "endpoint-service-name",
"connection_state" : "ESTABLISHED",
"create_time" : "2026-05-21T07:33:46.012Z"
} ]
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | 终端节点信息列表 |
错误码
请参见错误码。