文档首页/ 湖仓构建 LakeFormation/ API参考/ API/ Console类API/ 实例管理/ 查询实例列表 - ListLakeFormationInstances
更新时间：2026-08-11 GMT+08:00
查看PDF
分享

查询实例列表 - ListLakeFormationInstances

功能介绍

查询用户创建的实例列表信息。

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限，具体权限要求请参见权限和授权项。

URI

GET /v1/{project_id}/instances

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释:

项目编号。获取方法，请参见获取项目ID

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及
表2 Query参数

参数

是否必选

参数类型

描述

in_recycle_bin

是

Boolean

参数解释:

是否查询回收站中的实例。默认为false

约束限制:

不涉及

取值范围:

不涉及

默认取值:

false

status

否

String

参数解释:

筛选实例状态：RESOURCE_PREPARATION-实例资源准备中、RUNNING-实例运行中、RESOURCE_RELEASE-实例资源释放中、DELETED-实例已释放、RESOURCE_PREPARATION_FAIL-实例资源准备失败、FROZEN_RELEASABLE-可恢复冻结、FROZEN_UNRELEASABLE-不可恢复冻结、RECOVERING-恢复中、DELETING-删除中、SCALING-扩容中、SCALE_FAIL-扩容失败

约束限制:

最小长度为1，可选值为：RESOURCE_PREPARATION, RUNNING, RESOURCE_RELEASE, DELETED, RESOURCE_PREPARATION_FAIL, FROZEN_RELEASABLE, FROZEN_UNRELEASABLE, RECOVERING, DELETING, SCALING, SCALE_FAIL

取值范围:

最小长度为1

默认取值:

不涉及

offset

是

Integer

参数解释:

分页查询时的偏移量。默认值为0。最小值为0，最大值为1000

约束限制:

取值为0~1000

取值范围:

取值为0~1000

默认取值:

0

limit

是

Integer

参数解释:

分页一页显示数。默认值为10。最小值为1，最大值为1000

约束限制:

取值为1~1000

取值范围:

取值为1~1000

默认取值:

10

name

否

String

参数解释:

使用LakeFormation实例名称进行检索。只能包含字母、数字、下划线和中划线，且长度为4到32个字符

约束限制:

长度为4~32个字符

取值范围:

长度为4~32个字符

默认取值:

不涉及

enterprise_project_id

否

String

参数解释:

企业项目ID。由用户输入，只能包含字母、数字、下划线和中划线，且长度为1到36个字符。默认为all_granted_eps

约束限制:

不涉及

取值范围:

不涉及

默认取值:

all_granted_eps

tags

否

String

参数解释:

标签条件列表

约束限制:

长度为1~500个字符

取值范围:

长度为1~500个字符

默认取值:

不涉及

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

否

String

参数解释:

租户token

约束限制:

长度为0~65534个字符

取值范围:

长度为0~65534个字符

默认取值:

不涉及

响应参数

状态码：200

表4 响应Header参数

参数

参数类型

描述

X-request-id

String

请求ID，定位辅助信息。
表5 响应Body参数

参数

参数类型

描述

instances

Array of LakeFormationInstance objects

参数解释:

LakeFormation实例列表

total

Integer

参数解释:

LakeFormation实例总数
表6 LakeFormationInstance

参数

参数类型

描述

instance_id

String

参数解释:

LakeFormation实例ID

name

String

参数解释:

实例名称

description

String

参数解释:

描述

enterprise_project_id

String

参数解释:

企业项目ID

shared

Boolean

参数解释:

逻辑多租和物理多租的判断。false为物理多租；true为逻辑多租

default_instance

Boolean

参数解释:

是否为默认实例

create_time

String

参数解释:

实例创建时间戳

update_time

String

参数解释:

实例更新时间戳

status

String

参数解释:

实例状态：RESOURCE_PREPARATION-实例资源准备中、RUNNING-实例运行中、RESOURCE_RELEASE-实例资源释放中、DELETED-实例已释放、RESOURCE_PREPARATION_FAIL-实例资源准备失败、FROZEN_RELEASABLE-可恢复冻结、FROZEN_UNRELEASABLE-不可恢复冻结、RECOVERING-恢复中、DELETING-删除中、SCALING-扩容中、SCALE_FAIL-扩容失败

in_recycle_bin

Boolean

参数解释:

是否在回收站

tags

Array of ResourceTag objects

参数解释:

标签列表
表7 ResourceTag

参数

参数类型

描述

key

String

参数解释:

键

取值范围:

不涉及

value

String

参数解释:

值

取值范围:

不涉及

状态码：400

表8 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

错误码

error_msg

String

参数解释:

错误描述

common_error_code

String

参数解释:

CBC公共错误码

solution_msg

String

参数解释:

解决方案描述

状态码：401

表9 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

错误码

error_msg

String

参数解释:

错误描述

common_error_code

String

参数解释:

CBC公共错误码

solution_msg

String

参数解释:

解决方案描述

状态码：403

表10 响应Body参数

参数

参数类型

描述

error

Error object

参数解释:

错误信息

error_code

String

参数解释:

错误码

error_msg

String

参数解释:

错误描述

title

String

参数解释:

标题
表11 Error

参数

参数类型

描述

error_code

String

参数解释:

错误码

error_msg

String

参数解释:

错误描述

title

String

参数解释:

标题

message

String

参数解释:

错误信息

code

String

参数解释:

状态码

状态码：404

表12 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

错误码

error_msg

String

参数解释:

错误描述

common_error_code

String

参数解释:

CBC公共错误码

solution_msg

String

参数解释:

解决方案描述

状态码：408

表13 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

错误码

error_msg

String

参数解释:

错误描述

common_error_code

String

参数解释:

CBC公共错误码

solution_msg

String

参数解释:

解决方案描述

状态码：500

表14 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

错误码

error_msg

String

参数解释:

错误描述

common_error_code

String

参数解释:

CBC公共错误码

solution_msg

String

参数解释:

解决方案描述

请求示例

GET https://{endpoint}/v1/{project_id}/instances?in_recycle_bin=false

响应示例

状态码：200

LakeFormation实例列表

{
  "instances" : [ {
    "instance_id" : "9c368079-6401-4886-991d-0b1bb11e3702",
    "name" : "LakeFormation_instance",
    "description" : "string",
    "enterprise_project_id" : "123",
    "shared" : true,
    "create_time" : "2022-11-08T04:08:39.000+00:00",
    "update_time" : "2022-11-08T04:08:40.000+00:00",
    "status" : "RUNNING",
    "in_recycle_bin" : false
  }, {
    "instance_id" : "dec259f5-c7a8-413e-91b3-67d66c512680",
    "name" : "LakeFormation_instance_test",
    "description" : "string",
    "enterprise_project_id" : "123",
    "shared" : true,
    "create_time" : "2022-11-08T04:07:42.000+00:00",
    "update_time" : "2022-11-08T04:07:42.000+00:00",
    "status" : "RUNNING",
    "in_recycle_bin" : false
  } ],
  "total" : 2
}

状态码：400

Bad Request

{
  "error_code" : "common.01000001",
  "error_msg" : "failed to read http request, please check your input, code: 400, reason: Type mismatch., cause: TypeMismatchException"
}

状态码：401

Unauthorized

{
  "error_code" : "APIG.1002",
  "error_msg" : "Incorrect token or token resolution failed"
}

状态码：403

Forbidden

{
  "error" : {
    "code" : "403",
    "message" : "X-Auth-Token is invalid in the request",
    "error_code" : null,
    "error_msg" : null,
    "title" : "Forbidden"
  },
  "error_code" : "403",
  "error_msg" : "X-Auth-Token is invalid in the request",
  "title" : "Forbidden"
}

状态码：404

Not Found

{
  "error_code" : "common.01000001",
  "error_msg" : "response status exception, code: 404"
}

状态码：408

Request Timeout

{
  "error_code" : "common.00000408",
  "error_msg" : "timeout exception occurred"
}

状态码：500

Internal Server Error

{
  "error_code" : "common.00000500",
  "error_msg" : "internal error"
}

状态码

状态码

描述

200

LakeFormation实例列表

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

408

Request Timeout

500

Internal Server Error

错误码

请参见错误码。

父主题： 实例管理

相关文档