ListInstances - 获取实例列表_向量检索服务 Milvus 版(Milvus)-阿里云帮助中心

获取当前账号下Milvus实例列表。

调试

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

调试

授权信息

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

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

操作

访问级别

资源类型

条件关键字

关联操作

milvus:ListInstances

list

*Instance

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

无

请求语法

POST /webapi/order/list HTTP/1.1

请求参数

名称	类型	必填	描述	示例值
ClusterName	string	否	实例名称。	milvus-test
ClusterId	string	否	实例 ID。	c-123xxx
PageNumber	integer	否	页码。	1
PageSize	integer	否	分页大小。	10
RegionId	string	否	地域。	cn-beijing
ResourceGroupId	string	否	资源组 id	rg-123xxx
Tag	array<object>	否	tag 信息
	object	否	tag 信息
Key	string	否	tag 的 key	key1
Value	string	否	tag 的 value	value1

返回参数

名称	类型	描述	示例值
	object
HttpStatusCode	integer	HTTP 请求状态码。	200
RequestId	string	请求 ID。	ABCD-1234-5678-EFGH
Success	boolean	请求是否成功。	true
ErrCode	string	错误码。	Instance.NotFound
ErrMessage	string	错误信息。	Failed to find instance c-123xxx
Data	array<object>	返回数据。
	array<object>
InstanceId	string	实例 ID。	c-123xxx
BeginTime	integer	开始时间。	1718608505000
RunningTime	integer	运行时间。	536611
ExpireTime	integer	过期时间。	1721232000000
RegionId	string	地域。	cn-beijing
ZoneId	string	可用区。	cn-beijing-g
InstanceStatus	string	实例状态。取值范围： creating：创建中。 running：运行中。 updating：升级中。集群升降配、配置变更和开关公网等。 disable：不可用。集群已经过期，需要续费激活。 deleting：删除中。 deleted：已删除。	running
ClusterName	string	实例名称。	milvus-test
PackageType	string	规格详情。取值范围： trial：入门版。 standard：标准版。	trial
ClusterInfo	object	实例详情。
MilvusResourceInfoList	array<object>	资源详情。
	object
ComponentType	string	组件类型。取值范围： standalone proxy mix_coordinator query index data	standalone
CuNum	integer	CU 数量。	16
Replica	integer	副本数量。	1
DiskSize	integer	磁盘大小。	100
DiskType	string	磁盘类型。	essd
IntranetUrl	string	内网地址。	c-123xxx-internal.milvus.aliyuncs.com
InternetUrl	string	公网地址。	c-123xxx.milvus.aliyuncs.com
TotalCuNum	integer	CU 数量。	24
TotalDiskSize	integer	磁盘总量。	500
ProxyPort	integer	Proxy 端口。	19530
AttuPort	integer	Attu 组件端口。	3000
VpcId	string	专有网络 ID。	vpc-123xxx
VswId	string	交换机 ID。	vsw-123xxx
SgId	string	安全组 ID。	sg-123xxx
OpenPublicNet	boolean	是否开启公网。	true
PayType	integer	付费类型。取值范围： 0：按量付费。 1：包年包月。	1
ProductCode	string	商品 Code	milvus_milvuspre_public_cn
ResourceGroupId	string	资源组 id	rg-123xxx
NodeType	string	节点类型	perf
AutoBackup	boolean	是否自动备份	true
Tags	array<object>	tag 信息
	object	tag 信息
Key	string	tag 的 key	key1
Value	string	tag 的 value	value1
Total	integer	总数。	15
AccessDeniedDetail	string	权限校验失败详情。	{ "PolicyType": "AccountLevelIdentityBasedPolicy", "AuthPrincipalOwnerId": "xxxx", "EncodedDiagnosticMessage": "xxxx", "AuthPrincipalType": "SubUser", "AuthPrincipalDisplayName": "xxxx", "NoPermissionType": "ImplicitDeny", "AuthAction": "milvus:xxxx" }

示例

正常返回示例

JSON格式

{
  "HttpStatusCode": 200,
  "RequestId": "ABCD-1234-5678-EFGH",
  "Success": true,
  "ErrCode": "Instance.NotFound",
  "ErrMessage": "Failed to find instance c-123xxx",
  "Data": [
    {
      "InstanceId": "c-123xxx",
      "BeginTime": 1718608505000,
      "RunningTime": 536611,
      "ExpireTime": 1721232000000,
      "RegionId": "cn-beijing",
      "ZoneId": "cn-beijing-g",
      "InstanceStatus": "running",
      "ClusterName": "milvus-test",
      "PackageType": "trial",
      "ClusterInfo": {
        "MilvusResourceInfoList": [
          {
            "ComponentType": "standalone",
            "CuNum": 16,
            "Replica": 1,
            "DiskSize": 100,
            "DiskType": "essd"
          }
        ],
        "IntranetUrl": "c-123xxx-internal.milvus.aliyuncs.com",
        "InternetUrl": "c-123xxx.milvus.aliyuncs.com",
        "TotalCuNum": 24,
        "TotalDiskSize": 500,
        "ProxyPort": 19530,
        "AttuPort": 3000
      },
      "VpcId": "vpc-123xxx",
      "VswId": "vsw-123xxx",
      "SgId": "sg-123xxx",
      "OpenPublicNet": true,
      "PayType": 1,
      "ProductCode": "milvus_milvuspre_public_cn",
      "ResourceGroupId": "rg-123xxx",
      "NodeType": "perf",
      "AutoBackup": true,
      "Tags": [
        {
          "Key": "key1",
          "Value": "value1"
        }
      ]
    }
  ],
  "Total": 15,
  "AccessDeniedDetail": "{     \"PolicyType\": \"AccountLevelIdentityBasedPolicy\",     \"AuthPrincipalOwnerId\": \"xxxx\",     \"EncodedDiagnosticMessage\": \"xxxx\",     \"AuthPrincipalType\": \"SubUser\",     \"AuthPrincipalDisplayName\": \"xxxx\",     \"NoPermissionType\": \"ImplicitDeny\",     \"AuthAction\": \"milvus:xxxx\" }"
}

错误码

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

变更历史

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