向量数据库 Milvus 版
向量数据库 Milvus 版
文档指南
请输入
- 文档首页
向量数据库 Milvus 版API 参考实例管理DescribeInstances - 获取实例列表
复制全文
下载 pdfDescribeInstances - 获取实例列表
文档反馈
问问助手调用 DescribeInstances 获取实例列表。
调试
API Explorer
您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。
请求参数
Action string 必选 示例值：DescribeInstances
要执行的操作，取值：DescribeInstances。
Version string 必选 示例值：2023-01-01
API的版本，取值：2023-01-01。
InstanceId string 可选 示例值：instance-123456
实例 ID。
InstanceName string 可选 示例值：my-milvus-instance
实例名称。
ProjectName string 可选 示例值：ai-platform
项目名称。
PageNumber integer 可选 示例值：1
实例信息列表的页码。
PageSize integer 可选 示例值：10
每页记录数：10-100。
TagFilters object[] 可选 示例值：[]
用于查询筛选的标签键值对数组。
Key string 必选 示例值：-
标签键。
Values string[] 必选 示例值：-
标签值。
返回参数
InstanceInfos object[] 示例值：[]
实例信息。
InstanceId string 示例值：milvus-12345678
实例 ID。
InstanceName string 示例值：milvus-prod-01
实例名称。
InstanceVersion string 示例值：V2_5
Milvus 版本。
ProjectName string 示例值：ai-platform
项目名称。
Region string 示例值：ap-beijing
区域。
Status string 示例值：Running
实例状态。
Init：初始化中。
WaitingPaid：待支付。
WaitCreate：待创建。
Creating：创建中。
Running：运行中。
Restarting：重启中。
Updating：更新中。
WaitScale：待变配。
Scaling：变配中。
Restoring：恢复中。
Upgrading：升级中。
Closing：关闭中。
Closed：已关闭。
Resuming：恢复中。
WaitRelease：待释放。
Releasing：释放中。
Released：已释放。
CreateFailed：创建失败。
Error：错误。
Warn：警告。
Zones string[] 示例值：-
可用区列表。
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 12:00:00
到期时间。
DeleteProtectEnabled boolean 示例值：true
是否开启删除保护。
CreateTime string 示例值：2023-01-15T10:30:00Z
创建时间。
Tags object[] 示例值：-
标签列表。
Key string 示例值：-
标签键。
Value string 示例值：-
标签值。
Size integer 示例值：2
当前页数量。
Total integer 示例值：10
实例总数量。
PageNumber integer 示例值：1
实例信息列表的页码。
PageSize integer 示例值：10
每页记录数。
请求示例
POST /?Action=DescribeInstances&Version=2023-01-01 HTTP/1.1
Host: milvus.cn-beijing.volcengineapi.com
Content-Type: application/json; charset=UTF-8
X-Date: 20251027T125939Z
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": "instance-123456",
"InstanceName": "my-milvus-instance",
"ProjectName": "ai-platform",
"PageNumber": 1,
"PageSize": 10,
"TagFilters": [
{
"Key": "LQT",
"Values": [
"daQ"
]
}
]
}
返回示例
{
"ResponseMetadata": {
"RequestId": "202510272059421341810312017ED5C8",
"Action": "DescribeInstances",
"Version": "2023-01-01",
"Service": "milvus",
"Region": "cn-beijing"
},
"Result": {
"InstanceInfos": [
{
"InstanceId": "milvus-12345678",
"InstanceName": "milvus-prod-01",
"InstanceVersion": "V2_5",
"ProjectName": "ai-platform",
"Region": "ap-beijing",
"Status": "Running",
"Zones": [
"Z"
],
"NetworkConfig": {
"VpcInfo": {
"VpcId": "vpc-12345678",
"VpcName": "milvus-vpc"
},
"SubnetInfo": {
"SubnetId": "subnet-12345678",
"SubnetName": "milvus-subnet"
},
"InnerEndpointEnabled": true
},
"ChargeConfig": {
"ChargeType": "C4sHT6",
"Period": 12,
"AutoRenew": true,
"ExpireDate": "2025-12-31 12:00:00"
},
"DeleteProtectEnabled": true,
"CreateTime": "2023-01-15T10:30:00Z",
"Tags": [
{
"Key": "9CKexeIUE3w",
"Value": "6ReTL"
}
]
}
],
"Size": 2,
"Total": 10,
"PageNumber": 1,
"PageSize": 10
}
}
错误码
状态码 | 错误码 | 错误信息 | 说明 |
200 | InternalServerError | InternalServerError | 服务内部异常。 |
最近更新时间：2026.06.12 11:46:28
这个页面对您有帮助吗？
有用
有用
无用
无用