You need to enable JavaScript to run this app.
文档中心
向量数据库 Milvus 版

向量数据库 Milvus 版

复制全文
下载 pdf
实例管理
CreateInstanceOneStep - 创建实例
复制全文
下载 pdf
CreateInstanceOneStep - 创建实例
调用 CreateInstanceOneStep 一步创建实例。
调试
API Explorer
您可以通过 API Explorer 在线发起调用,无需关注签名生成过程,快速获取调用结果。
请求参数
下方仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数
Action string 必选 示例值:CreateInstanceOneStep
要执行的操作,取值:CreateInstanceOneStep。
Version string 必选 示例值:2023-01-01
API的版本,取值:2023-01-01。
InstanceConfiguration object 必选 示例值:{}
实例基本配置。
InstanceName string 必选 示例值:milvus-instance-01
实例名称。
InstanceVersion string 必选 示例值:V2_5
Milvus 版本。
  • V2_5:对应 Milvus 2.5.x 版本。
  • V2_6:对应 Milvus 2.6.x 版本
HaEnabled boolean 可选 示例值:true
是否开启高可用(Deprecated)。
ComponentSpecList object[] 必选 示例值:-
组件规格列表。
NodeNum integer 必选 示例值:-
节点数量。
CpuNum integer 可选 示例值:-
CPU 核数(Deprecated)。
MemSize integer 可选 示例值:-
内存大小(Deprecated)。
NodeType string 必选 示例值:-
节点类型。
NodeCUType string 可选 示例值:-
节点 CU 类型(Deprecated)。
  • CAPACITY:容量型。
  • PERFORMANCE: 性能型。
ResourceSpecName string 必选 示例值:-
规格名称(从规格列表接口获取对应节点类型支持的规格)。
AdminPassword string 必选 示例值:SecurePassword123!
管理员密码。
NetworkConfig object 必选 示例值:{}
网络配置。
VpcInfo object 必选 示例值:-
私有网络信息。
VpcId string 必选 示例值:vpc-12345678
私有网络 ID。
VpcName string 可选 示例值:milvus-vpc
私有网络名称。
SubnetInfo object 必选 示例值:-
子网信息。
SubnetId string 必选 示例值:subnet-12345678
子网 ID。
SubnetName string 可选 示例值:milvus-subnet
子网名称。
ChargeConfig object 必选 示例值:{}
计费配置。
ChargeType string 必选 示例值:PRE
计费类型。
POST:按量计费。
PRE:包年包月。
Period integer 可选 示例值:12
购买时长。单位:月。
包年包月下必填。
AutoRenew boolean 可选 示例值:true
是否开启自动续费。
包年包月下必填。
ExpireDate string 可选 示例值:2025-12-31 12:00:00
到期时间(Deprecated)。
Region string 可选 示例值:ap-beijing
区域(Deprecated)。
Zones string[] 必选 示例值:[]
可用区。
Tags object[] 可选 示例值:[]
标签。
Key string 必选 示例值:environment
标签键。
Value string 必选 示例值:production
标签值。
ProjectName string 可选 示例值:ai-platform
项目名称。
默认为 default。
DeleteProtectEnabled boolean 可选 示例值:true
是否开启删除保护。
返回参数
下方仅列出本接口特有的返回参数。更多信息请参见返回结构
OrderID string 示例值:B00
订单 ID。
OrderNO string 示例值:B00
订单号。
InstanceId string 示例值:milvus-xxx
实例 ID。
TradeEnabled boolean 示例值:true
是否开启交易,当前仅支持 true。
TradeConfigId string 示例值:B00
交易配置单 ID。
请求示例
POST /?Action=CreateInstanceOneStep&Version=2023-01-01 HTTP/1.1
Host: milvus.cn-beijing.volcengineapi.com
Content-Type: application/json; charset=UTF-8
X-Date: 20251027T125731Z
X-Content-Sha256: 287e874e******d653b44d21e
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20251027/cn-beijing/milvus/request, SignedHeaders=host;x-content-sha256;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f
{
"InstanceConfiguration": {
"InstanceName": "milvus-instance-01",
"InstanceVersion": "V2_5",
"HaEnabled": true,
"ComponentSpecList": [
{
"NodeType": "D3",
"CpuNum": 1.3280476287606415,
"MemSize": 828.0444265105901,
"NodeNum": 575.031725645527,
"NodeCUType": "XKLcmV2Bz",
"ResourceSpecName": "yfR"
}
],
"AdminPassword": "SecurePassword123!"
},
"NetworkConfig": {
"VpcInfo": {
"VpcId": "vpc-12345678",
"VpcName": "milvus-vpc"
},
"SubnetInfo": {
"SubnetId": "subnet-12345678",
"SubnetName": "milvus-subnet"
},
"InnerEndpointEnabled": true
},
"ChargeConfig": {
"ChargeType": "PRE",
"Period": 12,
"AutoRenew": true,
"ExpireDate": "2025-12-31 12:00:00"
},
"Region": "ap-beijing",
"Zones": [
"skReWqLyG"
],
"Tags": [
{
"Key": "environment",
"Value": "production"
}
],
"ProjectName": "default",
"DeleteProtectEnabled": true
}
返回示例
{
"ResponseMetadata": {
"RequestId": "20251027205734191076210077AEC70D",
"Action": "CreateInstanceOneStep",
"Version": "2023-01-01",
"Service": "milvus",
"Region": "cn-beijing"
},
"Result": {
"OrderID": "uGk",
"OrderNO": "JVUMP6Hh",
"InstanceId": "t7O",
"TradeEnabled": false,
"TradeConfigId": "JUfJgXG"
}
}
错误码
下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。
状态码
错误码
错误信息
说明
200
BadRequestParameterEmpty
Parameter can not be empty.
参数不可为空
200
ComponentSpecMissing
Component spec missing
规格缺失。
200
NodeNumTooSmall
Node number too small
节点数不足。
200
NodeCpuNotValid
Node cpu not valid
CPU 规格有误。
200
NodeMemNotValid
Node mem not valid
内存规格有误。
200
ComponentSpecNotSupported
Component spec not supported
不支持传入规格。
200
NodeNumTooBig
Node number too big
节点数过多。
200
CreateOrderFailed
CreateOrderFailed
创建订单失败。
200
InternalServerError
InternalServerError
服务内部异常。
最近更新时间:2026.06.12 10:14:31
这个页面对您有帮助吗?
有用
有用
无用
无用