华为云用户手册

操作步骤 登录KooMap服务控制台，进入控制台页面。 在左侧导航栏，选择“AR地图”下的“项目管理”菜单，进入“项目管理”页面。 在“项目管理”页面，单击“新增项目”。 在“新增项目”弹窗中，参考表1填写项目相关信息。 表1 新增项目 配置项 配置说明 项目名称 必填项。 输入项目名称。 名称不可重复。 行政区域 必选项。 选择项目覆盖的行政区域。 项目描述 选填项。 根据界面提示输入有关项目描述信息。 单击“确定”，完成新增项目的创建。 新建的项目将显示在项目列表最前端。

KooMap服务与其他服务的关系 使用KooMap卫星影像生产服务需要配套OBS服务，KooMap系统从OBS加载原始影像文件或矢量数据，再进行影像处理。 使用KooMap实景三维生产服务需要配套OBS服务，KooMap系统从OBS加载倾斜摄影影像，再进行影像建模。 使用KooMap AR地图运行服务基础版，建议您先购买AR地图生产服务或咨询人工客服购买AR地图数据采集服务和AR地图数据构建服务，对业务指定的区域进行AR地图采集和生产并部署上云后，再通过API和SDK访问AR地图运行服务。 父主题： 其他问题

官方镜像工具 编译工具 使用版本 是否默认 jdk 8u372 - 11.0.18 是 17.0.2 - nodejs 18.18.2 是 20.10.0 - go 1.18.7 是 1.20.7 - python 3.8.18 是 3.12.1 - maven 3.8.8 是 内置工具 说明 git 2.27.0 jq 1.6 gcc 7.3.0 cmake 3.16.5 lz4 1.9.2 make 4.3 zip 3.0 unzip 6.0 curl 7.71.1 openssh 8.2 haveged 1.9.13 bzip2-devel 1.0.8 zlib 1.2.11 zlib-devel 1.2.11 父主题： 扩展插件

后续操作 查看代理列表 在资源池列表中找到目标资源池，单击资源池名称，进入“代理列表”页面。 代理列表可显示代理机状态、内存使用率、可用硬盘等信息。 代理机有以下五种状态： 表5 代理机状态说明 代理机状态 说明 运行中 代理机正在执行任务。 空闲中 代理机处于连接状态，未运行任务。 停用 代理机处于连接状态，但被停用无法执行任务。 下线 代理机处于掉线断开状态，如需上线请登录代理机重新注册，否则删除即可。 删除中 代理机正在被删除中。 删除代理 在“代理列表”页面，单击操作列，可以删除指定的代理机。 “运行中”状态的代理机无法删除。 启动/停用代理 在“代理列表”页面，单击操作列，可停用对应代理，停用后，状态列显示为“停用”；单击，可以重新启用代理，状态列恢复为“空闲中”。 查看资源池详情 在“代理列表”页面，单击“资源池详情”页签，可以查看资源池的详细信息（资源池所有者、资源池类型、资源池创建时间以及描述信息）。

新建代理 完成新建资源池后，在资源池列表中找到目标资源池，单击资源池名称，进入“代理列表”页面。 单击“新建代理”，页面弹出对话框。 根据需要完成参数配置。 配置主机所需的网络环境。 表3 步骤一配置 配置项 配置说明 自动安装JDK 主机需要具备JAVA8+环境。 开启此开关后，将为主机自动安装JDK至“/usr/local”目录中。 如果关闭此开关，则需手动安装。如何安装JAVA8+？ 说明： 仅资源池类型为“LINUX”或“LINUX_DOCKER”时显示此配置项。 自动安装Git 主机需要具备Git环境。 开启此开关后，将为主机自动安装Git。 如果关闭此开关，则需手动安装。如何安装Git？ 说明： 仅资源池类型为“LINUX”或“LINUX_DOCKER”时显示此配置项。 自动安装Docker 主机需要具备Docker环境。 开启此开关后，将为主机自动安装Docker至“/usr/bin”目录中。安装完成后将自动注册服务并启动docker服务。 如果关闭此开关，则需手动安装。如何安装Docker？ 说明： 仅资源池类型为“LINUX”或“LINUX_DOCKER”时显示此配置项。 配置身份认证信息。 表4 步骤二配置 配置项 配置说明 AK Access Key Id。 在通过获取AK/SK下载的访问密钥文件中获取。 SK Secret Access Key。 在通过获取AK/SK下载的访问密钥文件中获取。 代理名称 代理（Agent）的名称，同一台主机不可以安装相同名称的代理。 请根据实际情况填写。为了方便管理，命名建议清晰，建议关联代理机IP，如：10.10.10.10-agent-01。 代理工作空间 代理在主机上运行的工作目录，任务执行的工作空间，同一台主机的不同代理不可以使用同样的代理工作空间。 请根据实际情况填写。为了方便管理，建议关联数据盘，例如： Linux：/opt/cloud/agent01。 Windows：C:/opt/cloud/agent01。 MAC：/opt/cloud/agent01。 生成命令。 完成参数配置，勾选“我已阅读并同意”，单击“生成命令”，命令框中自动生成安装代理命令。 单击“复制命令”，复制此命令。 登录主机，执行上一步复制的安装命令。 Linux主机：使用root账号登录主机，执行安装命令。 Windows主机：使用管理员身份登录主机，打开Git Bash，执行安装命令。 MAC主机：使用root账号登录主机，执行安装命令。 当命令终端显示如下提示时，表示安装结束。 图1 安装成功回显 返回“代理列表”页面，关闭弹窗。 等待10-30秒，刷新页面，在列表中可查看到已经安装的代理实例状态为“空闲中”，表示安装成功。

inputs介绍 inputs示例及参数介绍如下： { "name": "samplestring", # 如插件业务脚本中使用${samplestring}获取运行者在流水线上配置的值 "type": "input", # 不同类型信息对应不同展示功能，可选项见下文 "description": "Sample String", # input条目的描述信息，用于描述其值含义 "defaultValue": "00", # 默认值，required属性为false时，如不在流水线上重新输入，则默认使用此值 "required": true, # true则流水线编辑时必须重新填值，false则不填使用默认值 "label": "测试输入框", # input条目在流水线编辑页面显示的名称信息 "validation": { "requiredMessage": "请输入值", # (可选) 如required字段为true，未填写时的提示信息 "regex": "^[a-zA-Z0-9-_\\u4e00-\\u9fa5]{1,32}$", # (可选)可填写正则校验的内容 "regexMessage": "类型错误" # (可选) 如正则校验失败的提示信息 } } 当前支持的全量inputs定义请参见全量inputs。

插件包结构 文件结构： extension.zip # 插件zip包 | -- scripts # （可选）脚本文件夹，用于存放包含插件执行逻辑的脚本 | | -- xxx # 包含插件执行逻辑的脚本 | -- i18n # （可选）多语言，存放所有文案信息 | | -- zh-cn # 中文环境内容 | | -- resources.json # 对应语言的国际化资源 | | -- en-us # 英文环境内容 | | -- resources.json # 对应语言的国际化资源 | -- codeArts-extension.json # （必选）插件执行定义文件，Json格式，包括扩展插件的基本信息+input+execution 注意事项：

codearts-extension.json文件定义 “codearts-extension.json”文件示例内容如下： { "type": "Task", "name": "demo_plugin", "friendlyName": "示例插件", "description": "这是一个示例插件", "category": "Gate", "version": "0.0.2", "versionDescription": "0.0.1初始化版本", "dataSourceBindings": [], "inputs": [{ "label": "服务调用地址", "name": "SERVICE_URL", "type": "input", "description": "请输入服务地址url", "defaultValue": "", "required": true }, { "label": "调用服务的token", "name": "SERVICE_TOKEN", "type": "input", "description": "请输入调用服务的token", "defaultValue": "", "required": true }], "execution": { "type": "Shell", "target": "scripts/execution.sh" }, "outputs": [] } 参数说明如下： 参数项 说明 type 填写固定值“Task”，标识为一个插件类型。 name 请与注册插件时页面填写的基本信息“唯一标识”字段一致。 friendlyName 请与注册插件时页面填写的基本信息“插件名称”字段一致。 category 请与注册插件时页面填写的基本信息“插件类型”字段一致，包括以下可选值： Build：对应“构建”插件类型。 Test：对应“测试”插件类型。 Gate：对应“代码检查”插件类型。 Normal：对应“通用”插件类型。 Deploy：对应“部署”插件类型。 version 插件版本，支持填写3组0-99的数字，如需新增正式版本，请修改此字段。 description 插件的描述信息。 versionDescription 此版本插件的描述信息，建议体现每个版本的差异点。 dataSourceBindings 此字段暂时未启用，请将值设置为“[]”。 inputs 插件输入内容，对应流水线页面插件展示格式，其值可在业务脚本中通过引用环境变量的方式引用。 execution 业务插件执行内容，其中type字段为业务脚本语言类型，target字段为执行文件入口，建议放在scripts文件夹下。 outputs 插件输出内容，在插件运行结束后写入此处定义值，可对应用作门禁指标metrics，不同的展示结果output。

KooMap服务采用哪种计费模式，如何计费 计费模式：KooMap支持按需计费和套餐包两种计费模式。按需计费根据用户实际使用量和使用时长计费。这种计费方式比较灵活，可以按需开通和释放资源。套餐包是一种先付费再使用的计费模式，适用于对产品需求稳定且希望降低成本的用户。 计费规则： 卫星影像生产服务总费用 = 时空专属存储费用 + 各个基础处理服务费用 AR地图运行服务基础版总费用 = 时空专属存储费用 （公测时间不收取费用）+ 视觉定位和AR导航调用费用 实景三维生产服务总费用 = 时空专属存储费用 + 实景三维生产服务费用（基础版或专业版） AR地图生产服务总费用 = 时空专属存储费用（公测时间不收取费用） + AR地图生产服务费用 父主题： 计费FAQ

操作步骤 调用创建实例接口，创建LakeFormation实例，同时记录接口返回的实例Id。 请求示例： POST https://{endpoint}/v1/{project_id}/instances Body: { "name": "lakeformation", "charge_mode": "postPaid", "shared": "false", "specs": [ { "spec_code": "lakeformation.unit.basic.qps", "stride_num": 1 } ], "enterprise_project_id": "0" } 响应示例： { "instance_id": "13677734-a4ee-43e2-9d11-30b8b2e32a95", "name": "lakeformation", "description": "", "enterprise_project_id": "0", "shared": false, "default_instance": false, "create_time": "2023-06-29T09:08:33.000+00:00", "update_time": "2023-06-29T09:08:34.000+00:00", "status": "RESOURCE_PREPARATION", "resource_progress": 25, "resource_expected_duration": 15, "in_recycle_bin": false, "tags": [], "specs": [ { "spec_code": "lakeformation.unit.basic.qps", "stride_num": 1 }, { "spec_code": "lakeformation.unit.basic.metadata", "stride_num": 0 } ] } 调用查询实例详情接口，查询实例状态，等待实例状态变为RUNNING运行中，表示实例创建完成。 请求示例： GET https://{endpoint}/v1/{project_id}/instances/{instance_id} instance_id：1响应信息中的“instance_id”参数值。 响应示例： { "instance_id": "13677734-a4ee-43e2-9d11-30b8b2e32a95", "name": "lakeformation", "description": "", "enterprise_project_id": "0", "shared": false, "default_instance": false, "create_time": "2023-06-29T09:08:33.000+00:00", "update_time": "2023-06-29T09:08:34.000+00:00", "status": "RUNNING", "in_recycle_bin": false, "tags": [], "specs": [ { "spec_code": "lakeformation.unit.basic.qps", "stride_num": 1 }, { "spec_code": "lakeformation.unit.basic.metadata", "stride_num": 0 } ] } （可选）如果当前租户首次创建LakeFormation实例，该实例将自动作为默认实例（default）。客户端可以直接访问默认实例，或通过指定具体的实例ID来访问对应的实例。非默认实例可以通过调用设为默认实例接口将非默认实例设为默认实例。 请求示例： POST https://{endpoint}/v1/{project_id}/instances/{instance_id}/default instance_id：1响应信息中的“instance_id”参数值。 调用创建服务接入客户端接口，选择客户端对应的VPC相关信息创建接入客户端，LakeFormation服务将自动为其创建终端节点和DNS内网域名，用于打通网络连接。 请求示例： POST https://{endpoint}/v1/{project_id}/instances/{instance_id}/access-clients instance_id：1响应信息中的“instance_id”参数值。 Body: { "name": "access-client", "vpc_id": "131fb837-37ae-4aa6-9e87-312919df659f", "subnet_id": "2fa7ec47-c7f6-4a81-8e77-1dd41121b726" } 响应示例： { "id": "b73a9311-1ce9-48fe-b714-21bc41ce7b82", "name": "access-client", "access_mode": "SYSTEM", "status": "CREATING", "vpc_id": "131fb837-37ae-4aa6-9e87-312919df659f", "subnet_id": "2fa7ec47-c7f6-4a81-8e77-1dd41121b726" } 调用获取服务接入客户端详情接口，查询接入客户端状态，等待状态变为RUNNING，表示接入客户端创建完成，同时可以在详情中查看接入IP、域名等详细信息。 请求示例： GET https://{endpoint}/v1/{project_id}/instances/{instance_id}/access-clients/{client_id} instance_id：1响应信息中的“instance_id”参数值。 client_id：4响应信息中的“id”参数值。 响应示例： { "id": "b73a9311-1ce9-48fe-b714-21bc41ce7b82", "name": "access-client", "access_mode": "SYSTEM", "status": "RUNNING", "vpc_id": "131fb837-37ae-4aa6-9e87-312919df659f", "subnet_id": "2fa7ec47-c7f6-4a81-8e77-1dd41121b726", "access_connections": [ { "vpcep_id": "f72c8034-df38-4dbc-bd5d-2f50531ba104", "ip": "10.0.0.6", "owner": "555d9e8999c94705be3d7edb70a3199a", "domain": "xxx.dalf-ed1c-b3070cba-baae-4220-b7ff-9b2bca043efb.apig-lakeformation.com" } ], "create_time": "2023-06-29T12:12:12.000+00:00" } 参考目录管理相关接口，使用上述步骤获取的接入IP与实例ID访问元数据管理相关接口，获取目录列表。 请求示例： GET https://{endpoint}/v1/{project_id}/instances/{instance_id}/catalogs endpoint：{instance_id}.lakeformation.lakecat.com，如果已经将实例设为默认实例可以使用default-{project_id}.lakeformation.lakecat.com。 instance_id：1响应信息中的“instance_id”参数值，如果已经将实例设为默认实例可以直接使用default作为实例ID。 请求头示例 Host：lakeformation.lakecat.com 响应示例： [ { "catalog_name": "hive", "description": "Default catalog, for Hive", "location": "obs://lakeformation-555d9e8999c94705-xxx/ed1ce787-1671-4ce4-b84f-6f40ccb26752" } ]

URI GET /v1/{project_id}/instances/{instance_id}/access-clients 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目编号。获取方法，请参见获取项目ID。 instance_id 是 String LakeFormation实例ID。创建实例时自动生成。例如：2180518f-42b8-4947-b20b-adfc53981a25。 表2 Query参数 参数 是否必选 参数类型 描述 id 否 String ID搜索。根据ID进行搜索。 name 否 String 名称关键字搜索。只能包含字母、数字、下划线和中划线，且最大长度为32个字符。 offset 是 Integer 分页查询时的偏移量。默认值为0。最小值为0，最大值为1000。 limit 否 Integer 分页一页显示数。默认值为10。最小值为1，最大值为1000。

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 access_client_infos Array of AccessClientInfo objects 接入客户端信息列表。 total Integer 接入客户端信息总数。 表5 AccessClientInfo 参数 参数类型 描述 id String 客户端ID。 name String 客户端名称。 access_mode String 接入模式：YSTEM、CUSTOM、AUTO。 枚举值： SYSTEM CUSTOM AUTO status String 客户端状态：CREATING、RUNNING、DELETING、DELETED、CREATE_FAIL、DELETE_FAIL。 枚举值： CREATING RUNNING DELETING DELETED CREATE_FAIL DELETE_FAIL vpc_id String VPC ID。 subnet_id String 子网ID。 access_connections Array of AccessConnectionInfo objects 接入连接列表。 create_time String 实例创建时间戳。 表6 AccessConnectionInfo 参数 参数类型 描述 vpcep_id String 虚拟私有云终端节点ID。在接入管理-创建客户端-前往VPC创建-VPC终端节点 创建和查看。 ip String 接入IP。 owner String 拥有者。 domain String 接入域名，通过IP接入访问Lakeformation API时，需在请求头中添加HOST参数并传入该域名。

响应示例 状态码： 200 OK { "total" : 1, "access_client_infos" : [ { "id" : "gs23xxxxxxxxxxxxxxxxxxxxxxxxxxxxfgs2", "name" : "lakeformation_client", "access_mode" : "SYSTEM", "vpc_id" : "d3fcxxxxxxxxxxxxxxxxxxxxxxxxxxxx8f1e", "subnet_id" : "d3fcxxxxxxxxxxxxxxxxxxxxxxxxxxxx8f1e", "status" : "RUNNING", "access_connections" : [ { "vpcep_id" : "0612xxxxxxxxxxxxxxxxxxxxxxxxxxxxa8fb", "ip" : "10.1.0.1", "domain" : "xxxxxx.com" }, { "vpcep_id" : "0612xxxxxxxxxxxxxxxxxxxxxxxxxxxxa8fb", "ip" : "10.1.0.2", "domain" : "xxxxxx.com" } ] } ] }

URI GET /v1/{project_id}/instances/{instance_id}/access 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目编号。获取方法，请参见获取项目ID。 instance_id 是 String LakeFormation实例ID。创建实例时自动生成。例如：2180518f-42b8-4947-b20b-adfc53981a25。 表2 Query参数 参数 是否必选 参数类型 描述 offset 是 Integer 分页查询时的偏移量。默认值为0。最小值为0，最大值为1000。 limit 否 Integer 分页一页显示数。默认值为10，最大值为1000。

响应示例 状态码： 200 OK { "total" : 1, "access_infos" : [ { "vpcep_service_name" : "xxxxxx.apig.3ab1xxxxxxxxxxxxxxxxxxxxxxxxxxxxf524", "domain" : "xxxxxxxxxxxxxxxxxxxxxxxxxxxx.com" } ] } 状态码： 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 表4 响应Body参数 参数 参数类型 描述 access_infos Array of AccessInfo objects accessinfo列表。 total Integer accessinfo总数。 表5 AccessInfo 参数 参数类型 描述 vpcep_service_name String 服务名称。 domain String 分组独立域名。 状态码： 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 common_error_code String CBC公共错误码。 solution_msg String 解决方案描述。 状态码： 404 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 common_error_code String CBC公共错误码。 solution_msg String 解决方案描述。 状态码： 500 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 common_error_code String CBC公共错误码。 solution_msg String 解决方案描述。

URI GET /v1/{project_id}/instances/{instance_id}/catalogs 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目编号。获取方法，请参见获取项目ID。 instance_id 是 String LakeFormation实例ID。创建实例时自动生成。例如：2180518f-42b8-4947-b20b-adfc53981a25。 表2 Query参数 参数 是否必选 参数类型 描述 branch_name 否 String 分支名称。只能包含字母、数字和下划线，且长度为1~32个字符。默认值为main。 version 否 Long 版本。 deleted 否 Boolean 是否查询被删除元数据。

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 [数组元素] Array of Catalog objects OK 表5 Catalog 参数 参数类型 描述 catalog_name String catalog名称。 catalog_id String catalogID。 description String 描述信息。 location String 路径地址。例如obs://location/uri/。 database_location_list Array of strings 数据库路径列表。当值为null时，响应Body无该参数。 owner String catalog所有者。LakeFormation服务分为一期和二期，一期响应Body无该参数。 owner_type String 所有者类型，USER-用户，GROUP-组，ROLE-角色。LakeFormation服务分为一期和二期，一期响应Body无该参数。 枚举值： USER ROLE GROUP owner_source String 所有者来源：IAM-云用户、SAML-联邦、LDAP-ld用户、LOCAL-本地用户、AGENTTENANT-委托、OTHER-其它。LakeFormation服务分为一期和二期，一期响应Body无该参数。 枚举值： IAM SAML LDAP LOCAL AGENTTENANT OTHER type String catalog类型，可选值为DEFAULT（代表默认的元数据类型）、CLICKHOUSE（代表CH类型），不设置时默认为DEFAULT。 创建时指定，不可修改。 枚举值： DEFAULT CLICKHOUSE update_time String catalog元数据最后一次修改时间。 状态码： 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 solution_msg String 解决方案描述。 状态码： 404 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 solution_msg String 解决方案描述。 状态码： 500 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 solution_msg String 解决方案描述。

响应示例 状态码： 200 OK [ { "catalog_name" : "hive", "description" : "Default catalog, for Hive", "location" : "obs://lakeformation/test", "database_location_list" : null, "owner" : "admin", "owner_type" : "USER", "owner_source" : "IAM" } ] 状态码： 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 租户协议查询响应体 { "agreements" : [ { "agreement_name" : "agreement AAA", "agreement_version" : "v1" }, { "agreement_name" : "agreement BBB", "agreement_version" : "v1" } ], "is_agency" : true } 状态码： 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 表3 响应Header参数 参数 参数类型 描述 X-request-id String 请求ID，定位辅助信息。 表4 响应Body参数 参数 参数类型 描述 agreements Array of TenantAgreement objects 租户协议列表。 is_agency Boolean 是否绑定了委托。 表5 TenantAgreement 参数 参数类型 描述 agreement_name String 协议名称。只能包含字母、数字、下划线和中划线，且长度为1到64个字符。 agreement_version String 协议版本号。只能包含字母和数字，且长度为1到32个字符。 状态码： 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 common_error_code String CBC公共错误码。 solution_msg String 解决方案描述。 状态码： 404 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 common_error_code String CBC公共错误码。 solution_msg String 解决方案描述。 状态码： 500 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 common_error_code String CBC公共错误码。 solution_msg String 解决方案描述。

响应示例 状态码： 202 Created { "id" : "gs23xxxxxxxxxxxxxxxxxxxxxxxxxxxxfgs2", "name" : "lakeformation_client", "access_mode" : "SYSTEM", "vpc_id" : "d3fcxxxxxxxxxxxxxxxxxxxxxxxxxxxx8f1e", "subnet_id" : "d3fcxxxxxxxxxxxxxxxxxxxxxxxxxxxx8f1e", "status" : "CREATING" }

URI POST /v1/{project_id}/instances/{instance_id}/access-clients 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目编号。获取方法，请参见获取项目ID。 instance_id 是 String LakeFormation实例ID。创建实例时自动生成。例如：2180518f-42b8-4947-b20b-adfc53981a25。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 租户token。 表3 请求Body参数 参数 是否必选 参数类型 描述 name 是 String 客户端名称。只能包含字母、数字、下划线和中划线，且长度为4到32个字符。 access_mode 否 String 接入模式， SYSTEM：系统默认模式，由系统自动创建vpcep连接，也是推荐方式。该模式下vpc_id、subnet_id必填。 CUSTOM：定制模式，由外部服务自行创建vpcep连接，适用于跨租户场景等。该模式下access_connections必填。不建议使用，使用接入租户相关接口代替。 枚举值： SYSTEM CUSTOM vpc_id 否 String VPC ID，即虚机私有云ID。可以在 接入管理-创建客户端-前往VPC创建 进行创建。 subnet_id 否 String 子网ID。创建子网时由系统生成。例如8c6721b5-78d1-4c3c-97b1-8421da139ffc。 access_connections 否 Array of AccessConnectionRequestBody objects 接入连接列表，当接入模式为CUSTOM模式时生效。 表4 AccessConnectionRequestBody 参数 是否必选 参数类型 描述 vpcep_id 否 String 虚拟私有云终端节点ID。在 接入管理-创建客户端-前往VPC创建-VPC终端节点 创建和查看。 vpcep_service_name 否 String 终端节点服务名称。最大长度为64个字符。 domain 否 String 接入域名，通过IP接入访问Lakeformation API时，需在请求头中添加HOST参数并传入该域名。

响应参数 状态码： 202 表5 响应Body参数 参数 参数类型 描述 id String 客户端ID。 name String 客户端名称。 access_mode String 接入模式：YSTEM、CUSTOM、AUTO。 枚举值： SYSTEM CUSTOM AUTO status String 客户端状态：CREATING、RUNNING、DELETING、DELETED、CREATE_FAIL、DELETE_FAIL。 枚举值： CREATING RUNNING DELETING DELETED CREATE_FAIL DELETE_FAIL vpc_id String VPC ID。 subnet_id String 子网ID。 access_connections Array of AccessConnectionInfo objects 接入连接列表。 create_time String 实例创建时间戳。 表6 AccessConnectionInfo 参数 参数类型 描述 vpcep_id String 虚拟私有云终端节点ID。在接入管理-创建客户端-前往VPC创建-VPC终端节点 创建和查看。 ip String 接入IP。 owner String 拥有者。 domain String 接入域名，通过IP接入访问Lakeformation API时，需在请求头中添加HOST参数并传入该域名。

URI GET /v1/{project_id}/instances/{instance_id}/catalogs/{catalog_name}/databases/names 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目编号。获取方法，请参见获取项目ID。 instance_id 是 String LakeFormation实例ID。创建实例时自动生成。例如：2180518f-42b8-4947-b20b-adfc53981a25。 catalog_name 是 String catalog名称。只能包含字母、数字和下划线，且长度为1~256个字符。 表2 Query参数 参数 是否必选 参数类型 描述 database_pattern 否 String 数据库名称通配符。只能包含中文、字母、数字和_-|*.特殊字符，且长度为1~128个字符。

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 [数组元素] Array of strings OK 状态码： 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 solution_msg String 解决方案描述。 状态码： 404 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 solution_msg String 解决方案描述。 状态码： 500 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 solution_msg String 解决方案描述。

响应示例 状态码： 200 OK [ "test" ] 状态码： 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" }

响应示例 状态码： 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" }

请求示例 POST https://{endpoint}/v1/{project_id}/agreement { "agreements" : [ { "agreement_name" : "agreement AAA", "agreement_version" : "v1" }, { "agreement_name" : "agreement BBB", "agreement_version" : "v1" } ] }