使用ListInstancesV2根据集群ID或名称搜索集群实例-向量检索服务 Milvus 版-阿里云-向量检索服务 Milvus 版(Milvus)-阿里云帮助中心

根据集群ID或者名称搜索集群

调试

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

调试

授权信息

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

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

操作

访问级别

资源类型

条件关键字

关联操作

milvus:ListInstancesV2

list

*Instance

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

无

请求语法

GET /webapi/instance/list HTTP/1.1

请求参数

名称	类型	必填	描述	示例值
RegionId	string	否	地域	cn-beijing
instanceName	string	否	集群名称	milvus-test
instanceId	string	否	集群 id	c-123xxx
pageNumber	integer	否	页码	1
pageSize	integer	否	分页大小	10
resourceGroupId	string	否	资源组 id	rg-123xxx
tag	array<object>	否	标签列表，JSON 格式。
	object	否	标签列表，JSON 格式。
key	string	否	标签键	k1
value	string	否	标签值	v1
maxResults	integer	否	一次获取的最大记录数	100
nextToken	string	否	下一次请求的分页 token（暂时没有启用）。	None

返回参数

名称	类型	描述	示例值
	object
RequestId	string	请求唯一号	ABCD-1234-5678-EFGH
success	boolean	请求是否成功	true
total	integer	总数	15
instances	array	实例列表
	InstanceDetail	实例信息
nextToken	string	分页 token。（暂时没有启用）	None
maxResults	integer	一次获取的最大记录数	20

示例

正常返回示例

JSON格式

{
  "RequestId": "ABCD-1234-5678-EFGH",
  "success": true,
  "total": 15,
  "instances": [
    {
      "instanceName": "milvus-test",
      "instanceId": "c-xxx",
      "regionId": "cn-beijing",
      "zoneId": "cn-hangzhou-i",
      "status": "running",
      "paymentType": "PayAsYouGo",
      "resourceGroupId": "rg-aek3dcgyq7pnqwa",
      "vpcId": "vpc-xxx",
      "createTime": "2025-04-27T02:04:25Z",
      "runningTime": 1,
      "expireTime": "2025-04-27T02:04:25Z\n",
      "dbVersion": "2.5",
      "orderId": "4751",
      "autoBackup": true,
      "configuration": "rootCoord:\n    maxDatabaseNum: 64 # Maximum number of database\n    maxPartitionNum: 4096 ",
      "ha": true,
      "multiZoneMode": "Single",
      "encrypted": false,
      "kmsKeyId": "key-xxx",
      "vSwitchIds": [
        {
          "zoneId": "cn-hangzhou-i",
          "vswId": "vsw-xxx"
        }
      ],
      "securityGroupIds": [
        "sg-xxx"
      ],
      "tags": [
        {
          "key": "k1",
          "value": "v1"
        }
      ],
      "components": [
        {
          "type": "data",
          "replica": 1,
          "cuNum": 4,
          "cuType": "general",
          "diskSizeType": "Normal",
          "payType": "postPaid",
          "dataDisk": {
            "enabled": true,
            "storageClass": "alicloud-disk-essd-pl1",
            "size": 100,
            "performanceLevel": "PL1"
          },
          "podsList": [
            {
              "podId": "milvus-milvus-standalone-123abc456-7defg",
              "podName": "milvus-milvus-standalone-123abc456-7defg"
            }
          ]
        }
      ]
    }
  ],
  "nextToken": "None",
  "maxResults": 20
}

错误码

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

变更历史

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