文档首页> 湖仓构建 LakeFormation> API参考> API> LakeCat> 配置管理> 获取所有用户可见的租户面配置
更新时间:2024-04-08 GMT+08:00
分享

获取所有用户可见的租户面配置

功能介绍

获取所有用户可见的租户面配置,此接口仅能从租户面调用,无法从管控面调用。

调试

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

URI

GET /v1/{project_id}/instances/{instance_id}/configurations

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

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

instance_id

String

LakeFormation实例ID。创建实例时自动生成。例如:2180518f-42b8-4947-b20b-adfc53981a25。

表2 Query参数

参数

是否必选

参数类型

描述

limit

Integer

查询返回条数。默认值为1000。最小值为0,最大值为1000。

marker

String

查询的起始记录ID。最小长度为0,最大长度为256。

reverse_page

Boolean

是否查询上一页。默认为false。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

Array of strings

租户token。

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

configs

Array of LakeCatConfiguration objects

配置项。

page_info

PagedInfo object

分页信息。

表5 LakeCatConfiguration

参数

参数类型

描述

key

String

配置项的key。

value

String

配置项的值。

description

String

配置项描述。

表6 PagedInfo

参数

参数类型

描述

current_count

Integer

本次返回的对象个数。最小值为0,最大值为2000。

next_marker

String

下一页查询地址。当不存在下一页,则值为null,当值为null时,响应Body无该参数。

previous_marker

String

上一页查询地址。当不存在上一页,则值为null,当值为null时,响应Body无该参数。

状态码: 400

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

solution_msg

String

解决方案描述。

状态码: 404

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

solution_msg

String

解决方案描述。

状态码: 500

表9 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

solution_msg

String

解决方案描述。

请求示例

GET https://{endpoint}/v1/{project_id}/instances/{instance_id}/configurations

响应示例

状态码: 200

OK

{
  "configs" : [ {
    "key" : "catalog.max.limit",
    "value" : 1,
    "description" : "catalog最大数量限制。"
  } ],
  "page_info" : {
    "current_count" : 2000,
    "next_marker" : "006f492b-xxxx",
    "previous_marker" : "003e6eba-xxxx"
  }
}

状态码: 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

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

408

Request Timeout

500

Internal Server Error

错误码

请参见错误码

分享:

    相关文档

    相关产品