创建知识仓实例
功能介绍
创建知识仓实例。知识仓实例名称region内唯一。
URI
POST /v1/stores/create
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
store_name |
是 |
String |
参数解释: 知识仓实例名称,region内唯一。 约束限制: 长度范围为3到63个字符,支持小写字母、数字、中划线(-),第一个字符只能够是小写字母,中划线(-)不得出现在字符串末尾。 取值范围: 不涉及 默认取值: 不涉及 |
region |
是 |
String |
参数解释: 区域ID。 约束限制: 不涉及。 取值范围: 取值:非空,请参见地区和终端节点。 默认取值: 无 |
availability_zones |
是 |
Array of strings |
参数解释: 可用区ID列表,支持1个,或者多个。 约束限制: 不涉及。 |
flavor |
是 |
flavor object |
参数解释: 规格信息。 约束限制: 不涉及。 |
charge_info |
否 |
charge_info object |
参数解释: 计费类型信息。 约束限制: 当前仅支持按需计费模式。 |
description |
否 |
String |
参数解释: 知识仓实例描述信息。 约束限制: 有效长度0-255字节。 取值范围: 不涉及。 默认取值: 不涉及。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
cu |
是 |
String |
参数解释: CU规格。 约束限制: 不涉及。 取值范围: xlarge, 2xlarge, 4xlarge, 8xlarge, 16xlarge。 默认取值: 不涉及。 |
num |
是 |
Integer |
参数解释: 选择CU规格的数量。 约束限制: 不能超过CU配额,如有大量需求,请提工单申请。 取值范围: 不涉及。 默认取值: 不涉及。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
charge_mode |
是 |
String |
参数解释: 计费模式。 约束限制: 当前只支持按需付费。 取值范围: prePaid:预付费,即包年/包月。 postPaid:后付费,即按需付费。 默认取值: 按需付费。 |
period_type |
否 |
String |
参数解释: 订购周期类型。 约束限制: “charge_mode”为“prePaid”时生效,且为必选值。 取值范围: month:包月。 year:包年。 默认取值: 不涉及。 |
period_num |
否 |
Integer |
参数解释: 订购的时间。 约束限制: “charge_mode”为“prePaid”时生效,且为必选值,指定订购的时间。 取值范围: 当“period_type”为“month”时,取值为1~9。 当“period_type”为“year”时,取值为1~3和5。 默认取值: 不涉及。 |
is_auto_renew |
否 |
Boolean |
参数解释: 表示是否自动续订,续订的周期和原周期相同,且续订时会自动支付。 约束限制: 在创建包周期实例时可指定。 取值范围: 不涉及。 默认取值: 不涉及。 |
is_auto_pay |
否 |
Boolean |
参数解释: 表示是否自动从客户的账户中支付,此字段不影响自动续订的支付方式。 约束限制: 在创建包周期时可指定。 取值范围: 不涉及。 默认取值: 不涉及。 |
响应参数
状态码:200
参数 |
参数类型 |
描述 |
---|---|---|
code |
String |
参数解释: 返回码。参见错误码章节。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
message |
String |
参数解释: 描述信息。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
data |
create_store_data object |
参数解释: 响应数据。 约束限制: 不涉及。 |
参数 |
参数类型 |
描述 |
---|---|---|
id |
String |
参数解释: 知识仓实例id。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
job_id |
String |
参数解释: 创建知识仓实例的任务id。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
store_name |
String |
参数解释: 知识仓实例名称,region内唯一。 约束限制: 长度范围为3到63个字符,支持小写字母、数字、中划线(-),第一个字符只能够是小写字母,中划线(-)不得出现在字符串末尾。 取值范围: 不涉及 默认取值: 不涉及 |
status |
String |
参数解释: 知识仓实例状态。 约束限制: 不涉及。 取值范围: CREATING:创建中 NORMAL:正常 CREATED_FAILED:创建失败 ABNORMAL:异常 FROZEN:被冻结 DISK_FULL:存储空间已满 DROPPING:删除中 DELETE_FAILED:删除失败 默认取值: 不涉及。 |
region |
String |
参数解释: 区域ID。 约束限制: 不涉及。 取值范围: 取值:非空,请参见地区和终端节点。 默认取值: 不涉及。 |
availability_zones |
Array of strings |
参数解释: 可用区ID列表,支持1个,或者多个。 约束限制: 不涉及。 |
flavor |
flavor object |
参数解释: 规格信息。 约束限制: 不涉及。 |
charge_info |
charge_info object |
参数解释: 计费类型信息。 约束限制: 当前仅支持按需计费模式。 |
description |
String |
参数解释: 知识仓实例描述信息。 约束限制: 有效长度0-255 取值范围: 不涉及。 默认取值: 不涉及。 |
参数 |
参数类型 |
描述 |
---|---|---|
cu |
String |
参数解释: CU规格。 约束限制: 不涉及。 取值范围: xlarge, 2xlarge, 4xlarge, 8xlarge, 16xlarge。 默认取值: 不涉及。 |
num |
Integer |
参数解释: 选择CU规格的数量。 约束限制: 不能超过CU配额,如有大量需求,请提工单申请。 取值范围: 不涉及。 默认取值: 不涉及。 |
参数 |
参数类型 |
描述 |
---|---|---|
charge_mode |
String |
参数解释: 计费模式。 约束限制: 当前只支持按需付费。 取值范围: prePaid:预付费,即包年/包月。 postPaid:后付费,即按需付费。 默认取值: 按需付费。 |
period_type |
String |
参数解释: 订购周期类型。 约束限制: “charge_mode”为“prePaid”时生效,且为必选值。 取值范围: month:包月。 year:包年。 默认取值: 不涉及。 |
period_num |
Integer |
参数解释: 订购的时间。 约束限制: “charge_mode”为“prePaid”时生效,且为必选值,指定订购的时间。 取值范围: 当“period_type”为“month”时,取值为1~9。 当“period_type”为“year”时,取值为1~3和5。 默认取值: 不涉及。 |
is_auto_renew |
Boolean |
参数解释: 表示是否自动续订,续订的周期和原周期相同,且续订时会自动支付。 约束限制: 在创建包周期实例时可指定。 取值范围: 不涉及。 默认取值: 不涉及。 |
is_auto_pay |
Boolean |
参数解释: 表示是否自动从客户的账户中支付,此字段不影响自动续订的支付方式。 约束限制: 在创建包周期时可指定。 取值范围: 不涉及。 默认取值: 不涉及。 |
状态码:400
参数 |
参数类型 |
描述 |
---|---|---|
code |
String |
参数解释: 返回码。参见错误码章节。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
message |
String |
参数解释: 描述信息。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
请求示例
/v1/stores/create { "store_name" : "test-storename", "region" : "cn-north-7", "availability_zones" : [ "cn-north-7c" ], "flavor" : { "cu" : "xlarge", "num" : 1 }, "charge_info" : { "charge_mode" : "postPaid" } }
响应示例
状态码:200
创建知识仓实例请求成功
{ "code" : "LMS.00000000", "message" : "Request success, store is creating", "data" : { "id" : "a3dbc6b6-4279-4472-8ff0-f031ed7cf96c", "job_id" : "8234ba08-74ca-4a23-b129-460f73537dfe", "store_name" : "test-storename", "status" : "CREATING", "region" : "cn-north-7", "availability_zones" : [ "cn-north-7c" ], "flavor" : { "cu" : "xlarge", "num" : 1 }, "charge_info" : { "charge_mode" : "postPaid" }, "description" : null } }
状态码:400
Bad Request
{ "code" : "LMS.10001005", "message" : "Store already exists" }
状态码
状态码 |
描述 |
---|---|
200 |
创建知识仓实例请求成功 |
400 |
Bad Request |
错误码
请参见错误码。