# 创建实例 - CreateLakeFormationInstance #### 功能介绍 创建一个LakeFormation实例。 #### 调试 您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/LakeFormation/doc?api=CreateLakeFormationInstance)中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-lakeformation/abcd.html)。 #### URI POST /v1/{project_id}/instances 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释:** 项目编号。获取方法，请参见[获取项目ID](https://support.huaweicloud.com/api-lakeformation/lakeformation_04_0026.html) **约束限制:** 不涉及 **取值范围:** 不涉及 **默认取值:** 不涉及 | #### 请求参数 表2请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 否 | String | **参数解释:** 租户token **约束限制:** 长度为0\~65534个字符 **取值范围:** 长度为0\~65534个字符 **默认取值:** 不涉及 | 表3请求Body参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | name | 是 | String | **参数解释:** 实例名称。只能包含字母、数字、下划线和中划线，且长度为4到32个字符 **约束限制:** 长度为4\~32个字符 **取值范围:** 长度为4\~32个字符 **默认取值:** 不涉及 | | charge_mode | 是 | String | **参数解释:** 支付类型：postPaid为按需期、prePaid为包周期 **约束限制:** 可选值为：postPaid, prePaid **取值范围:** 不涉及 **默认取值:** 不涉及 | | enterprise_project_id | 否 | String | **参数解释:** 企业项目ID，只有对接了企业项目才可以填写。只能包含字母、数字和中划线，且长度为1到64个字符 **约束限制:** 长度为1\~64个字符 **取值范围:** 长度为1\~64个字符 **默认取值:** 不涉及 | | description | 否 | String | **参数解释:** 实例描述。用户输入的描述，最长为255个字符 **约束限制:** 长度为0\~255个字符 **取值范围:** 长度为0\~255个字符 **默认取值:** 不涉及 | | shared | 是 | Boolean | **参数解释:** false为独享型；true为共享型。默认为true **约束限制:** 不涉及 **取值范围:** 不涉及 **默认取值:** true | | order_id | 否 | String | **参数解释:** 订单ID。已废弃，无需填写 **约束限制:** 长度为0\~64个字符 **取值范围:** 长度为0\~64个字符 **默认取值:** 不涉及 | | specs | 否 | Array of [CreateSpec] objects | **参数解释:** 规格列表 **约束限制:** 数组元素个数为1\~10 **取值范围:** 数组元素个数为1\~10 **默认取值:** 不涉及 | | tags | 否 | Array of [ResourceTag] objects | **参数解释:** 标签列表，最多添加20个标签 **约束限制:** 数组元素个数为0\~20 **取值范围:** 数组元素个数为0\~20 **默认取值:** 不涉及 | | charge_info | 否 | [ChargeInfo] object | **参数解释:** 计费信息，购买包周期产品时，也就是charge_mode为prePaid时不能为空 **约束限制:** 不涉及 **取值范围:** 不涉及 **默认取值:** 不涉及 | 表4CreateSpec | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | product_id | 否 | String | **参数解释:** 商品ID。已废弃，无需填写 **约束限制:** 长度为0\~64个字符 **取值范围:** 长度为0\~64个字符 **默认取值:** 不涉及 | | spec_code | 是 | String | **参数解释:** 规格编码 **约束限制:** 长度为1\~64个字符 **取值范围:** 长度为1\~64个字符 **默认取值:** 不涉及 | | stride_num | 是 | Integer | **参数解释:** QPS规格步数，QPS为每秒最大请求数，最小为5，步长为1。只有在创建独享型实例（字段shared为false）时生效 **约束限制:** 取值为0\~2147483647 **取值范围:** 取值为0\~2147483647 **默认取值:** 不涉及 | 表5ResourceTag | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | key | 是 | String | **参数解释:** 键 **约束限制:** 不涉及 **取值范围:** 不涉及 **默认取值:** 不涉及 | | value | 否 | String | **参数解释:** 值 **约束限制:** 不涉及 **取值范围:** 不涉及 **默认取值:** 不涉及 | 表6ChargeInfo | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | period_type | 否 | String | **参数解释:** 购买包周期产品时，也就是charge_mode为prePaid时生效，且为必选值，订购周期类型。取值范围：MONTH：包月；YEAR：包年 **约束限制:** 可选值为：MONTH, YEAR **取值范围:** 不涉及 **默认取值:** 不涉及 | | period_num | 否 | Integer | **参数解释:** 购买包周期产品时，也就是charge_mode为prePaid时生效，且为必选值，指定订购的时间。取值范围：当period_type为month时，取值为1\~9。当period_type为year时，取值为1\~3。当传入浮点型时，会自动截取为整型 **约束限制:** 取值为1\~9 **取值范围:** 取值为1\~9 **默认取值:** 不涉及 | | is_auto_renew | 否 | Boolean | **参数解释:** 购买包周期产品时，也就是charge_mode为prePaid时生效，且为必选值，表示是否自动续订，续订时会自动支付。 按月订购时续订周期默认为1个月，按年订购时续订周期默认为1年，续订周期可自定义修改。true：为自动续订。false：为不自动续订，默认该方式 **约束限制:** 不涉及 **取值范围:** 不涉及 **默认取值:** 不涉及 | | is_auto_pay | 否 | Boolean | **参数解释:** 购买包周期产品时，也就是charge_mode为prePaid时生效，且为必选值，表示是否自动从客户的账户中支付，此字段不影响自动续订的支付方式。true：为自动支付。false：为手动支付，默认该方式 **约束限制:** 不涉及 **取值范围:** 不涉及 **默认取值:** 不涉及 | #### 响应参数 **状态码：202** 表7响应Header参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | X-request-id | String | 请求ID，定位辅助信息。 | 表8响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | order_id | String | **参数解释:** 订单id(包周期使用) | | 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_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=包周期计费 | 表9ResourceTag | 参数 | 参数类型 | 描述 | |:---|:---|:---| | key | String | **参数解释:** 键 **取值范围:** 不涉及 | | value | String | **参数解释:** 值 **取值范围:** 不涉及 | 表10CreateSpec | 参数 | 参数类型 | 描述 | |:---|:---|:---| | product_id | String | **参数解释:** 商品ID。已废弃，无需填写 **取值范围:** 长度为0\~64个字符 | | spec_code | String | **参数解释:** 规格编码 **取值范围:** 长度为1\~64个字符 | | stride_num | Integer | **参数解释:** QPS规格步数，QPS为每秒最大请求数，最小为5，步长为1。只有在创建独享型实例（字段shared为false）时生效 **取值范围:** 取值为0\~2147483647 | **状态码：400** 表11响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释:** 错误码 | | error_msg | String | **参数解释:** 错误描述 | | common_error_code | String | **参数解释:** CBC公共错误码 | | solution_msg | String | **参数解释:** 解决方案描述 | **状态码：401** 表12响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释:** 错误码 | | error_msg | String | **参数解释:** 错误描述 | | common_error_code | String | **参数解释:** CBC公共错误码 | | solution_msg | String | **参数解释:** 解决方案描述 | **状态码：403** 表13响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error | [Error] object | **参数解释:** 错误信息 | | error_code | String | **参数解释:** 错误码 | | error_msg | String | **参数解释:** 错误描述 | | title | String | **参数解释:** 标题 | 表14Error | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释:** 错误码 | | error_msg | String | **参数解释:** 错误描述 | | title | String | **参数解释:** 标题 | | message | String | **参数解释:** 错误信息 | | code | String | **参数解释:** 状态码 | **状态码：404** 表15响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释:** 错误码 | | error_msg | String | **参数解释:** 错误描述 | | common_error_code | String | **参数解释:** CBC公共错误码 | | solution_msg | String | **参数解释:** 解决方案描述 | **状态码：408** 表16响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释:** 错误码 | | error_msg | String | **参数解释:** 错误描述 | | common_error_code | String | **参数解释:** CBC公共错误码 | | solution_msg | String | **参数解释:** 解决方案描述 | **状态码：500** 表17响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释:** 错误码 | | error_msg | String | **参数解释:** 错误描述 | | common_error_code | String | **参数解释:** CBC公共错误码 | | solution_msg | String | **参数解释:** 解决方案描述 | #### 请求示例 - ``` POST https://{endpoint}/v1/{project_id}/instances { "name" : "lakeformation-instance", "charge_mode" : "postPaid", "shared" : "true", "description" : "", "tags" : [ { "key" : "key1" } ], "enterprise_project_id" : "123" } ``` #### 响应示例 **状态码：202** 创建实例请求下发成功 ``` { "instance_id" : "2aeb1789-1b04-4bad-92bf-486a399b9a3e", "name" : "lakeformation-instance", "description" : "", "enterprise_project_id" : "123", "shared" : true, "default_instance" : false, "create_time" : "2023-08-03T11:50:02.000+00:00", "update_time" : "2023-08-03T11:50:04.000+00:00", "status" : "RUNNING", "in_recycle_bin" : false, "tags" : [ ], "specs" : [ { "spec_code" : "lakeformation.unit.basic.metadata", "stride_num" : 5 }, { "spec_code" : "lakeformation.unit.basic.apiinvoke", "stride_num" : 5 } ], "charge_mode" : "postPaid" } ``` **状态码：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 | 创建实例请求下成功 | | 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)。