文档首页> 湖仓构建 LakeFormation> API参考> API> Console> 实例管理> 创建实例

更新时间：2024-04-08 GMT+08:00

查看PDF

创建实例

功能介绍

创建一个LakeFormation实例。

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

URI

POST /v1/{project_id}/instances

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	项目编号。获取方法，请参见获取项目ID。

请求参数

表2 请求Header参数
参数	是否必选	参数类型	描述
X-Auth-Token	是	String	租户token。

表3 请求Body参数
参数	是否必选	参数类型	描述
name	是	String	实例名称。只能包含字母、数字、下划线和中划线，且长度为4到32个字符。
charge_mode	是	String	支付类型：postPaid为按需期、prePaid为包周期。枚举值： postPaid prePaid
enterprise_project_id	否	String	企业项目ID，只有对接了企业项目才可以填写。只能包含字母、数字和中划线，且长度为1到64个字符。
description	否	String	实例描述。用户输入的描述，最长为255个字符。
shared	是	Boolean	false为独享型；true为共享型。默认为true。
order_id	否	String	包周期订购时的订单ID。
specs	否	Array of CreateSpec objects	规格列表。
tags	否	Array of ResourceTag objects	标签列表，最多添加20个标签。
charge_info	否	ChargeInfo object	计费信息，charge_mode为prePaid时不能为空。

表4 CreateSpec
参数	是否必选	参数类型	描述
product_id	否	String	商品ID。由系统自动生成，如OFFI8XXXXXXXXXXXXXXXX4。
spec_code	是	String	规格编码。由系统自动生成，例如lakeformation.unit.basic.qps。
stride_num	是	Integer	步数。QPS为每秒最大请求数步长，最小为5，步长为1。

表5 ResourceTag
参数	是否必选	参数类型	描述
key	是	String	键。
value	否	String	值。

表6 ChargeInfo
参数	是否必选	参数类型	描述
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。当传入浮点型时，会自动截取为整型。
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参数
参数	参数类型	描述
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_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=包周期计费。枚举值： prePaid postPaid

表9 ResourceTag
参数	参数类型	描述
key	String	键。
value	String	值。

**表10** CreateSpec
参数	参数类型	描述
product_id	String	商品ID。由系统自动生成，如OFFI8XXXXXXXXXXXXXXXX4。
spec_code	String	规格编码。由系统自动生成，例如lakeformation.unit.basic.qps。
stride_num	Integer	步数。QPS为每秒最大请求数步长，最小为5，步长为1。

状态码： 400

**表11** 响应Body参数
参数	参数类型	描述
error_code	String	错误码。
error_msg	String	错误描述。
common_error_code	String	CBC公共错误码。
solution_msg	String	解决方案描述。

状态码： 404

**表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	解决方案描述。

请求示例

POST https://{endpoint}/v1/{project_id}/instances

{
  "name" : "lakeformation-instance",
  "charge_mode" : "postPaid",
  "shared" : "true",
  "description" : "",
  "tags" : [ {
    "key" : "key1"
  } ],
  "enterprise_project_id" : "0"
}

响应示例

状态码： 202

创建实例请求下成功

{
  "instance_id" : "2aeb1789-1b04-4bad-92bf-486a399b9a3e",
  "name" : "lakeformation-instance",
  "description" : "",
  "enterprise_project_id" : "0",
  "shared" : false,
  "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" : 0
  }, {
    "spec_code" : "lakeformation.unit.basic.apiinvoke",
    "stride_num" : 0
  } ],
  "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

错误码

请参见错误码。

父主题： 实例管理

上一篇：实例管理

下一篇：查询实例列表

意见反馈

文档内容是否对您有帮助？

有帮助没帮助

提供反馈

提交成功！非常感谢您的反馈，我们会继续努力做到更好！您可在我的云声建议查看反馈及问题处理状态。

系统繁忙，请稍后重试

在使用文档中是否遇到以下问题

内容与产品页面不一致

内容不易理解

缺失示例代码

步骤不可操作

搜不到想要的内容

缺少最佳实践

意见反馈（选填）

0/500

请至少选择一项反馈信息并填写问题反馈

字符长度不能超过500

直接提交取消

如您有其它疑问，您也可以通过华为云社区问答频道来与我们联系探讨

智能客服提问云社区提问

创建实例

功能介绍

调试

URI

请求参数

响应参数

请求示例

响应示例

状态码

错误码

相关文档

相关产品

意见反馈

文档内容是否对您有帮助？

7*24

备案

专业服务

退订

建议反馈

售前咨询热线