查询实例列表
功能介绍
查询用户创建的实例列表信息。
调试
您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
URI
GET /v1/{project_id}/instances
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
project_id |
是 |
String |
项目编号。获取方法，请参见获取项目ID。 |
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
in_recycle_bin |
是 |
Boolean |
是否查询回收站中的实例。默认为false。 |
status |
否 |
String |
筛选实例状态：RESOURCE_PREPARATION-实例资源准备中、RUNNING-实例运行中、RESOURCE_RELEASE-实例资源释放中、DELETED-实例已释放、RESOURCE_PREPARATION_FAIL-实例资源准备失败、FROZEN_RELEASABLE-可恢复冻结、FROZEN_UNRELEASABLE-不可恢复冻结、RECOVERING-恢复中、DELETING-删除中、SCALING-扩容中、SCALE_FAIL-扩容失败。 枚举值：
|
offset |
是 |
Integer |
分页查询时的偏移量。默认值为0。最小值为0，最大值为1000。 |
limit |
是 |
Integer |
分页一页显示数。默认值为10。最小值为1，最大值为1000。 |
name |
否 |
String |
使用LakeFormation实例名称进行检索。只能包含字母、数字、下划线和中划线，且长度为4到32个字符。 |
enterprise_project_id |
是 |
String |
企业项目ID。由用户输入，只能包含字母、数字、下划线和中划线，且长度为1到36个字符。默认为all_granted_eps。 |
tags |
否 |
String |
标签条件列表。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
X-Auth-Token |
是 |
String |
租户token。 |
响应参数
状态码： 200
参数 |
参数类型 |
描述 |
|---|---|---|
X-request-id |
String |
请求ID，定位辅助信息。 |
参数 |
参数类型 |
描述 |
|---|---|---|
instances |
Array of LakeFormationInstance objects |
LakeFormation实例列表。 |
total |
Integer |
LakeFormation实例总数。 |
参数 |
参数类型 |
描述 |
|---|---|---|
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 |
标签列表。 |
状态码： 400
参数 |
参数类型 |
描述 |
|---|---|---|
error_code |
String |
错误码。 |
error_msg |
String |
错误描述。 |
common_error_code |
String |
CBC公共错误码。 |
solution_msg |
String |
解决方案描述。 |
状态码： 404
参数 |
参数类型 |
描述 |
|---|---|---|
error_code |
String |
错误码。 |
error_msg |
String |
错误描述。 |
common_error_code |
String |
CBC公共错误码。 |
solution_msg |
String |
解决方案描述。 |
状态码： 500
参数 |
参数类型 |
描述 |
|---|---|---|
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" : "0",
"shared" : false,
"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" : "0",
"shared" : false,
"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 |
错误码
请参见错误码。
