华为云用户手册

请求方法 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在同一个区域也相同，所以简洁起见将这两部分省略。

响应示例 状态码： 200 OK { "catalog_name" : "hive", "database_name" : "lxy", "function_name" : "2", "function_type" : "JAVA", "owner" : "owner", "owner_type" : "USER", "owner_auth_source_type" : "IAM", "class_name" : "333", "create_time" : "2022-12-09T01:51:01.000+00:00", "resource_uris" : [ ] } 状态码： 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}/instances/{instance_id}/catalogs/{catalog_name}/databases/{database_name}/functions/{function_name} { "function_name" : "1456", "function_type" : "JAVA", "owner" : "owner_2", "owner_type" : "USER", "owner_auth_source_type" : "IAM", "class_name" : "34", "create_time" : "2022-12-09T01:50:56.000+00:00", "resource_uris" : [ { "type" : "JAR", "uri" : "obs://lakeformation-test/" }, { "type" : "FILE", "uri" : "obs://lakeformation-test/test3/" } ] }

响应参数 状态码： 200 表5 响应Body参数 参数 参数类型 描述 catalog_name String catalog名称。 catalog_id String catalogID。 database_name String 数据库名称。 database_id String 数据库ID。 function_name String 函数名称。只能包含字母、数字和下划线，且长度为1~256个字符。 function_type String 函数类型,JAVA。 枚举值： JAVA function_id String 函数ID。 owner String 函数所有者。只能包含字母、数字和下划线，且长度为1~256个字符。 owner_type String 所有者类型：USER-用户、GROUP-组、ROLE-角色。 枚举值： USER GROUP ROLE owner_auth_source_type String 所有者授权来源类型：IAM-云用户、SAML-联邦、LDAP-ld用户、LOCAL-本地用户、AGENTTENANT-委托、OTHER-其它。LakeFormation服务分为一期和二期，一期响应Body无该参数。 枚举值： IAM SAML LDAP LOCAL AGENTTENANT OTHER class_name String 函数类名。 create_time String 创建时间格式为yyyy-mm-ddThh:mm:sss。 update_time String 函数元数据最后一次修改时间。 resource_uris Array of FunctionResourceUri objects 函数地址信息。 表6 FunctionResourceUri 参数 参数类型 描述 type String 函数包类型：JAR，FILE，ARCHIVE。 枚举值： JAR FILE ARCHIVE uri String 函数包地址信息。 状态码： 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 解决方案描述。

URI POST /v1/{project_id}/instances/{instance_id}/catalogs/{catalog_name}/databases/{database_name}/functions/{function_name} 表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个字符。 function_name 是 String 函数名称。只能包含字母、数字和下划线，且长度为1~256个字符。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 Array of strings 租户token。 表3 请求Body参数 参数 是否必选 参数类型 描述 function_name 是 String 函数名称。只能包含字母、数字和下划线，且长度为1~256个字符。 function_type 是 String 函数类型，JAVA。 枚举值： JAVA owner 是 String 函数所有者。只能包含字母、数字和下划线，且长度为1~256个字符。 owner_type 是 String 所有者类型：USER-用户、GROUP-组、ROLE-角色。 枚举值： USER GROUP ROLE owner_auth_source_type 否 String 所有者授权来源类型：IAM-云、SAML-联邦、LDAP-ld用户、LOCAL-本地、AGENTTENANT-委托、OTHER-其它。 枚举值： IAM SAML LDAP LOCAL AGENTTENANT OTHER class_name 是 String 函数类名。长度为1~4000个字符。 create_time 否 String 创建时间格式为yyyy-mm-ddThh:mm:sss。 resource_uris 否 Array of FunctionResourceUri objects 函数地址信息。 表4 FunctionResourceUri 参数 是否必选 参数类型 描述 type 是 String 函数包类型：JAR，FILE，ARCHIVE。 枚举值： JAR FILE ARCHIVE uri 是 String 函数包地址信息。

响应示例 状态码： 201 Created { "catalog_name" : "catalog0b5633ba2b904511ad514346f4d23d4b", "database_name" : "db8a9ea595e6a14db1bdb3c3a90bf2554c", "owner" : "owner", "owner_type" : "USER", "description" : "description", "location" : "obs://location/test/db8a9ea595e6a14db1bdb3c3a90bf2554c.db", "parameters" : { "transient_lastDdlTime" : "120", "comment" : "comment message", "classification" : "other" }, "table_location_list" : [ ], "function_location_list" : [ ] } 状态码： 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 POST /v1/{project_id}/instances/{instance_id}/catalogs/{catalog_name}/databases 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目编号。获取方法，请参见获取项目ID。 instance_id 是 String LakeFormation实例ID。创建实例时自动生成。例如：2180518f-42b8-4947-b20b-adfc53981a25。 catalog_name 是 String catalog名称。只能包含字母、数字和下划线，且长度为1~256个字符。

请求示例 POST https://{endpoint} /v1/{project_id}/instances/{instance_id}/catalogs/{catalog_name}/databases { "database_name" : "db8a9ea595e6a14db1bdb3c3a90bf2554c", "owner" : "owner", "owner_type" : "USER", "description" : "description", "location" : "obs://location/test/db8a9ea595e6a14db1bdb3c3a90bf2554c.db", "parameters" : { "transient_lastDdlTime" : "120", "comment" : "comment message", "classification" : "other" } }

响应参数 状态码： 200 表4 响应Header参数 参数 参数类型 描述 X-request-id String 请求ID，定位辅助信息。 表5 响应Body参数 参数 参数类型 描述 page_info PagedInfo object 分页信息。 functions Array of Function objects 函数。 表6 PagedInfo 参数 参数类型 描述 current_count Integer 本次返回的对象个数。最小值为0，最大值为2000。 next_marker String 下一页查询地址。当不存在下一页，则值为null，当值为null时，响应Body无该参数。 previous_marker String 上一页查询地址。当不存在上一页，则值为null，当值为null时，响应Body无该参数。 表7 Function 参数 参数类型 描述 catalog_name String catalog名称。 catalog_id String catalogID。 database_name String 数据库名称。 database_id String 数据库ID。 function_name String 函数名称。只能包含字母、数字和下划线，且长度为1~256个字符。 function_type String 函数类型,JAVA。 枚举值： JAVA function_id String 函数ID。 owner String 函数所有者。只能包含字母、数字和下划线，且长度为1~256个字符。 owner_type String 所有者类型：USER-用户、GROUP-组、ROLE-角色。 枚举值： USER GROUP ROLE owner_auth_source_type String 所有者授权来源类型：IAM-云用户、SAML-联邦、LDAP-ld用户、LOCAL-本地用户、AGENTTENANT-委托、OTHER-其它。LakeFormation服务分为一期和二期，一期响应Body无该参数。 枚举值： IAM SAML LDAP LOCAL AGENTTENANT OTHER class_name String 函数类名。 create_time String 创建时间格式为yyyy-mm-ddThh:mm:sss。 update_time String 函数元数据最后一次修改时间。 resource_uris Array of FunctionResourceUri objects 函数地址信息。 表8 FunctionResourceUri 参数 参数类型 描述 type String 函数包类型：JAR，FILE，ARCHIVE。 枚举值： JAR FILE ARCHIVE uri String 函数包地址信息。 状态码： 400 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 solution_msg String 解决方案描述。 状态码： 404 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 solution_msg String 解决方案描述。 状态码： 500 表11 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 solution_msg String 解决方案描述。

响应示例 状态码： 200 OK { "page_info" : { "current_count" : 2, "next_marker" : null, "previous_marker" : null }, "functions" : [ { "catalog_name" : "catalog_1", "database_name" : "database", "function_name" : "123kk", "function_type" : "JAVA", "owner" : "owner_1", "owner_type" : "USER", "owner_auth_source_type" : "IAM", "class_name" : "lxy", "create_time" : "2022-12-08T08:18:54.000+00:00", "resource_uris" : [ { "type" : "FILE", "uri" : "obs://lakeformation-test/test2/6/" } ] }, { "catalog_name" : "catalog_2", "database_name" : "database", "function_name" : "1456", "function_type" : "JAVA", "owner" : "owner_2", "owner_type" : "USER", "owner_auth_source_type" : "IAM", "class_name" : "34", "create_time" : "2022-12-09T01:50:56.000+00:00", "resource_uris" : [ { "type" : "JAR", "uri" : "obs://lakeformation-test/" }, { "type" : "FILE", "uri" : "obs://lakeformation-test/test3/" } ] } ] } 状态码： 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" } 状态码： 500 Internal Server Error { "error_code" : "common.00000500", "error_msg" : "internal error" }

URI GET /v1/{project_id}/instances/{instance_id}/catalogs/{catalog_name}/functions 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目编号。获取方法，请参见获取项目ID。 instance_id 是 String LakeFormation实例ID。创建实例时自动生成。例如：2180518f-42b8-4947-b20b-adfc53981a25。 catalog_name 是 String catalog名称。只能包含字母、数字和下划线，且长度为1~256个字符。 表2 Query参数 参数 是否必选 参数类型 描述 limit 否 Integer 查询返回条数。默认值为1000。最小值为1，最大值为2000。 marker 否 String 查询的起始记录ID。最小长度为0，最大长度为256。 reverse_page 否 Boolean 是否查询上一页。默认为false。

请求示例 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 表3 响应Header参数 参数 参数类型 描述 X-request-id String 请求ID，定位辅助信息。 表4 响应Body参数 参数 参数类型 描述 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_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=包周期计费。 枚举值： prePaid postPaid 表5 ResourceTag 参数 参数类型 描述 key String 键。 value String 值。 表6 CreateSpec 参数 参数类型 描述 product_id String 商品ID。由系统自动生成，如OFFI8XXXXXXXXXXXXXXXX4。 spec_code String 规格编码。由系统自动生成，例如lakeformation.unit.basic.qps。 stride_num Integer 步数。QPS为每秒最大请求数步长，最小为5，步长为1。 状态码： 400 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 common_error_code String CBC公共错误码。 solution_msg String 解决方案描述。 状态码： 404 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 common_error_code String CBC公共错误码。 solution_msg String 解决方案描述。 状态码： 500 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 common_error_code String CBC公共错误码。 solution_msg String 解决方案描述。

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

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

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

URI POST /v1/{project_id}/instances/{instance_id}/catalogs/{catalog_name}/databases/{database_name}/tables/{table_name}/partitions/batch-drop 表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个字符。

请求示例 POST https://{endpoint} /v1/{project_id}/instances/{instance_id}/catalogs/{catalog_name}/databases/{database_name}/tables/{table_name}/partitions/batch-drop { "if_exist" : true, "delete_data" : true, "partition_values" : [ [ "54fd5f39855e43e29630196af18cfb22", "ae64345374854efc819fac880541465e" ], [ "c085eeb64df04982a4c93d3a33fc8cf6", "e9c380472d974182b973f46443e8dc3b" ], [ "ca39a2137c8548d0a49842802f2dedb8", "c1d9679369494c52933c31ecd5483550" ] ] }

响应示例 状态码： 200 已删除partition列表 [ { "catalog_name" : "catcd6a92bfc2c74a509dc8501b8124505c", "database_name" : "db4cfc99ac3cea421abc157c7bd49f6f16", "table_name" : "tblbb79f3733c0747adbb94981b412fe48f", "partition_values" : [ "48e1f86dc4394a218b832d94411805fe", "5a2ab07a663c49a98cc606e6ffa0b178" ], "create_time" : "2023-05-30T09:06:41.372+00:00", "last_access_time" : "2023-05-30T09:06:41.000+00:00", "parameters" : { "key1" : "value1", "transient_lastDdlTime" : "120", "classification" : "other" }, "storage_descriptor" : { "columns" : [ { "column_type" : "string", "column_name" : "column_prefix0", "comment" : "83e99b4daff04e75b28263bf44495a3c" }, { "column_type" : "string", "column_name" : "column_prefix1", "comment" : "d947669d90884014b60264b2770849ae" }, { "column_type" : "string", "column_name" : "column_prefix2", "comment" : "21edd8e92f2448deb036f8e4682ec694" }, { "column_type" : "string", "column_name" : "column_prefix3", "comment" : "fc25f38e8b694aebb34a2f84ef4a62f7" }, { "column_type" : "string", "column_name" : "column_prefix4", "comment" : "3443079e616d447f8f35da2014754701" }, { "column_type" : "string", "column_name" : "column_prefix5", "comment" : "5f7dda02ac8e4813b3eb4858abb7c520" }, { "column_type" : "string", "column_name" : "column_prefix6", "comment" : "2a6ae2e5bc3f4add99133106f2cd526c" }, { "column_type" : "string", "column_name" : "column_prefix7", "comment" : "84d50424269a41fbb5528b350e9d0b13" }, { "column_type" : "string", "column_name" : "column_prefix8", "comment" : "e3f1d2fa80454554a22e8564ec9c4832" }, { "column_type" : "string", "column_name" : "column_prefix9", "comment" : "f11315794e6d40daa2cb8347c61e5a46" } ], "location" : "obs://location/test/database/b593fc09871e4c9886ed931a3e51f9e5", "compressed" : false, "input_format" : "8c470072d43344a3a3bfabd2c7f9d6ec", "output_format" : "74ee5be43fb548e7b988390df05134fa", "number_of_buckets" : 0, "bucket_columns" : [ ], "sort_columns" : [ ], "serde_info" : { "name" : "9b3ea84748854c2d86a71ae37e246293", "serialization_library" : "e9632ffbbfbe425d8eac91e765e046e1", "parameters" : { "e5ae426044054a5f8e362b9b5729dbab" : "33d8296203f94760b1e4b7db55edce0d" } }, "parameters" : { "7e27b28f439e40bea098dd65bc857334" : "ab893cac08bb4374beb8ff00a02e9a73", "c698760d6de74d0c92eee65bea283215" : "8ba9a058a5cc4ebaac6f43c9771e167a" }, "skewed_info" : { "skewed_column_names" : [ ], "skewed_column_value_location_maps" : { }, "skewed_column_values" : [ ] }, "stored_as_sub_directories" : false } }, { "catalog_name" : "catcd6a92bfc2c74a509dc8501b8124505c", "database_name" : "db4cfc99ac3cea421abc157c7bd49f6f16", "table_name" : "tblbb79f3733c0747adbb94981b412fe48f", "partition_values" : [ "e4af64d55308403a9abf1999afbbe2be", "079f4cd2ee5b4de6922ef8f0c92c82ae" ], "create_time" : "2023-05-30T09:06:41.372+00:00", "last_access_time" : "2023-05-30T09:06:41.000+00:00", "parameters" : { "key1" : "value1", "transient_lastDdlTime" : "120", "classification" : "other" }, "storage_descriptor" : { "columns" : [ { "column_type" : "string", "column_name" : "column_prefix0", "comment" : "b40e5a6b6b3c4a538c4b7daa8bc49300" }, { "column_type" : "string", "column_name" : "column_prefix1", "comment" : "d7de59704feb4218ad6c3899f16f72e3" }, { "column_type" : "string", "column_name" : "column_prefix2", "comment" : "215d3961dd0c4858b884e50157da1d4b" }, { "column_type" : "string", "column_name" : "column_prefix3", "comment" : "b8e4888680ca449492be2344a81aba1d" }, { "column_type" : "string", "column_name" : "column_prefix4", "comment" : "1ac15b288c354834830062e48b04e3c8" }, { "column_type" : "string", "column_name" : "column_prefix5", "comment" : "5e65189b3f28434c8b96a56fb19b3005" }, { "column_type" : "string", "column_name" : "column_prefix6", "comment" : "7944cf9158514a96905712d686bc7c18" }, { "column_type" : "string", "column_name" : "column_prefix7", "comment" : "c6b9396476e541e9ab34a8eb5fda9953" }, { "column_type" : "string", "column_name" : "column_prefix8", "comment" : "978fe9b8a1d1437391e83553ae361bfc" }, { "column_type" : "string", "column_name" : "column_prefix9", "comment" : "4f7ed315c7c44c5683500104464f4776" } ], "location" : "obs://location/test/database/3971910eb87a41ee9d7096d538232c33", "compressed" : false, "input_format" : "620befc9b9a447fb95ecfb0d33fb636c", "output_format" : "fc943b36eaec4d1da525734e56374d32", "number_of_buckets" : 0, "bucket_columns" : [ ], "sort_columns" : [ ], "serde_info" : { "name" : "9286f98baef44841883166345635faed", "serialization_library" : "ac9cdbe5004d468798bc57b4ed10f602", "parameters" : { "cef1b8d74bdd43459793b00b4deff6ae" : "e66acd0f816047ae9e00d01a4045c340" } }, "parameters" : { "0546e622cf2042598ed4f31e0b3b3276" : "be46b5accfdc41ba93f50fbe16b782c2", "a5b63ea213ab48be8c3c361fe93f75d2" : "c0f1215c944040cfad2e69fbe7cb4b0b" }, "skewed_info" : { "skewed_column_names" : [ ], "skewed_column_value_location_maps" : { }, "skewed_column_values" : [ ] }, "stored_as_sub_directories" : false } }, { "catalog_name" : "catcd6a92bfc2c74a509dc8501b8124505c", "database_name" : "db4cfc99ac3cea421abc157c7bd49f6f16", "table_name" : "tblbb79f3733c0747adbb94981b412fe48f", "partition_values" : [ "e5ade865888a4bb0a22b71505dd0989d", "788dfdb29db342f488a6155a55875f5b" ], "create_time" : "2023-05-30T09:06:41.372+00:00", "last_access_time" : "2023-05-30T09:06:41.000+00:00", "parameters" : { "key1" : "value1", "transient_lastDdlTime" : "120", "classification" : "other" }, "storage_descriptor" : { "columns" : [ { "column_type" : "string", "column_name" : "column_prefix0", "comment" : "a4398b0a8f404ad1a2d8d350efdcd812" }, { "column_type" : "string", "column_name" : "column_prefix1", "comment" : "c2d17faf55de41ddb9f098a684dd8473" }, { "column_type" : "string", "column_name" : "column_prefix2", "comment" : "5f2de67835ff49aba7b661712ef059a6" }, { "column_type" : "string", "column_name" : "column_prefix3", "comment" : "26ce9cc09f3545df80181cbed87d4da2" }, { "column_type" : "string", "column_name" : "column_prefix4", "comment" : "f5b65b8db66349b3a1f8eace0ea33334" }, { "column_type" : "string", "column_name" : "column_prefix5", "comment" : "3f9b100dbc2f45d58d6fbcfa63e0d806" }, { "column_type" : "string", "column_name" : "column_prefix6", "comment" : "22c5f279e9d04cada8bdee6ddbd38af7" }, { "column_type" : "string", "column_name" : "column_prefix7", "comment" : "7ac1468020094057bf2e1e41f3e035b8" }, { "column_type" : "string", "column_name" : "column_prefix8", "comment" : "8c8178e2fe694ace80e78d5c985f7165" }, { "column_type" : "string", "column_name" : "column_prefix9", "comment" : "3f8d23d533fe44b295067de73a8f1b68" } ], "location" : "obs://location/test/database/8c351a1aca6b426a936be4453da30c35", "compressed" : false, "input_format" : "9fb9f9d02b3044febe447a1ad4ca5297", "output_format" : "ba8acae75da24d858ebe99f4ef2fce84", "number_of_buckets" : 0, "bucket_columns" : [ ], "sort_columns" : [ ], "serde_info" : { "name" : "6e4b2479321842d191f1b540b348a4f1", "serialization_library" : "22209422df114f589b4ec28d19d86e52", "parameters" : { "a5c4f39d83d047748dcd1218764c7a1c" : "9e2256acd089474ba469d329d35ace13" } }, "parameters" : { "997ebfa4c6e343789a92d20f7961c865" : "2a1899624e084fb4b26595469cd23f32", "86887611dd7345c88f3de16538cb3587" : "ac4aab973d50429d9803cb418c9d44e1" }, "skewed_info" : { "skewed_column_names" : [ ], "skewed_column_value_location_maps" : { }, "skewed_column_values" : [ ] }, "stored_as_sub_directories" : false } } ] 状态码： 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}/instances/{instance_id}/catalogs { "catalog_name" : "hive", "description" : "Default catalog, for Hive", "location" : "obs://lakeformation/test", "database_location_list" : null, "owner" : "admin", "owner_type" : "USER", "owner_source" : "IAM" }

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

响应参数 状态码： 201 表4 响应Body参数 参数 参数类型 描述 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 表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 POST /v1/{project_id}/instances/{instance_id}/catalogs 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目编号。获取方法，请参见获取项目ID。 instance_id 是 String LakeFormation实例ID。创建实例时自动生成。例如：2180518f-42b8-4947-b20b-adfc53981a25。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 Array of strings 租户token。 表3 请求Body参数 参数 是否必选 参数类型 描述 catalog_name 是 String catalog名称。只能包含字母、数字和下划线，且长度为1~256个字符。 description 否 String 描述信息。最大长度为4000个字符。 location 否 String 路径地址。例如obs://location/uri/。 database_location_list 否 Array of strings 数据库路径列表。最小条目数为0，最大条目数为1000。 branch_name 否 String 分支名称。只能包含字母、数字和下划线，且长度为1~32个字符。默认值为main。 owner 否 String catalog所有者。只能包含字母、数字和下划线，且最大长度为128个字符。 owner_type 否 String 所有者类型：USER-用户、GROUP-组、ROLE-角色。 枚举值： USER ROLE GROUP owner_source 否 String 所有者来源：IAM-云用户、SAML-联邦、LDAP-ld用户、LOCAL-本地用户、AGENTTENANT-委托、OTHER-其它。 枚举值： IAM SAML LDAP LOCAL AGENTTENANT OTHER type 否 String catalog类型，可选值为DEFAULT（代表默认的元数据类型）、CLICKHOUSE（代表CH类型），不设置时默认为DEFAULT。 创建时指定，不可修改。 枚举值： DEFAULT CLICKHOUSE