# 更新实例 - UpdateLakeFormationInstance #### 功能介绍 修改LakeFormation实例信息。 #### 调试 您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/LakeFormation/doc?api=UpdateLakeFormationInstance)中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-lakeformation/abcd.html)。 #### URI PUT /v1/{project_id}/instances/{instance_id} 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释:** 项目编号。获取方法，请参见[获取项目ID](https://support.huaweicloud.com/api-lakeformation/lakeformation_04_0026.html) **约束限制:** 不涉及 **取值范围:** 不涉及 **默认取值:** 不涉及 | | instance_id | 是 | String | **参数解释:** LakeFormation实例ID。创建实例时自动生成。例如：2180518f-42b8-4947-b20b-adfc53981a25 **约束限制:** 不涉及 **取值范围:** 不涉及 **默认取值:** 不涉及 | #### 请求参数 表2请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 否 | String | **参数解释:** 租户token **约束限制:** 长度为0\~65534个字符 **取值范围:** 长度为0\~65534个字符 **默认取值:** 不涉及 | 表3请求Body参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | name | 是 | String | **参数解释:** 实例名称。只能包含字母、数字、下划线和中划线，且长度为4到32个字符 **约束限制:** 长度为4\~32个字符 **取值范围:** 长度为4\~32个字符 **默认取值:** 不涉及 | | description | 否 | String | **参数解释:** 实例描述。用户输入的描述，最长为255个字符 **约束限制:** 长度为0\~255个字符 **取值范围:** 长度为0\~255个字符 **默认取值:** 不涉及 | #### 响应参数 **状态码：200** 表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-扩容失败 | | in_recycle_bin | Boolean | **参数解释:** 是否在回收站 | | tags | Array of [ResourceTag] objects | **参数解释:** 标签列表 | 表5ResourceTag | 参数 | 参数类型 | 描述 | |:---|:---|:---| | key | String | **参数解释:** 键 **取值范围:** 不涉及 | | value | String | **参数解释:** 值 **取值范围:** 不涉及 | **状态码：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 | **参数解释:** 标题 | 表9Error | 参数 | 参数类型 | 描述 | |:---|:---|:---| | 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 | **参数解释:** 解决方案描述 | #### 请求示例 ``` PUT https://{endpoint}/v1/{project_id}/instances/{instance_id} { "name" : "LakeFormation_instance_update", "description" : "description" } ``` #### 响应示例 **状态码：200** 实例信息 ``` { "instance_id" : "01049549-82cd-4b2b-9733-ddb94350c125", "name" : "LakeFormation_instance", "description" : "string", "enterprise_project_id" : "123", "shared" : true, "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 } ``` **状态码：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 | 实例信息 | | 400 | Bad Request | | 401 | Unauthorized | | 403 | Forbidden | | 404 | Not Found | | 408 | Request Timeout | | 500 | Internal Server Error | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-lakeformation/ErrorCode.html)。