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

向量数据库 Milvus 版

复制全文
下载 pdf
实例管理
DescribeInstanceDetail - 获取实例详情
复制全文
下载 pdf
DescribeInstanceDetail - 获取实例详情
调用 DescribeInstanceDetail 获取实例详情。​
调试​
API Explorer
您可以通过 API Explorer 在线发起调用,无需关注签名生成过程,快速获取调用结果。
​
请求参数​
下方仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。​
Action string 必选 示例值:DescribeInstanceDetail​
要执行的操作,取值:DescribeInstanceDetail。​
​
Version string 必选 示例值:2023-01-01​
API的版本,取值:2023-01-01。​
​
InstanceId string 必选 示例值:milvus-xxx​
实例 ID。​
​
​
​
返回参数​
下方仅列出本接口特有的返回参数。更多信息请参见返回结构。​
BaseInstance object 示例值:{}​
实例基本配置。​
InstanceId string 示例值:milvus-12345678​
实例 ID。​
​
InstanceName string 示例值:milvus-prod-01​
实例名称。​
​
InstanceVersion string 示例值:V2_5​
实例版本。​
  • V2_5。​
  • V2_6。​
​
AccountId string 示例值:account-123​
账号 ID。​
​
SubAccountId string 示例值:sub-account-456​
子账号 ID。​
​
Region string 示例值:ap-beijing​
区域。​
​
ProjectName string 示例值:ai-platform​
项目名称。​
​
Status string 示例值:Running​
实例状态。​
  • Init:初始化中。​
  • WaitingPaid:待支付。​
  • WaitCreate:待创建。​
  • Creating:创建中。​
  • Running:运行中。​
  • Restarting:重启中。​
  • Updating:更新中。​
  • WaitScale:待变配。​
  • Scaling:变配中。​
  • Restoring:恢复中。​
  • Upgrading:升级中。​
  • Closing:关闭中。​
  • Closed:已关闭。​
  • Resuming:恢复中。​
  • WaitRelease:待释放。​
  • Releasing:释放中。​
  • Released:已释放。​
  • CreateFailed:创建失败。​
  • Error:错误。​
  • Warn:警告。​
​
​
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 示例值:-​
计费类型。​
  • POST:按量计费。​
  • PRE:包年包月。​
​
ExpireDate string 示例值:2025-12-31​
到期时间。​
​
​
EndpointList object[] 示例值:[]​
访问点列表。​
Type string 示例值:-​
终端类型。​
  • MILVUS_PRIVATE:私网接入点。​
  • MILVUS_PUBLIC:公网接入点。​
​
Domain string 示例值:-​
域名。​
​
Ip string 示例值:-​
IP 地址。​
​
PrivateDomainPublishEnabled boolean 示例值:-​
是否开启私网域名公网解析。​
​
AllowGroupList object[] 示例值:-​
白名单组列表。​
GroupName string 示例值:-​
白名单分组名称。​
​
List string[] 示例值:-​
白名单列表。​
​
​
Eip string 示例值:-​
公网 IP。​
​
AllowList string[] 示例值:-​
白名单。​
​
EipId string 示例值:-​
公网 IP ID。​
​
​
SpecConfig object[] 示例值:[]​
规格配置。​
ResourceSpecName string 示例值:-​
规格名称。​
​
SpecType string 示例值:-​
规格类型CU/GPU。​
​
DisplayName string 示例值:-​
规格显示名称​
​
NodeType string 示例值:QUERY_NODE​
节点类型。​
​
CpuNum integer 示例值:4​
CPU 核数。​
​
MemSize integer 示例值:16​
内存大小。​
​
NodeNum integer 示例值:2​
节点数量。​
​
​
DeleteProtectEnabled boolean 示例值:true​
是否开启删除保护。​
​
Zones string[] 示例值:[]​
可用区。​
​
CreateTime string 示例值:2023-01-15T10:30:00Z​
创建时间。​
​
Tags object[] 示例值:[]​
标签列表。​
Key string 示例值:environment​
标签键。​
​
Value string 示例值:production​
标签值。​
​
​
StorageUsage string 示例值:test​
存储用量。​
​
​
​
请求示例​
​
POST /?Action=DescribeInstanceDetail&Version=2023-01-01 HTTP/1.1​
Host: milvus.cn-beijing.volcengineapi.com​
Content-Type: application/json; charset=UTF-8​
X-Date: 20251027T125910Z​
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​
​
{​
"InstanceId": "jMV"​
}​
​
返回示例​
​
{​
"ResponseMetadata": {​
"RequestId": "20251027205913113065195101B45469",​
"Action": "DescribeInstanceDetail",​
"Version": "2023-01-01",​
"Service": "milvus",​
"Region": "cn-beijing"​
},​
"Result": {​
"BaseInstance": {​
"Id": 12345,​
"InstanceId": "milvus-12345678",​
"InstanceName": "milvus-prod-01",​
"InstanceVersion": "V2_5",​
"AccountId": "account-123",​
"SubAccountId": "sub-account-456",​
"DeployClusterId": "cluster-789",​
"Namespace": "milvus-namespace",​
"Region": "ap-beijing",​
"ProjectName": "ai-platform",​
"TaskId": "task-987654",​
"Version": 1,​
"Status": "Running"​
},​
"NetworkConfig": {​
"VpcInfo": {​
"VpcId": "vpc-12345678",​
"VpcName": "milvus-vpc"​
},​
"SubnetInfo": {​
"SubnetId": "subnet-12345678",​
"SubnetName": "milvus-subnet"​
},​
"InnerEndpointEnabled": true​
},​
"ChargeConfig": {​
"ChargeType": "jcXDgxZ",​
"Period": 12,​
"AutoRenew": true,​
"ExpireDate": "2025-12-31"​
},​
"EndpointList": [​
{​
"Type": "uesATxa",​
"Domain": "837F",​
"Ip": "D60AKfRc",​
"PrivateDomainPublishEnabled": false,​
"AllowGroupList": [​
{​
"GroupName": "JzxfTU",​
"List": [​
"s"​
]​
}​
],​
"Eip": "bTWrt",​
"AllowList": [​
"NRvQ"​
],​
"EipId": "k1oCu"​
}​
],​
"SpecConfig": [​
{​
"NodeType": "QUERY_NODE",​
"CpuNum": 4,​
"MemSize": 16,​
"NodeNum": 2,​
"NodeCUType": "uTgdAge"​
}​
],​
"DeleteProtectEnabled": true,​
"Zones": [​
"P"​
],​
"EngineVersion": "2.0.0",​
"CreateTime": "2023-01-15T10:30:00Z",​
"Tags": [​
{​
"Key": "environment",​
"Value": "production"​
}​
],​
"StorageUsage": "Tw",​
"HaEnabled": true​
}​
}​
​
错误码​
下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。​
​
状态码​
错误码​
错误信息​
说明​
200​
AccountNoPermission​
accountId have no permission​
当前账号没有权限。​
200​
InstanceIsReleased​
InstanceIsReleased​
实例已释放。​
200​
InstanceNotFound​
InstanceNotFound​
实例不存在。​
200​
InternalServerError​
InternalServerError​
服务内部异常。​
200​
BadRequestParameterEmpty​
Parameter can not be empty.​
参数不可为空。​
200​
IllegalParameter​
illegal parameter​
非法参数。​
​
​
最近更新时间:2026.06.12 11:46:28
这个页面对您有帮助吗?
有用
有用
无用
无用