使用CreateInstance创建集群实例-向量检索服务 Milvus 版-阿里云

创建集群实例

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

milvus:CreateInstance

create

*Instance

acs:milvus:{#regionId}:{#accountId}:instance/*

无

请求语法

POST /webapi/instance/create HTTP/1.1

请求参数

名称	类型	必填	描述	示例值
RegionId	string	否	地域	cn-beijing
body	object	否	请求 Body
zoneId	string	是	主可用区。	cn-beijing-g
instanceName	string	否	实例名称	milvus-test
dbVersion	string	是	内核版本	2.4
resourceGroupId	string	否	资源组 id	rg-xxx
vpcId	string	是	专有网络 id	vpc-123xxx
paymentType	string	是	付费类型枚举值： PayAsYouGo : 按量付费 Subscription : 包年包月	PayAsYouGo
paymentDuration	integer	否	付费时长	1
paymentDurationUnit	string	否	付费单位枚举值： Month : 月 Year : 年	month
ha	boolean	否	是否开启高可用	true
dbAdminPassword	string	否	db 密码	test12
autoBackup	boolean	否	是否开启自动备份	true
multiZoneMode	string	否	可用区配置。	Single
encrypted	boolean	否	是否开启 oss 加密	false
kmsKeyId	string	否	用来加密的 Kms key 的 id。	key-xxx
configuration	string	否	配置项。	rootCoord: maxDatabaseNum: 64 # Maximum number of database maxPartitionNum: 4096
vSwitchIds	array<object>	否	交换机	["vsw-123xxx"]
	object	否	交换机 ID。
zoneId	string	否	可用区。	cn-shanghai-a
vswId	string	否	可用区下 vswitch id 配置。	vsw-xxx
components	array<object>	否	组件信息
	object	否	实例相关的规格信息列表。
type	string	是	组件类型枚举值： proxy : proxy mix_coordinator : mix_coordinator data : data query : query standalone : standalone index : index	standalone
replica	integer	是	副本数量	1
cuNum	integer	是	CU 数量	8
cuType	string	否	CU 类型。	general
diskSizeType	string	否	Query Node 配置容量型，性能型，容量型配置 Large，其余配置 Normal。	Normal
tags	array<object>	否	实例标签。
	object	否	标签唯一标识，标签 id
key	string	否	资源标签 key 值。	key
value	string	否	资源标签 value 值。	value
clientToken	string	否	用于保证请求的幂等性。由客户端生成该参数值，要保证在不同请求间唯一，最大不超过 64 个 ASCII 字符。	xxx

返回参数

名称	类型	描述	示例值
	object
RequestId	string	请求唯一号	ABCD-1234-5678-EFGH
success	boolean	请求是否成功	true
data	object	返回结果。
instanceId	string	实例 ID	c-xxx
orderId	string	订单 ID。	xxx

示例

正常返回示例

JSON格式

{
  "RequestId": "ABCD-1234-5678-EFGH",
  "success": true,
  "data": {
    "instanceId": "c-xxx",
    "orderId": "xxx"
  }
}

错误码

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。