华为云用户手册

响应参数 状态码： 200 表4 响应Header参数 参数 参数类型 描述 X-request-id String 请求ID，定位辅助信息。 表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,remoteUDF。 枚举值： JAVA remoteUDF 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 函数地址信息。 version_id String 版本ID 表6 FunctionResourceUri 参数 参数类型 描述 type String 函数包类型：JAR，FILE，ARCHIVE，URI。 枚举值： JAR FILE ARCHIVE URI 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 GET /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 Query参数 参数 是否必选 参数类型 描述 version_id 否 String 版本ID，默认为最新版本

响应示例 状态码： 200 OK [ { "catalog_name" : "hive", "database_name" : "dba", "table_name" : "aa", "create_time" : "2022-11-23T02:34:23.000+00:00", "last_access_time" : "2022-12-31T23:59:59.000+00:00", "update_time" : null, "last_analyzed_time" : null, "owner" : "owner", "owner_type" : "USER", "parameters" : { "transient_lastDdlTime" : "1669170863", "classification" : "avro" }, "partition_keys" : [ ], "retention" : 0, "storage_descriptor" : { "columns" : [ { "column_type" : "int", "column_name" : "a", "comment" : "a" } ], "location" : "obs://lakeformation-test/test/aa", "compressed" : true, "input_format" : "org.apache.hadoop.hive.ql.io.avro.AvroContainerInputFormat", "output_format" : "org.apache.hadoop.hive.ql.io.avro.AvroContainerOutputFormat", "number_of_buckets" : 0, "bucket_columns" : [ ], "sort_columns" : [ ], "serde_info" : { "name" : "name", "serialization_library" : "org.apache.hadoop.hive.serde2.avro.AvroSerDe", "parameters" : { "serialization.format" : "1" } }, "parameters" : { }, "skewed_info" : { "skewed_column_names" : [ ], "skewed_column_value_location_maps" : { }, "skewed_column_values" : [ ] }, "stored_as_sub_directories" : false }, "table_type" : "MANAGED_TABLE", "comments" : "", "view_expanded_text" : "", "view_original_text" : ""} ] 状态码： 201 Created { "tables" : [ { "catalog_name" : "hive", "database_name" : "dba", "table_name" : "www", "create_time" : "2022-11-19T03:10:14.000+00:00", "last_access_time" : "2022-12-31T23:59:59.000+00:00", "update_time" : null, "last_analyzed_time" : null, "owner" : "lakeformation", "owner_type" : "USER", "parameters" : { "ww" : "ww", "transient_lastDdlTime" : "1668827414", "classification" : "avro", "www" : "ww", "wwww" : "ww" }, "partition_keys" : [ ], "retention" : 0, "storage_descriptor" : { "columns" : [ { "column_type" : "tinyint", "column_name" : "ww", "comment" : null } ], "location" : "obs://lakeformation/test", "compressed" : true, "input_format" : "org.apache.hadoop.hive.ql.io.avro.AvroContainerInputFormat", "output_format" : "org.apache.hadoop.hive.ql.io.avro.AvroContainerOutputFormat", "number_of_buckets" : 0, "bucket_columns" : [ ], "sort_columns" : [ ], "serde_info" : { "name" : "name", "serialization_library" : "org.apache.hadoop.hive.serde2.avro.AvroSerDe", "parameters" : { "serialization.format" : "1" } }, "parameters" : { }, "skewed_info" : { "skewed_column_names" : [ ], "skewed_column_value_location_maps" : { }, "skewed_column_values" : [ ] }, "stored_as_sub_directories" : false }, "table_type" : "MANAGED_TABLE", "comments" : "", "view_expanded_text" : "", "view_original_text" : "" } ], "page_info" : { "current_count" : 1, "next_marker" : null, "previous_marker" : null }} 状态码： 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/{database_name}/tables/list-by-names 表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个字符。

URI POST /v1/{project_id}/instances/{instance_id}/users/{user_name}/revoke-roles 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目编号。获取方法，请参见获取项目ID。 instance_id 是 String LakeFormation实例ID。创建实例时自动生成。例如：2180518f-42b8-4947-b20b-adfc53981a25。 user_name 是 String 用户名。只能包含字母、数字、下划线和中划线，且长度为1~256个字符。 表2 Query参数 参数 是否必选 参数类型 描述 user_source 否 String 用户来源。只能为IAM或SAML或LDAP或LOCAL或AGENTTENANT或OTHER。默认为IAM。

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

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

请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 Array of strings 租户token。 表4 请求Body参数 参数 是否必选 参数类型 描述 [数组元素] 是 Array of RoleInfoInput objects 角色列表。 表5 RoleInfoInput 参数 是否必选 参数类型 描述 role_name 是 String 角色名称。只能包含字母、数字、下划线、中划线，且长度为1~255个字符。 principal_source 是 String 主体来源： IAM-云用户、 SAML-联邦、 LDAP ld-用户、 LOCAL-本地用户、 AGENTTENANT-委托、 OTHER-其它。 枚举值： IAM SAML LDAP LOCAL AGENTTENANT OTHER

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

响应示例 状态码： 200 用户的配额信息 { "quotas" : { "resources" : [ { "type" : "instanceNum", "min" : 0, "max" : 1000, "quota" : 1000, "used" : 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 表4 响应Header参数 参数 参数类型 描述 X-request-id String 请求ID，定位辅助信息。 表5 响应Body参数 参数 参数类型 描述 tags Array of ResourceTagParam objects 标签。 表6 ResourceTagParam 参数 参数类型 描述 key String 资源标签的键。 values Array of strings 资源标签的值列表。 状态码： 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 查询资源标签集合 { "tags" : [ { "key" : "key1", "values" : [ "value1" ] }, { "key" : "key2", "values" : [ "value2" ] } ]} 状态码： 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}/lf-jobs 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目编号。获取方法，请参见获取项目ID。 instance_id 是 String LakeFormation实例ID。创建实例时自动生成。例如：2180518f-42b8-4947-b20b-adfc53981a25。 表2 Query参数 参数 是否必选 参数类型 描述 name_pattern 否 String 任务名通配符，用于任务名的匹配。 type 是 String METADATA_MIGRATION：元数据迁移、 PERMISSION_MIGRATION：数据权限迁移、 METADATA_DISCOVERY：元数据发现。 枚举值： METADATA_MIGRATION PERMISSION_MIGRATION METADATA_DISCOVERY status 否 String CREATED：已创建、 SUBMITTED：已提交、 RUNNING：运行中、 SUC CES S：成功、 FAILED：失败、 STOPPED：已停止、 PARTIAL_SUCCESS：部分成功。 枚举值： CREATED SUBMITTED RUNNING SUCCESS FAILED STOPPED PARTIAL_SUCCESS offset 是 Integer 分页查询时的偏移量。默认值为0。最小值为0，最大值为1000。 limit 是 Integer 分页一页显示数。默认值为10。最小值为1，最大值为1000。

响应示例 状态码： 200 查询任务列表成功 { "total" : 1, "jobs" : [ { "id" : "03141229-84cd-4b1b-9733-dd124320c125", "name" : "testjob", "type" : "METADATA_MIGRATION", "create_time" : "2023-05-27T10:04:35.743Z", "start_time" : "2023-05-27T10:04:35.743Z", "status" : { "status" : "SUCCESS" } } ]} 状态码： 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参数 参数 参数类型 描述 total Integer 任务总数。 jobs Array of JobInfo objects 任务列表。 表5 JobInfo 参数 参数类型 描述 id String 任务Id。 name String 任务名称。 type String 任务类型：METADATA_MIGRATION：元数据迁移任务、PERMISSION_MIGRATION：数据权限迁移任务、METADATA_DISCOVERY：元数据发现任务。 枚举值： METADATA_MIGRATION PERMISSION_MIGRATION METADATA_DISCOVERY create_time String 任务创建时间戳。 start_time String 上次任务执行时间戳。 end_time String 上次任务结束时间戳。 status String CREATED：已创建、 SUBMITTED：已提交、 RUNNING：运行中、 SUCCESS：成功、 FAILED：失败、 STOPPED：已停止、 FROZEN_RELEASABLE：冻结可恢复、 FROZEN_UNRELEASABLE：冻结不可恢复、 PARTIAL_SUCCESS：部分成功。 枚举值： CREATED SUBMITTED RUNNING SUCCESS FAILED STOPPED FROZEN_RELEASABLE FROZEN_UNRELEASABLE PARTIAL_SUCCESS execute_time Long 任务执行时长，单位是秒。 log_simple_info 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 解决方案描述。

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

响应参数 状态码： 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,remoteUDF。 枚举值： JAVA remoteUDF 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 函数地址信息。 version_id String 版本ID 表8 FunctionResourceUri 参数 参数类型 描述 type String 函数包类型：JAR，FILE，ARCHIVE，URI。 枚举值： JAR FILE ARCHIVE URI 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 解决方案描述。

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 是否倒序查询。

响应示例 状态码： 200 OK { "page_info" : { "current_count" : 1, "next_marker" : "000000001225efff0000000000000001" }, "policies" : [ { "allow_exceptions" : [ ], "data_mask_policy_items" : [ ], "deny_exceptions" : [ ], "deny_policy_items" : [ ], "id" : 61, "is_audit_enabled" : true, "is_default_policy" : false, "is_deny_all_else" : false, "is_enabled" : true, "name" : "test_database_name-database", "options" : { }, "policy_items" : [ { "accesses" : [ { "is_allowed" : true, "type" : "read" }, { "is_allowed" : true, "type" : "index" }, { "is_allowed" : true, "type" : "select" }, { "is_allowed" : true, "type" : "drop" }, { "is_allowed" : true, "type" : "alter" }, { "is_allowed" : true, "type" : "all" } ], "conditions" : [ { "type" : "ip-range", "values" : [ "127.0.0.1" ] } ], "delegate_admin" : true, "groups" : [ "testGroupName1" ], "roles" : [ ], "users" : [ ] }, { "accesses" : [ { "is_allowed" : true, "type" : "alter" } ], "conditions" : [ ], "delegate_admin" : false, "groups" : [ "testGroupName2" ], "roles" : [ ], "users" : [ ] } ], "policy_labels" : [ ], "policy_priority" : 0, "policy_type" : 0, "resources" : { "database" : { "is_excludes" : false, "is_recursive" : false, "values" : [ "test_database_name" ] } }, "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 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目编号。获取方法，请参见获取项目ID。 instance_id 是 String LakeFormation实例ID。创建实例时自动生成。例如：2180518f-42b8-4947-b20b-adfc53981a25。 表2 Query参数 参数 是否必选 参数类型 描述 limit 否 Integer 查询返回条数。默认值为5000。最小值为1，最大值为10000。 marker 否 String 查询的起始记录ID。最小长度为0，最大长度为1024。 reverse_page 否 Boolean 是否倒序查询。 catalog_name 否 String catalog名称。只能包含字母、数字和下划线，且长度为1~256个字符。

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 access String AK。Access Key，是用来标识用户身份的访问密钥。 secret String SK。Secret Key，用来对访问密钥进行加密签名，以验证身份。 security_token String security_token是将所获的AK、SK等信息进行加密后的字符串。 状态码： 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}/credential 表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参数 参数 是否必选 参数类型 描述 user_names 否 Array of strings IAM用户。 groups 否 Array of strings 用户组。 roles 否 Array of strings 角色。

响应示例 状态码： 200 OK { "access" : "ABC***123", "secret" : "ABC***123", "security_token" : "abc***000"} 状态码： 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 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"}

URI GET /v1/{project_id}/instances/{instance_id}/catalogs/{catalog_name}/databases/{database_name}/tables/names 表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个字符。 表2 Query参数 参数 是否必选 参数类型 描述 table_pattern 否 String 表名称通配符。只能包含中文、字母、数字和_-|*.特殊字符，且长度为1到256个字符。 table_type 否 String 查询的表类型。只能包含MANAGED_TABLE、EXTERNAL_TABLE、VIRTUAL_VIEW、MATERIALIZED_VIEW、DICTIONARY_TABLE。

响应示例 状态码： 200 OK { "partition_name_list" : [ "partition1" ], "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 表4 响应Body参数 参数 参数类型 描述 partition_name_list Array of strings 分区名称列表。 page_info PagedInfo object 分页信息。 表5 PagedInfo 参数 参数类型 描述 current_count Integer 本次返回的对象个数。最小值为0，最大值为2000。 next_marker String 下一页查询地址。当不存在下一页，则值为null，当值为null时，响应Body无该参数。 previous_marker String 上一页查询地址。当不存在上一页，则值为null，当值为null时，响应Body无该参数。 状态码： 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 解决方案描述。

URI GET /v1/{project_id}/instances/{instance_id}/catalogs/{catalog_name}/databases/{database_name}/tables/{table_name}/partitions/partition-names 表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个字符。 表2 Query参数 参数 是否必选 参数类型 描述 filter 否 String 过滤条件表达式。最小长度为0，最大长度为256。 limit 否 Integer 查询返回条数。默认值为1000。最小值为1，最大值为2000。 marker 否 String 查询的起始记录ID。最小长度为0，最大长度为256。 reverse_page 否 Boolean 是否倒序查询。