华为云用户手册

修订记录 发布日期 修订记录 2024-04-08 第十一次公测发布。 新增AR地图操作指导。 2023-12-28 第十次公测发布。 入门指引：增加实景三维生产服务相关描述。 实景三维操作指导：新增该章节。 2023-11-17 第九次公测发布。 新建工作共享空间： 修改每个租户下创建工作共享空间的上限值。 表1中删除“空间类型”参数。 处理影像数据： 在“查看成果数据”的操作步骤中增加说明。 增加“执行成功”状态下的任务可被删除的相关描述。 2023-05-30 第八次公测发布。 处理影像数据：在“查看成果数据”的操作步骤中增加说明。 导入数据：更新导入卫星影像图片。 2023-04-25 第七次公测发布。 导入数据：新增命名辅助工具内容描述，删除影像供应商相关内容描述以及更新相关图片。 创建任务：更新带有供应商字段的相关图片。 2023-03-29 第六次公测发布。 导入数据：新增适配的卫星型号SJ9A。 创建任务：新增国家2000、国家2000-GaussKruger坐标系相关操作描述。 2023-03-10 第五次公测发布。 导入数据：更新支持的影像供应商型号和新增导入生产资料的操作描述。 创建任务：新增L3处理等级和导入生产资料操作描述。 处理影像数据：更新图1 任务概览页和表1 操作任务与操作步骤。 查看用量统计：更新卫星影像生产服务用量的统计内容与相关图片。 2023-02-03 第四次公测发布。 导入数据：新增四维测绘支持的卫星型号和更新相关图片。 2023-01-18 第三次公测发布。 导入数据：删除“导入影像参数说明”表格有关坐标系的描述。 创建任务：新增坐标系的描述。 2023-01-11 第二次公测发布。 导入数据：新增导入参数的提示信息。 新建工作共享空间：更新功能参数的名称。 创建任务：新增卫星影像文件的选择规则以及更新图片。 处理影像数据：更新概览页图片。 查看用量统计：更新导航路径与图片。 2022-12-27 第一次公测发布。

官方镜像工具 编译工具 使用版本 是否默认 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秒，刷新页面，在列表中可查看到已经安装的代理实例状态为“空闲中”，表示安装成功。

操作步骤 调用创建实例接口，创建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" } ]

响应示例 状态码： 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 解决方案描述。

响应参数 状态码： 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 解决方案描述。

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 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" } ] }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 租户token。 表3 请求Body参数 参数 是否必选 参数类型 描述 agreements 否 Array of TenantAgreement objects 租户协议列表。 表4 TenantAgreement 参数 是否必选 参数类型 描述 agreement_name 否 String 协议名称。只能包含字母、数字、下划线和中划线，且长度为1到64个字符。 agreement_version 否 String 协议版本号。只能包含字母和数字，且长度为1到32个字符。

响应参数 状态码： 200 表5 响应Header参数 参数 参数类型 描述 X-request-id String 请求ID，定位辅助信息。 状态码： 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 解决方案描述。

Token认证 Token的有效期为24小时，需要使用一个Token鉴权时，可以先缓存起来，避免频繁调用。 使用Token前请确保Token离过期有足够的时间，防止调用API的过程中Token过期导致调用API失败。 Token在计算机系统中代表令牌（临时）的意思，拥有Token就代表拥有某种权限。Token认证就是在调用API的时候将Token加到请求消息头，从而通过身份认证，获得操作API的权限。 Token可通过调用获取用户Token接口获取，调用本服务API需要project级别的Token，即调用获取用户Token接口时，请求body中auth.scope的取值需要选择project，如下所示。 { "auth": { "identity": { "methods": [ "password" ], "password": { "user": { "name": "username", //用户名 "password": "********", //用户名对应的密码 "domain": { "name": "domainname" //用户名所属的租户 } } } }, "scope": { "project": { "id": "xxxxxxxx" //token作用范围对应的资源集ID } } } } 获取Token 后，再调用其他接口时，您需要在请求消息头中添加“X-Auth-Token”，其值即为Token。例如Token值为“ABCDEFJ....”，则调用接口时将“X-Auth-Token: ABCDEFJ....”加到请求消息头即可，如下所示。 Content-Type: application/json X-Auth-Token: ABCDEFJ....

AK/SK认证 AK/SK签名认证方式仅支持消息体大小12M以内，12M以上的请求请使用Token认证。 AK/SK认证就是使用AK/SK对请求进行签名，在请求时将签名信息添加到消息头，从而通过身份认证。 AK(Access Key ID)：访问密钥ID。与私有访问密钥关联的唯一标识符；访问密钥ID和私有访问密钥一起使用，对请求进行加密签名。 SK(Secret Access Key)：与访问密钥ID结合使用的密钥，对请求进行加密签名，可标识发送方，并防止请求被修改。 使用AK/SK认证时，您可以基于签名算法使用AK/SK对请求进行签名，也可以使用专门的签名SDK对请求进行签名。详细的签名方法和SDK使用方法请参见API签名指南。 签名SDK只提供签名功能，与服务提供的SDK不同，使用时请注意。

响应示例 状态码： 400 Bad Request { "error_code" : "common.01000001", "error_msg" : "response status exception, code: 404" } 状态码： 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" }

响应参数 状态码： 204 表3 响应Header参数 参数 参数类型 描述 X-request-id String 请求ID，定位辅助信息。 状态码： 400 表4 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 common_error_code String CBC公共错误码。 solution_msg String 解决方案描述。 状态码： 404 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 common_error_code String CBC公共错误码。 solution_msg String 解决方案描述。 状态码： 500 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 common_error_code String CBC公共错误码。 solution_msg String 解决方案描述。

响应示例 状态码： 200 OK { "policy_version" : 217, "policy_updateTime" : "1657788005000", "policies" : [ { "allow_exceptions" : [ ], "data_mask_policy_items" : [ ], "deny_exceptions" : [ ], "deny_policy_items" : [ { "accesses" : [ { "is_allowed" : true, "type" : "select" } ], "conditions" : [ { "type" : "ip-range", "values" : [ "*.*.*.*" ] } ], "delegate_admin" : false, "groups" : [ "groupD" ], "roles" : [ ], "users" : [ ] } ], "id" : 39, "is_audit_enabled" : true, "is_default_policy" : false, "is_deny_all_else" : false, "is_enabled" : true, "name" : "database_a.test.[**]-table_all_column", "options" : { }, "policy_items" : [ { "accesses" : [ { "is_allowed" : true, "type" : "select" } ], "conditions" : [ ], "delegate_admin" : true, "groups" : [ "groupA" ], "roles" : [ ], "users" : [ ] }, { "accesses" : [ { "is_allowed" : true, "type" : "select" } ], "conditions" : [ ], "delegate_admin" : true, "groups" : [ "groupB" ], "roles" : [ ], "users" : [ ] } ], "policy_labels" : [ ], "policy_priority" : 0, "policy_type" : 0, "resources" : { "database" : { "is_excludes" : false, "is_recursive" : false, "values" : [ "database_a" ] }, "column" : { "is_excludes" : false, "is_recursive" : false, "values" : [ "**" ] }, "table" : { "is_excludes" : false, "is_recursive" : false, "values" : [ "test" ] } }, "row_filter_policy_items" : [ ], "service" : "Hive", "service_type" : "hive", "validity_schedules" : [ ] } ] } 状态码： 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" }

URI GET /v1/{project_id}/instances/{instance_id}/policies/policy 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目编号。获取方法，请参见获取项目ID。 instance_id 是 String LakeFormation实例ID。创建实例时自动生成。例如：2180518f-42b8-4947-b20b-adfc53981a25。 表2 Query参数 参数 是否必选 参数类型 描述 last_known_version 否 Long 最新已知版本。 supports_policy_deltas 否 Boolean 是否支持增量同步策略。默认为false。 is_return_policy_data 否 Boolean 是否返回权限策略数据。默认为true。 catalog_name 否 String catalog名称。只能包含字母、数字和下划线，且长度为1~256个字符。

请求消息头 附加请求头字段，如指定的URI和HTTP方法所要求的字段。例如定义消息体类型的请求头“Content-Type”，请求鉴权信息等。 如下公共消息头需要添加到请求中。 Content-Type：消息体的类型（格式），必选，默认取值为“application/json”，有其他取值时会在具体接口中专门说明。 X-Auth-Token：用户Token，可选，当使用Token方式认证时，必须填充该字段。用户Token也就是调用获取用户Token接口的响应值，该接口是唯一不需要认证的接口。 当前API同时支持使用AK/SK认证，AK/SK认证是使用SDK对请求进行签名，签名过程会自动往请求中添加Authorization（签名认证信息）和X-Sdk-Date（请求发送的时间）请求头。 AK/SK认证的详细说明请参见AK/SK认证。 X-Project-ID：子项目ID，可选，在多项目场景中使用。 X-Domain-ID：账号ID。 对于获取用户Token接口，由于不需要认证，所以只添加“Content-Type”即可，添加消息头后的请求如下所示。 POST https://iam.cn-north-1.myhuaweicloud.com/v3/auth/tokens Content-Type: application/json

请求消息体（可选） 该部分可选。请求消息体通常以结构化格式发出，与请求消息头中Content-type对应，传递除请求消息头之外的内容。若请求消息体中参数支持中文，则中文字符必须为UTF-8编码。 每个接口的请求消息体内容不同，也并不是每个接口都需要有请求消息体（或者说消息体为空），GET、DELETE操作类型的接口就不需要消息体，消息体具体内容需要根据具体接口而定。 对于获取用户Token接口，您可以从接口的请求部分看到所需的请求参数及参数说明。将消息体加入后的请求如下所示，加粗的斜体字段需要根据实际值填写，其中username为用户名，domainname为用户所属的账号名称，********为用户登录密码，xxxxxxxxxx为project的名称，如cn-north-1，您可以从地区和终端节点中获取。 scope参数定义了Token的作用域，下面示例中获取的Token仅能访问project下的资源。您还可以设置Token额作用域为某个账号下所有资源或账号的某个project下的资源，详细定义请参见获取用户Token。 POST https://iam.cn-north-1.myhuaweicloud.com/v3/auth/tokens Content-Type: application/json { "auth": { "identity": { "methods": [ "password" ], "password": { "user": { "name": "username", "password": "********", "domain": { "name": "domainname" } } } }, "scope": { "project": { "id": "xxxxxxxx" } } } } 到这里为止这个请求需要的内容就具备齐全了，您可以使用curl、Postman或直接编写代码等方式发送请求调用API。对于获取用户Token接口，返回的响应消息头中“x-subject-token”就是需要获取的用户Token。有了Token之后，您就可以使用Token认证调用其他API。

请求方法 HTTP请求方法（也称为操作或动词），它告诉服务你正在请求什么类型的操作。 表2 HTTP方法 方法 说明 GET 请求服务器返回指定资源。 PUT 请求服务器更新指定资源。 POST 请求服务器新增资源或执行特殊操作。 DELETE 请求服务器删除指定资源，如删除对象等。 HEAD 请求服务器资源头部。 PATCH 请求服务器更新资源的部分内容。 当资源不存在的时候，PATCH可能会去创建一个新的资源。 在获取用户Token的URI部分，您可以看到其请求方法为“POST”，则其请求为： POST https://iam.cn-north-1.myhuaweicloud.com/v3/auth/tokens

请求URI 请求URI由如下部分组成。 {URI-scheme} :// {Endpoint} / {resource-path} ? {query-string} 尽管请求URI包含在请求消息头中，但大多数语言或框架都要求您从请求消息中单独传递它，所以在此单独强调。 表1 URI中的参数说明 参数 说明 URI-scheme 表示用于传输请求的协议，当前所有API均采用HTTPS协议。 Endpoint 指定承载REST服务端点的服务器域名或IP，不同服务不同区域的Endpoint不同。 您可以从地区和终端节点中获取。例如LakeFormation服务在“华北-北京四”区域的Endpoint为“lakeformation.cn-north-4.myhuaweicloud.com”。 resource-path 资源路径，也即API访问路径。从具体接口的URI模块获取，例如获取用户Token API的resource-path为“/v3/auth/tokens”。 query-string 查询参数，是可选部分，并不是每个API都有查询参数。查询参数前面需要带一个“?”，形式为“参数名=参数取值”，例如“limit=10”，表示查询不超过10条数据。 例如您需要获取 IAM 在“华北-北京一”区域的Token，则需使用“华北-北京一”区域的Endpoint（iam.cn-north-1.myhuaweicloud.com），并在获取用户Token的URI部分找到resource-path（/v3/auth/tokens），拼接起来如下所示。 https://iam.cn-north-1.myhuaweicloud.com/v3/auth/tokens 图1 URI示意图 为查看方便，在每个具体API的URI部分，只给出resource-path部分，并将请求方法写在一起。这是因为URI-scheme都是HTTPS，而Endpoint在同一个区域也相同，所以简洁起见将这两部分省略。

请求示例 POST https://{endpoint} /v1/{project_id}/instances/{instance_id}/catalogs/{catalog_name}/databases/{database_name}/tables/{table_name}/column-statistics/batch-get { "column_names" : [ "column1" ] }

响应示例 状态码： 200 OK [ { "column_name" : "column_name", "column_type" : "string", "data_type" : "int", "binary_statistics_data" : { "maximum_length" : 0, "average_length" : 0, "number_of_null" : 0 }, "long_statistics_data" : { "minimum_value" : 0, "maximum_value" : 0, "number_of_null" : 0, "number_of_distinct_value" : 0, "bit_vector" : "string" }, "decimal_statistics_data" : { "minimum_value" : { "scale" : 0, "unscaled" : "string" }, "maximum_value" : { "scale" : 0, "unscaled" : "string" }, "number_of_null" : 0, "number_of_distinct_value" : 0, "bit_vector" : "string" }, "string_statistics_data" : { "average_length" : 0, "maximum_length" : 0, "number_of_null" : 0, "number_of_distinct_value" : 0, "bit_vector" : "string" }, "double_statistics_data" : { "minimum_value" : 0, "maximum_value" : 0, "number_of_null" : 0, "number_of_distinct_value" : 0, "bit_vector" : "string" }, "date_statistics_data" : { "minimum_value" : "2023-01-09T09:40:45.206Z", "maximum_value" : "2023-01-09T09:40:45.206Z", "number_of_null" : 0, "number_of_distinct_value" : 0, "bit_vector" : "string" }, "boolean_statistics_data" : { "number_of_true" : 0, "number_of_false" : 0, "number_of_null" : 0 } } ] 状态码： 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参数 参数 参数类型 描述 [数组元素] Array of ColumnStatisticsObj objects OK 表5 ColumnStatisticsObj 参数 参数类型 描述 column_name String 列名称。只能包含中文、字母、数字和_-+*(), 特殊字符，且长度为1~767个字符。 column_type String 数据类型，字段类型包括array bigint binary boolean char date decimal double float int interval map set smallint string struct timestamp tinyint union varchar data_type String 统计信息类型：binaryStats、booleanStats、dateStats、decimalStats、doubleStats、longStats、stringStats。 枚举值： binaryStats booleanStats dateStats decimalStats doubleStats longStats stringStats binary_statistics_data BinaryColumnStatisticsData object 字节数组类型统计信息。 long_statistics_data LongColumnStatisticsData object 长整数类型统计信息。 decimal_statistics_data DecimalColumnStatisticsData object 小数类型统计信息。 string_statistics_data StringColumnStatisticsData object 字符串类型统计信息。 double_statistics_data DoubleColumnStatisticsData object 浮点数类型统计信息。 date_statistics_data DateColumnStatisticsData object 日期类型统计信息。 boolean_statistics_data BooleanColumnStatisticsData object 布尔类型统计信息。 表6 BinaryColumnStatisticsData 参数 参数类型 描述 maximum_length Long 列中字节数组的最大值。 average_length Double 列中字节数组的平均长度。 number_of_null Long 列中空值个数。 表7 LongColumnStatisticsData 参数 参数类型 描述 minimum_value Long 列中长整数最小值。 maximum_value Long 列中长整数最大值。 number_of_null Long 列中空值个数。 number_of_distinct_value Long 列中去重后的长整数个数。 bit_vector String 估算唯一值使用的位图。 表8 DecimalColumnStatisticsData 参数 参数类型 描述 minimum_value Decimal object 列中小数最小值。 maximum_value Decimal object 列中小数最大值。 number_of_null Long 列中空值个数。 number_of_distinct_value Long 列中去重后的小数个数。 bit_vector String 估算唯一值使用的位图。 表9 Decimal 参数 参数类型 描述 scale Integer 整数部分。 unscaled String 小数部分。 表10 StringColumnStatisticsData 参数 参数类型 描述 average_length Double 列中字符串平均长度。 maximum_length Long 列中字符串最长长度。 number_of_null Long 列中空值个数。 number_of_distinct_value Long 列中去重后字符串个数。 bit_vector String 估算唯一值使用的位图。 表11 DoubleColumnStatisticsData 参数 参数类型 描述 minimum_value Double 列中浮点数最小值。 maximum_value Double 列中浮点数最大值。 number_of_null Long 列中空值个数。 number_of_distinct_value Long 列中去重后浮点数个数。 bit_vector String 估算唯一值使用的位图。 表12 DateColumnStatisticsData 参数 参数类型 描述 minimum_value String 列中的最小时间戳。 maximum_value String 列中的最大时间戳。 number_of_null Long 列中空值个数。 number_of_distinct_value Long 列中去重后的时间戳个数。 bit_vector String 估算唯一值使用的位图。 表13 BooleanColumnStatisticsData 参数 参数类型 描述 number_of_true Long 列中为真的数量。 number_of_false Long 列中为假的数量。 number_of_null Long 列中为空的数量。 状态码： 400 表14 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 solution_msg String 解决方案描述。 状态码： 404 表15 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 solution_msg String 解决方案描述。 状态码： 500 表16 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 solution_msg String 解决方案描述。

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

响应示例 状态码： 200 系统协议响应体 { "agreement_rules" : [ { "agreement_name" : "agreement AAA", "agreement_display_name" : "AAA", "agreement_version" : "v1", "agreement_url" : "https://AAA" }, { "agreement_name" : "agreement BBB", "agreement_display_name" : "BBB", "agreement_version" : "v1", "agreement_url" : "https://BBB" } ] } 状态码： 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参数 参数 参数类型 描述 agreement_rules Array of AgreementRule objects 系统协议列表。 表5 AgreementRule 参数 参数类型 描述 agreement_name String 协议名称。 agreement_display_name String 协议展示名称。 agreement_version String 协议版本。 agreement_url 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 解决方案描述。