查询实例详情
功能介绍
使用实例ID查询LakeFormation实例详情。
调试
您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
URI
GET /v1/{project_id}/instances/{instance_id}
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
project_id |
是 |
String |
项目编号。获取方法，请参见获取项目ID。 |
instance_id |
是 |
String |
LakeFormation实例ID。创建实例时自动生成。例如：2180518f-42b8-4947-b20b-adfc53981a25。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
X-Auth-Token |
是 |
String |
租户token。 |
响应参数
状态码： 200
参数 |
参数类型 |
描述 |
|---|---|---|
X-request-id |
String |
请求ID，定位辅助信息。 |
参数 |
参数类型 |
描述 |
|---|---|---|
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-扩容失败。 枚举值：
|
resource_progress |
Integer |
资源准备进度百分比，只有当实例处于资源准备中状态时才会计算并返回该值。 |
resource_expected_duration |
Integer |
资源准备预计时长，单位分钟。 |
scale_progress |
Integer |
规格变更进度百分比，只有当实例处于规格变更中状态时才会计算并返回该值。 |
scale_expected_duration |
Integer |
规格变更预计时长，单位分钟。 |
in_recycle_bin |
Boolean |
是否在回收站。 |
tags |
Array of ResourceTag objects |
标签列表。 |
specs |
Array of CreateSpec objects |
规格信息。 |
charge_mode |
String |
计费模式，postPaid=按需计费，prePaid=包周期计费。 枚举值：
|
参数 |
参数类型 |
描述 |
|---|---|---|
product_id |
String |
商品ID。由系统自动生成，如OFFI8XXXXXXXXXXXXXXXX4。 |
spec_code |
String |
规格编码。由系统自动生成，例如lakeformation.unit.basic.qps。 |
stride_num |
Integer |
步数。QPS为每秒最大请求数步长，最小为5，步长为1。 |
状态码： 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/{instance_id}
响应示例
状态码： 200
LakeFormation实例详情
{
"instance_id" : "01049549-82cd-4b2b-9733-ddb94350c125",
"name" : "LakeFormation_instance",
"description" : "string",
"enterprise_project_id" : 0,
"shared" : false,
"create_time" : "2022-10-08T12:49:19.000+00:00",
"update_time" : "2022-10-08T12:49:19.000+00:00",
"status" : "running",
"in_recycle_bin" : false,
"specs" : [ {
"spec_code" : "hws.resource.type.lakeformation.qps",
"stride_num" : 1
} ]
}
状态码： 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 |
错误码
请参见错误码。
