华为云用户手册

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

响应参数 状态码：202 表4 响应Header参数 参数 参数类型 描述 X-request-id String 请求ID，定位辅助信息。 状态码：400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 common_error_code String CBC公共错误码。 solution_msg String 解决方案描述。 状态码：401 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 common_error_code String CBC公共错误码。 solution_msg String 解决方案描述。 状态码：403 表7 响应Body参数 参数 参数类型 描述 error Error object 错误信息。 error_code String 错误码。 error_msg String 错误描述。 title String 标题。 表8 Error 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 title String 标题。 message String 错误信息。 code String 状态码。 状态码：404 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 common_error_code String CBC公共错误码。 solution_msg String 解决方案描述。 状态码：408 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 common_error_code String CBC公共错误码。 solution_msg String 解决方案描述。 状态码：500 表11 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 common_error_code String CBC公共错误码。 solution_msg String 解决方案描述。

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

URI DELETE /v1/{project_id}/instances/{instance_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目编号。获取方法，请参见获取项目ID。 instance_id 是 String LakeFormation实例ID。创建实例时自动生成。例如：2180518f-42b8-4947-b20b-adfc53981a25。 表2 Query参数 参数 是否必选 参数类型 描述 to_recycle_bin 是 Boolean 是否放入回收站。默认为false。

API概览 表1 API概览 类型 子类型 说明 Console 实例管理 实例管理接口，包括LakeFormation实例的创建、删除、编辑、查询等接口。 通过这些接口，您可以创建实例、获取已创建实例的信息等。 任务管理 任务管理接口，包括创建任务、列举任务信息等接口。 通过这些可口，您可以创建并管理任务。 服务授权管理 协议授权管理接口，包括系统协议查询、已授权协议查询、协议授权等接口。 用户开通使用LakeFormation服务前，需要提前了解并接受相关的协议与授权。 OBS管理 OBS桶管理接口，包括OBS桶、对象等查询接口。 通过这些接口，您可以获取用于设置元数据的存储路径OBS相关信息。 接入管理 服务接入管理接口，包括获取接入信息，申请接入等接口。 开通服务并创建实例以后，LakeFormation即可对外提供元数据管理相关能力，但周边服务需要通过该接口完成对接后，才能调用元数据管理相关接口，从而使用LakeFormation提供的能力。 规格管理 规格管理接口，包括查询规格列表等接口。 配额管理服务 配额管理接口，包括查询用户的配额信息等接口。 标签管理服务 标签管理接口，包括查询资源标签集合、批量更新标签等接口。 委托管理 委托管理接口，包括创建、查询、删除委托等接口。 LakeCat 函数管理 函数管理接口，包括创建、删除函数等接口。 通过这些接口，您可以创建函数、获取已创建函数的信息等。 目录管理 目录管理接口，包括创建、删除目录等接口。 通过这些接口，您可以创建目录、删除目录等。 数据库管理 数据库管理接口，包括创建、删除数据库等接口。 通过这些接口，您可以创建数据库、删除数据库等。 数据表管理 数据表管理接口，包括创建、删除数据表等接口。 通过这些接口，您可以创建数据表、删除数据表等。 数据表统计 数据表统计接口，包括获取数据表的列统计信息、删除指定列统计信息等接口。 通过这些接口，您可以获取数据表的列统计信息、删除指定列统计信息等。 分区管理 分区管理接口，包括创建、删除分区的等接口。 通过这些接口，您可以创建分区、删除分区等。 分区统计信息 分区统计信息接口，包括获取分区列统计信息、删除分区列统计信息等接口。 通过这些接口，您可以获取分区列统计信息、删除分区列统计信息等。 授权管理 授权管理接口，包括查询授权策略、批量授权等接口。 通过这些接口，您可以查询授权策略、批量授权等。 用户组管理 用户组管理接口，包括获取租户的用户组等接口。 通过这些接口，您可以获取租户的用户组等。 元数据统计 元数据统计接口，包括元数据数量统计等接口。 角色管理 角色管理接口，包括创建 、获取、修改、删除角色等接口。 凭证管理 凭证管理接口，包括获取临时密钥和securityToken等接口。 配置管理 配置管理接口，包括获取所有用户可见的租户面配置等接口。 User 用户管理接口，包括获取用户列表、将多个角色授予用户、将一个或者多个角色从用户移除、更新用户中的角色、查询用户的角色列表等接口。

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

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 Array of strings 租户token。 表3 请求Body参数 参数 是否必选 参数类型 描述 [数组元素] 是 Array of Principal objects 主体信息。 表4 Principal 参数 是否必选 参数类型 描述 principal_type 是 String 主体类型： USER-用户、 GROUP-组、 ROLE-角色、 SHARE-共享、 OTHER-其它。 principal_source 是 String 主体来源： IAM-云用户、 SAML-联邦、 LDAP ld-用户、 LOCAL-本地用户、 AGENTTENANT-委托、 OTHER-其它。 principal_name 是 String 主体名称。只能包含中文、字母、数字和_-.特殊字符，且长度为1~49个字符。principal_name支持中划线'-'字符，但是对Principal进行授权时不支持'-'字符，可通过将有中划线的用户绑定到相关角色进行授权。

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

响应参数 状态码：200 表5 响应Body参数 参数 参数类型 描述 [数组元素] Array of Principal objects 主体信息。 表6 Principal 参数 参数类型 描述 principal_type String 主体类型： USER-用户、 GROUP-组、 ROLE-角色、 SHARE-共享、 OTHER-其它。 principal_source String 主体来源： IAM-云用户、 SAML-联邦、 LDAP ld-用户、 LOCAL-本地用户、 AGENTTENANT-委托、 OTHER-其它。 principal_name String 主体名称。只能包含中文、字母、数字和_-.特殊字符，且长度为1~49个字符。principal_name支持中划线'-'字符，但是对Principal进行授权时不支持'-'字符，可通过将有中划线的用户绑定到相关角色进行授权。 状态码：400 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 solution_msg String 解决方案描述。 状态码：401 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 solution_msg String 解决方案描述。 状态码：403 表9 响应Body参数 参数 参数类型 描述 error Error object 错误信息。 error_code String 错误码。 error_msg String 错误描述。 title String 标题。 表10 Error 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 title String 标题。 message String 错误信息。 code String 状态码。 状态码：404 表11 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 solution_msg String 解决方案描述。 状态码：408 表12 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 solution_msg String 解决方案描述。 状态码：500 表13 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 solution_msg String 解决方案描述。

URI PUT /v1/{project_id}/instances/{instance_id}/roles/{role_name}/update-principals 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目编号。获取方法，请参见获取项目ID。 instance_id 是 String LakeFormation实例ID。创建实例时自动生成。例如：2180518f-42b8-4947-b20b-adfc53981a25。 role_name 是 String 角色名称。只能包含字母、数字、下划线，且长度为1到49个字符。

URI PUT /v1/{project_id}/instances/{instance_id}/roles/{role_name} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目编号。获取方法，请参见获取项目ID。 instance_id 是 String LakeFormation实例ID。创建实例时自动生成。例如：2180518f-42b8-4947-b20b-adfc53981a25。 role_name 是 String 角色名称。只能包含字母、数字、下划线，且长度为1到49个字符。

响应示例 状态码：200 OK { "role_name" : "admin", "description" : "string", "principal_source" : "LOCAL" } 状态码：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 规格列表 { "total" : 1, "spec_codes" : [ { "spec_code" : "hws.resource.type.lakeformation.qps", "resource_type" : "hws.resource.type.lakeformation.metadata", "stride" : 2000, "unit" : "qps", "min_stride_num" : 1, "max_stride_num" : 100, "usage_measure_id" : 6, "usage_factor" : "Duration", "usage_value" : 1, "free_usage_value" : 1, "stride_num_whitelist" : [ 1, 2 ] } ] } 状态码：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 响应Body参数 参数 参数类型 描述 total Integer 总数。 spec_codes Array of Spec objects 规格编码列表。 表4 Spec 参数 参数类型 描述 spec_code String 规格编码。lakeformation.unit.basic.qps：每秒查询率（QPS）产品。 resource_type String 资源编码。 stride Integer 步长。 unit String 单位。 min_stride_num Integer 最小步数。 max_stride_num Integer 最大步数。 usage_measure_id Integer 使用量单位标识。 usage_factor String 使用量因子。 usage_value Integer 使用量，包含免费额度和单位额度，例如api调用次数，单位是次，前100万次调用免费，计费标准是5元每100万次，这里返回200万，元数据个数，单位是万个，前100万个免费，计费标准是5元每10万个，这里返回110。 free_usage_value Integer 免费使用额度，例如api调用次数，单位是次，前100万次调用免费，这里返回100万，元数据个数，单位是万个，前100万个免费，这里返回100。 stride_num_whitelist Array of integers 步数白名单，返回时，步数必须是白名单中的值。 状态码：204 表5 响应Header参数 参数 参数类型 描述 X-request-id String 请求ID，定位辅助信息。 状态码：400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 common_error_code String CBC公共错误码。 solution_msg String 解决方案描述。 状态码：401 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 common_error_code String CBC公共错误码。 solution_msg String 解决方案描述。 状态码：403 表8 响应Body参数 参数 参数类型 描述 error Error object 错误信息。 error_code String 错误码。 error_msg String 错误描述。 title String 标题。 表9 Error 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 title String 标题。 message String 错误信息。 code String 状态码。 状态码：404 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 common_error_code String CBC公共错误码。 solution_msg String 解决方案描述。 状态码：408 表11 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 common_error_code String CBC公共错误码。 solution_msg String 解决方案描述。 状态码：500 表12 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 common_error_code String CBC公共错误码。 solution_msg String 解决方案描述。

URI GET /v1/{project_id}/specs 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目编号。获取方法，请参见获取项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 spec_code 否 String 规格编码。由系统自动生成，例如lakeformation.unit.basic.qps。 offset 否 Integer 偏移量。取值在0-100之间，默认值为0。 limit 否 Integer 单次查询个数。取值在1-100之间，默认值为10。

URI GET /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个字符。 表2 Query参数 参数 是否必选 参数类型 描述 database_name_pattern 否 String 数据库名称通配符。只能包含中文、字母、数字和_|*.-特殊字符，且长度为1~128个字符。 limit 否 Integer 查询返回条数。默认值为1000。最小值为0，最大值为1000。 marker 否 String 查询的起始记录ID。最小长度为0，最大长度为256。 reverse_page 否 Boolean 是否倒序查询。 external_database_id 否 String 用户端数据库id，创建时指定，不可修改。 deleted 否 Boolean 是否查询被删除元数据。

响应示例 状态码：200 OK { "databases" : [ { "catalog_name" : "hive", "database_name" : "policy_test", "owner" : "lakeformation", "owner_type" : "USER", "owner_auth_source_type" : "IAM", "description" : "", "location" : "obs://lakeformation/test", "parameters" : { }, "table_location_list" : null, "function_location_list" : null } ], "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 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 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" }

响应示例 状态码：200 OK { "principals" : [ { "principal_type" : "USER", "principal_source" : "IAM", "principal_name" : "user1" } ], "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参数 参数 参数类型 描述 principals Array of Principal objects 主体列表。 page_info PagedInfo object 分页信息。 表5 Principal 参数 参数类型 描述 principal_type String 主体类型： USER-用户、 GROUP-组、 ROLE-角色、 SHARE-共享、 OTHER-其它。 principal_source String 主体来源： IAM-云用户、 SAML-联邦、 LDAP ld-用户、 LOCAL-本地用户、 AGENTTENANT-委托、 OTHER-其它。 principal_name String 主体名称。只能包含中文、字母、数字和_-.特殊字符，且长度为1~49个字符。principal_name支持中划线'-'字符，但是对Principal进行授权时不支持'-'字符，可通过将有中划线的用户绑定到相关角色进行授权。 表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 解决方案描述。 状态码：401 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 solution_msg String 解决方案描述。 状态码：403 表9 响应Body参数 参数 参数类型 描述 error Error object 错误信息。 error_code String 错误码。 error_msg String 错误描述。 title String 标题。 表10 Error 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 title String 标题。 message String 错误信息。 code String 状态码。 状态码：404 表11 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 solution_msg String 解决方案描述。 状态码：408 表12 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 solution_msg String 解决方案描述。 状态码：500 表13 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 solution_msg String 解决方案描述。

URI GET /v1/{project_id}/instances/{instance_id}/roles/{role_name}/principals 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目编号。获取方法，请参见获取项目ID。 instance_id 是 String LakeFormation实例ID。创建实例时自动生成。例如：2180518f-42b8-4947-b20b-adfc53981a25。 role_name 是 String 角色名称。只能包含字母、数字、下划线，且长度为1到49个字符。 表2 Query参数 参数 是否必选 参数类型 描述 principal_pattern 否 String 模糊匹配主体名称。只能包含中文、字母、数字和_|*.-特殊字符，且长度为1~49个字符。 limit 否 Integer 查询返回条数。默认值为100。最小值为1，最大值为1000。 marker 否 String 查询的起始记录ID。最小长度为0，最大长度为1024。 reverse_page 否 Boolean 是否倒序查询。

响应参数 状态码：200 表3 响应Header参数 参数 参数类型 描述 X-request-id String 请求ID，定位辅助信息。 状态码：400 表4 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 solution_msg String 解决方案描述。 状态码：401 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 solution_msg String 解决方案描述。 状态码：403 表6 响应Body参数 参数 参数类型 描述 error Error object 错误信息。 error_code String 错误码。 error_msg String 错误描述。 title String 标题。 表7 Error 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 title String 标题。 message String 错误信息。 code String 状态码。 状态码：404 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 solution_msg String 解决方案描述。 状态码：408 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 solution_msg String 解决方案描述。 状态码：500 表10 响应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" }

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

响应示例 状态码：200 OK { "user_group" : [ { "group_name" : "group-name", "group_source" : "IAM" } ], "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}/groups 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目编号。获取方法，请参见获取项目ID。 instance_id 是 String LakeFormation实例ID。创建实例时自动生成。例如：2180518f-42b8-4947-b20b-adfc53981a25。 表2 Query参数 参数 是否必选 参数类型 描述 group_source 否 String 查询的用户组来源：IAM-云用户、SAML-联邦、LDAP-ld用户、LOCAL-本地用户、AGENTTENANT-委托、 OTHER-其它。 limit 否 Integer 查询返回条数。默认值为1000。最小值为1，最大值为2000。 marker 否 String 查询的起始记录ID。最小长度为0，最大长度为256。 reverse_page 否 Boolean 是否倒序查询。

响应参数 状态码：200 表4 响应Body参数 参数 参数类型 描述 user_group Array of UserGroup objects 用户组。 page_info PagedInfo object 分页信息。 表5 UserGroup 参数 参数类型 描述 group_name String 用户组名称。 group_source String 用户组类型：IAM-云、SAML-联邦、LDAP-权限策略、LOCAL-本地、AGENTTENANT-委托、OTHER-其它。 group_id String 用户组ID。 表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 解决方案描述。 状态码：401 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 solution_msg String 解决方案描述。 状态码：403 表9 响应Body参数 参数 参数类型 描述 error Error object 错误信息。 error_code String 错误码。 error_msg String 错误描述。 title String 标题。 表10 Error 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 title String 标题。 message String 错误信息。 code String 状态码。 状态码：404 表11 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 solution_msg String 解决方案描述。 状态码：408 表12 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 solution_msg String 解决方案描述。 状态码：500 表13 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 solution_msg String 解决方案描述。

基本概念 账号 用户的账号对其所拥有的资源及云服务具有完全的访问权限，可以重置用户密码、分配用户权限等。为了确保账号安全，建议您不要直接使用账号进行日常管理工作，而是创建用户并使用用户进行日常管理工作。 用户 由账号在IAM中创建的用户，是云服务的使用人员，具有身份凭证（密码和访问密钥）。 在获取项目ID下，您可以查看账号ID和用户ID。通常在调用API的鉴权过程中，您需要用到账号、用户和密码等信息。 区域（Region） 从地理位置和网络时延维度划分，同一个Region内共享弹性计算、块存储、对象存储、VPC网络、弹性公网IP、镜像等公共服务。Region分为通用Region和专属Region，通用Region指面向公共租户提供通用云服务的Region；专属Region指只承载同一类业务或只面向特定租户提供业务服务的专用Region。 可用区（AZ，Availability Zone） 一个AZ是一个或多个物理数据中心的集合，有独立的风火水电，AZ内逻辑上再将计算、网络、存储等资源划分成多个集群。一个Region中的多个AZ间通过高速光纤相连，以满足用户跨AZ构建高可用性系统的需求。 项目 区域默认对应一个项目，这个项目由系统预置，用来隔离物理区域间的资源（计算资源、存储资源和网络资源），以默认项目为单位进行授权，用户可以访问您账号中该区域的所有资源。如果您希望进行更加精细的权限控制，可以在区域默认的项目中创建子项目，并在子项目中购买资源，然后以子项目为单位进行授权，使得用户仅能访问特定子项目中资源，使得资源的权限控制更加精确。 图1 项目隔离模型 同样在获取项目ID下，您可以查看项目ID。 企业项目 企业项目是项目的升级版，针对企业不同项目间资源的分组和管理，是逻辑隔离。企业项目中可以包含多个区域的资源，且项目中的资源可以迁入迁出

响应参数 状态码：200 表6 响应Header参数 参数 参数类型 描述 X-request-id String 请求ID，定位辅助信息。 状态码：400 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 common_error_code String CBC公共错误码。 solution_msg String 解决方案描述。 状态码：401 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 common_error_code String CBC公共错误码。 solution_msg String 解决方案描述。 状态码：403 表9 响应Body参数 参数 参数类型 描述 error Error object 错误信息。 error_code String 错误码。 error_msg String 错误描述。 title String 标题。 表10 Error 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 title String 标题。 message String 错误信息。 code String 状态码。 状态码：404 表11 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 common_error_code String CBC公共错误码。 solution_msg String 解决方案描述。 状态码：408 表12 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 common_error_code String CBC公共错误码。 solution_msg String 解决方案描述。 状态码：500 表13 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 common_error_code String CBC公共错误码。 solution_msg String 解决方案描述。