华为云用户手册

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

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 是否查询被删除元数据。

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

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 log String 日志内容。 状态码： 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 日志相关信息 { "log" : "2023-06-23 12:03:23 INFO - starting" } 状态码： 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" }

响应参数 状态码： 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参数并传入该域名。

响应示例 状态码： 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参数并传入该域名。

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

请求示例 POST https://{endpoint}/v1/{project_id}/instances/{instance_id}/roles/{role_name}/revoke-principals [ { "principal_name" : "user1", "principal_source" : "IAM", "principal_type" : "USER" } ]

响应示例 状态码： 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}/roles/{role_name}/revoke-principals 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目编号。获取方法，请参见获取项目ID。 instance_id 是 String LakeFormation实例ID。创建实例时自动生成。例如：2180518f-42b8-4947-b20b-adfc53981a25。 role_name 是 String 角色名称。只能包含字母、数字、下划线、中划线，且长度为1~255个字符。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 Array of strings 租户token。 表3 请求Body参数 参数 是否必选 参数类型 描述 [数组元素] 是 Array of Principal objects 主体列表。最小元素数为1，最大元素数为100。 表4 Principal 参数 是否必选 参数类型 描述 principal_type 是 String 主体类型： USER-用户、 GROUP-组、 ROLE-角色、 SHARE-共享、 OTHER-其它。 枚举值： USER GROUP ROLE SHARE OTHER principal_source 是 String 主体来源： IAM-云用户、 SAML-联邦、 LDAP ld-用户、 LOCAL-本地用户、 AGENTTENANT-委托、 OTHER-其它。 枚举值： IAM SAML LDAP LOCAL AGENTTENANT OTHER principal_name 是 String 主体名称。只能包含中文、字母、数字和_-.特殊字符，且长度为1~49个字符。

响应示例 状态码： 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" : "SUC CES S" } } ] } 状态码： 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：运行中、 SUCCESS：成功、 FAILED：失败、 STOPPED：已停止。 枚举值： CREATED SUBMITTED RUNNING SUCCESS FAILED STOPPED offset 是 Integer 分页查询时的偏移量。默认值为0。最小值为0，最大值为1000。 limit 是 Integer 分页一页显示数。默认值为10。最小值为1，最大值为1000。

响应参数 状态码： 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 上次任务执行时间戳。 status String CREATED：已创建、 SUBMITTED：已提交、 RUNNING：运行中、 SUCCESS：成功、 FAILED：失败、 STOPPED：已停止。 枚举值： CREATED SUBMITTED RUNNING SUCCESS FAILED STOPPED 状态码： 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 [ "admin" ] 状态码： 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}/roles/names 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目编号。获取方法，请参见获取项目ID。 instance_id 是 String LakeFormation实例ID。创建实例时自动生成。例如：2180518f-42b8-4947-b20b-adfc53981a25。

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

响应示例 状态码： 200 OK { "table_metas" : [ { "catalog_name" : "hive", "database_name" : "default", "table_name" : "tbla", "table_type" : "MANAGED_TABLE", "comments" : "" }, { "catalog_name" : "hive", "database_name" : "default", "table_name" : "tblb", "table_type" : "MANAGED_TABLE", "comments" : "" } ], "page_info" : { "current_count" : 2, "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 GET /v1/{project_id}/instances/{instance_id}/catalogs/{catalog_name}/databases/tables 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目编号。获取方法，请参见获取项目ID。 instance_id 是 String LakeFormation实例ID。创建实例时自动生成。例如：2180518f-42b8-4947-b20b-adfc53981a25。 catalog_name 是 String catalog名称。只能包含字母、数字和下划线，且长度为1~256个字符。 表2 Query参数 参数 是否必选 参数类型 描述 database_name_pattern 否 String 数据库名称通配符。只能包含中文、字母、数字和_|*.-特殊字符，且长度为1~128个字符。 table_name_pattern 否 String 表名称通配符。只能包含中文、字母、数字和_|*.-特殊字符，且最大长度为1~256个字符。 table_types 否 Array 查询的表类型：MANAGED_TABLE-内表、EXTERNAL_TABLE-外表、VIRTUAL_VIEW-视图、MATERIALIZED_VIEW-物化视图、DICTIONARY_TABLE字典表。 枚举值： MANAGED_TABLE EXTERNAL_TABLE VIRTUAL_VIEW MATERIALIZED_VIEW DICTIONARY_TABLE limit 否 Integer 查询返回条数。默认值为1000。最小值为1，最大值为2000。 marker 否 String 查询的起始记录ID。最小长度为0，最大长度为256。 reverse_page 否 Boolean 是否查询上一页。默认为false。 external_table_id 否 String 用户端表id，创建时指定，不可修改。

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 table_metas Array of TableMeta objects 表元数据列表。 page_info PagedInfo object 分页返回信息。 表5 TableMeta 参数 参数类型 描述 catalog_name String catalog名称。 database_name String 数据库名称。 table_name String 表名称。 external_table_id String 用户端表id，创建时指定，不可修改。 table_type String 表类型：MANAGED_TABLE-内表、EXTERNAL_TABLE-外表、VIRTUAL_VIEW-视图、MATERIALIZED_VIEW-物化视图、DICTIONARY_TABLE字典表。 枚举值： MANAGED_TABLE EXTERNAL_TABLE VIRTUAL_VIEW MATERIALIZED_VIEW DICTIONARY_TABLE comments String 表描述信息。 表6 PagedInfo 参数 参数类型 描述 current_count Integer 本次返回的对象个数。最小值为0，最大值为2000。 next_marker String 下一页查询地址。当不存在下一页，则值为null，当值为null时，响应Body无该参数。 previous_marker String 上一页查询地址。当不存在上一页，则值为null，当值为null时，响应Body无该参数。 状态码： 400 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 solution_msg String 解决方案描述。 状态码： 404 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 solution_msg String 解决方案描述。 状态码： 500 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 solution_msg String 解决方案描述。

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

响应示例 状态码： 201 Created { "role_name" : "admin", "principal_source" : " LOCAL ", "description" : "role from lakeformation" } 状态码： 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" : "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" }

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

响应示例 状态码： 200 OK { "partitions" : [ { "catalog_name" : "cat97bc31536be24f2cae8ecddf34a6d53a", "database_name" : "dbe062bd53192249d7a0258062ed122683", "table_name" : "tble25e30cecd1a4ab58ab3eba7c70b7dc2", "partition_values" : [ "0e3af7a7552d4aa7b75f271505495590", "936b465a11b64e28aa2d047e92908707" ], "create_time" : "2023-05-30T12:24:30.401+00:00", "last_access_time" : "2023-05-30T12:24:30.000+00:00", "parameters" : { "key1" : "value1", "transient_lastDdlTime" : "120", "classification" : "other" }, "storage_descriptor" : { "columns" : [ { "column_type" : "string", "column_name" : "column_prefix0", "comment" : "b2489a84845b436d8557b2a7ae44082b" }, { "column_type" : "string", "column_name" : "column_prefix1", "comment" : "f6b3ce66332e475f99aaba1c5ba8a080" }, { "column_type" : "string", "column_name" : "column_prefix2", "comment" : "9cd48faa87e04cf0b64416d9491a0131" }, { "column_type" : "string", "column_name" : "column_prefix3", "comment" : "73b0ebce76fe4b5fa97ba29e93f69093" }, { "column_type" : "string", "column_name" : "column_prefix4", "comment" : "9339b5d828314da09900d647a4dcafe2" }, { "column_type" : "string", "column_name" : "column_prefix5", "comment" : "006d9b8151ca4816bc47ba3e53428b7b" }, { "column_type" : "string", "column_name" : "column_prefix6", "comment" : "116e112b2e8c447e942ec14995bcf659" }, { "column_type" : "string", "column_name" : "column_prefix7", "comment" : "d388b4d142834eaab7e55137f4b8089d" }, { "column_type" : "string", "column_name" : "column_prefix8", "comment" : "216f8d15eb044463b2e22a31f3bd40e9" }, { "column_type" : "string", "column_name" : "column_prefix9", "comment" : "7f8565e9381e4070b3faab51badfa035" } ], "location" : "obs://location/test/database/de0eef7ef86a4940a266c03bc7c5a548", "compressed" : false, "input_format" : "0a376351bf9c4966b9258301ba0473f7", "output_format" : "1297b151c9544f368f7c9a1708deb067", "number_of_buckets" : 0, "bucket_columns" : [ ], "sort_columns" : [ ], "serde_info" : { "name" : "b277e0cefeaf4f78aacffbe6bd714ca4", "serialization_library" : "8c348e0841524ce9ba0ab29cf30483cb", "parameters" : { "0804f29205a546efabd6c6934badfa81" : "4e4d5a8d807e4150af0df5cb967810dd" } }, "parameters" : { "27976ea945ed4486a938e6336e7b4923" : "679081deb759451cbc3ccacdcd4e4940", "08f5c45c202b4572b1b3c2255205a2a6" : "7cd4dab5553f4c20b3d08d2a59b8eeca" }, "skewed_info" : { "skewed_column_names" : [ ], "skewed_column_value_location_maps" : { }, "skewed_column_values" : [ ] }, "stored_as_sub_directories" : false } } ], "page_info" : { "current_count" : 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}/catalogs/{catalog_name}/databases/{database_name}/tables/{table_name}/partitions 表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。 partition_values 否 Array 分区的值列表。最小元素数为0，最大元素数为1000。 limit 否 Integer 查询返回条数。默认值为500。最小值为1，最大值为1000。 marker 否 String 查询的起始记录ID。最小长度为0，最大长度为256。 reverse_page 否 Boolean 是否查询上一页。默认为false。