通过API获取Milvus实例详情

最新推荐文章于 2025-07-17 09:00:00 发布
原创 最新推荐文章于 2025-07-17 09:00:00 发布 · 1.4k 阅读 · 12 ·
CC 4.0 BY-SA版权
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
文章标签：

#数据库 #阿里云 #网络 #milvus

GetInstanceDetail - 获取实例详情

获取单个实例的详细信息。

调试

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

​编辑调试

授权信息

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

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

    acs:milvus:{#regionId}:{#accountId}:instance/{#InstanceId}
  • 无
无

请求语法

POST /webapi/cluster/detail

请求参数

名称类型必填描述示例值
InstanceIdstring否

实例 ID。

c-123xxx

返回参数

名称类型描述示例值
object
HttpStatusCodeinteger

HTTP 请求状态码。

200
RequestIdstring

请求 ID。

ABCD-1234-5678-EFGH
Successboolean

请求是否成功。

true
ErrCodestring

错误码。

Instance.NotFound
ErrMessagestring

错误信息。

Failed to find instance c-123xxx
Dataobject

返回数据。

InstanceIdstring

实例 ID。

c-123xxx
BeginTimelong

开始时间。

1716863508000
RunningTimelong

运行时间。

1743679
ExpireTimelong

过期时间。

1721664000000
RegionIdstring

地域。

cn-beijing
ZoneIdstring

可用区。

cn-beijing-g
InstanceStatusstring

实例状态。取值范围：

  • creating：创建中。
  • running：运行中。
  • updating：升级中。集群升降配、配置变更和开关公网等。
  • disable：不可用。集群已经过期，需要续费激活。
  • deleting：删除中。
  • deleted：已删除。
running
PackageTypestring

规格详情。取值范围：

  • trial：入门版。
  • standard：标准版。
standard
ClusterInfoobject

实例详情。

MilvusResourceInfoListarray<object>

资源详情。

object
ComponentTypestring

组件类型。取值范围：

  • standalone
  • proxy
  • mix_coordinator
  • query
  • index
  • data
standalone
CuNuminteger

CU 数量。

8
Replicainteger

副本数量。

2
DiskSizeinteger

磁盘大小。

100
DiskTypestring

磁盘类型。

essd
IntranetUrlstring

内网地址。

c-123xxx-internal.milvus.aliyuncs.com
InternetUrlstring

公网地址。

c-123xxx-.milvus.aliyuncs.com
TotalCuNuminteger

总 CU 数量。

24
TotalDiskSizeinteger

总磁盘数量。

500
ProxyPortinteger

Proxy 端口。

19530
AttuPortinteger

Attu 组件端口。

3000
OssStorageTimestamplong

OSS 存储指标时间。

1718604000000
OssStorageSizestring

OSS 存储数据大小。

125.15 GB
VpcIdstring

专有网络 ID。

vpc-123xxx
VswIdstring

交换机 ID。

vsw-123xxx
SgIdstring

安全组 ID。

sg-123xxx
OpenPublicNetboolean

是否开启公网。

true
ClusterNamestring

实例名称。

aliyun-test
PayTypeinteger

付费类型。取值范围：

  • 0：按量付费。
  • 1：包年包月。
1
BucketNamestring

Bucket 名称。

milvus-test
BucketPathstring

Bucket 地址。

https://oss.console.aliyun.com/bucket/oss-cn-beijing/xxxx/object?spm=a2cug.25127996.0.0.577990370Ebsqt&path=milvus-c-123xxxx
Versionstring

内核版本。

2.4
AclIdstring

公网访问控制 AclId。

acl-123xxx
UserConfigstring

用户自定义配置。

dataCoord:\n segment:\n maxSize: 1024
TemplateVersionstring

软件栈版本。

2.4.1-1.0-0.0.1
ProductCodestring

商品 Code。

milvus_milvuspre_public_cn
ResourceGroupIdstring

资源组 id

rg-123xxx
AccessDeniedDetailstring

权限校验失败详情。

{ "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": 1716863508000,
    "RunningTime": 1743679,
    "ExpireTime": 1721664000000,
    "RegionId": "cn-beijing",
    "ZoneId": "cn-beijing-g",
    "InstanceStatus": "running",
    "PackageType": "standard",
    "ClusterInfo": {
      "MilvusResourceInfoList": [
        {
          "ComponentType": "standalone",
          "CuNum": 8,
          "Replica": 2,
          "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,
      "OssStorageTimestamp": 1718604000000,
      "OssStorageSize": "125.15 GB"
    },
    "VpcId": "vpc-123xxx",
    "VswId": "vsw-123xxx",
    "SgId": "sg-123xxx",
    "OpenPublicNet": true,
    "ClusterName": "aliyun-test",
    "PayType": 1,
    "BucketName": "milvus-test",
    "BucketPath": "https://oss.console.aliyun.com/bucket/oss-cn-beijing/xxxx/object?spm=a2cug.25127996.0.0.577990370Ebsqt&path=milvus-c-123xxxx",
    "Version": "2.4",
    "AclId": "acl-123xxx",
    "UserConfig": "dataCoord:\\n  segment:\\n    maxSize: 1024",
    "TemplateVersion": "2.4.1-1.0-0.0.1",
    "ProductCode": "milvus_milvuspre_public_cn",
    "ResourceGroupId": "rg-123xxx",
    "MeasureConfig": {
      "ProxyNodeCuNum": 0,
      "IndexNodeCuNum": 0,
      "QueryNodeCuNum": 0,
      "DataNodeCuNum": 0,
      "MixCoodinatorNodeCuNum": 0,
      "IndexNodeReplica": 0,
      "QueryNodeReplica": 0,
      "DataNodeReplica": 0,
      "MixCoodinatorNodeReplica": 0,
      "ProxyNodeReplica": 0
    }
  },
  "AccessDeniedDetail": "{     \"PolicyType\": \"AccountLevelIdentityBasedPolicy\",     \"AuthPrincipalOwnerId\": \"xxxx\",     \"EncodedDiagnosticMessage\": \"xxxx\",     \"AuthPrincipalType\": \"SubUser\",     \"AuthPrincipalDisplayName\": \"xxxx\",     \"NoPermissionType\": \"ImplicitDeny\",     \"AuthAction\": \"milvus:xxxx\" }"
}

ListInstances - 获取实例列表

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

调试

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

​编辑调试

授权信息

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

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

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

请求语法

POST /webapi/order/list

请求参数

名称类型必填描述示例值
ClusterNamestring否

实例名称。

milvus-test
ClusterIdstring否

实例 ID。

c-123xxx
PageNumberinteger否

页码。

1
PageSizeinteger否

分页大小。

10
RegionIdstring否

地域。

cn-beijing
ResourceGroupIdstring否

资源组 id

rg-123xxx

返回参数

名称类型描述示例值
object
HttpStatusCodeinteger

HTTP 请求状态码。

200
RequestIdstring

请求 ID。

ABCD-1234-5678-EFGH
Successboolean

请求是否成功。

true
ErrCodestring

错误码。

Instance.NotFound
ErrMessagestring

错误信息。

Failed to find instance c-123xxx
Dataarray<object>

返回数据。

object
InstanceIdstring

实例 ID。

c-123xxx
BeginTimelong

开始时间。

1718608505000
RunningTimeinteger

运行时间。

536611
ExpireTimelong

过期时间。

1721232000000
RegionIdstring

地域。

cn-beijing
ZoneIdstring

可用区。

cn-beijing-g
InstanceStatusstring

实例状态。取值范围：

  • creating：创建中。
  • running：运行中。
  • updating：升级中。集群升降配、配置变更和开关公网等。
  • disable：不可用。集群已经过期，需要续费激活。
  • deleting：删除中。
  • deleted：已删除。
running
ClusterNamestring

实例名称。

milvus-test
PackageTypestring

规格详情。取值范围：

  • trial：入门版。
  • standard：标准版。
trial
ClusterInfoobject

实例详情。

MilvusResourceInfoListarray<object>

资源详情。

object
ComponentTypestring

组件类型。取值范围：

  • standalone
  • proxy
  • mix_coordinator
  • query
  • index
  • data
standalone
CuNuminteger

CU 数量。

16
Replicainteger

副本数量。

1
DiskSizeinteger

磁盘大小。

100
DiskTypestring

磁盘类型。

essd
IntranetUrlstring

内网地址。

c-123xxx-internal.milvus.aliyuncs.com
InternetUrlstring

公网地址。

c-123xxx.milvus.aliyuncs.com
TotalCuNuminteger

CU 数量。

24
TotalDiskSizeinteger

磁盘总量。

500
ProxyPortinteger

Proxy 端口。

19530
AttuPortinteger

Attu 组件端口。

3000
VpcIdstring

专有网络 ID。

vpc-123xxx
VswIdstring

交换机 ID。

vsw-123xxx
SgIdstring

安全组 ID。

sg-123xxx
OpenPublicNetboolean

是否开启公网。

true
PayTypeinteger

付费类型。取值范围：

  • 0：按量付费。
  • 1：包年包月。
1
ProductCodestring

商品 Code

milvus_milvuspre_public_cn
ResourceGroupIdstring

资源组 id

rg-123xxx
Totalinteger

总数。

15
AccessDeniedDetailstring

权限校验失败详情。

{ "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"
    }
  ],
  "Total": 15,
  "AccessDeniedDetail": "{     \"PolicyType\": \"AccountLevelIdentityBasedPolicy\",     \"AuthPrincipalOwnerId\": \"xxxx\",     \"EncodedDiagnosticMessage\": \"xxxx\",     \"AuthPrincipalType\": \"SubUser\",     \"AuthPrincipalDisplayName\": \"xxxx\",     \"NoPermissionType\": \"ImplicitDeny\",     \"AuthAction\": \"milvus:xxxx\" }"
}

 

UpdateInstanceName - 修改实例名称

修改实例名称。

调试

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

​编辑调试

授权信息

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

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

    acs:milvus:{#regionId}:{#accountId}:instance/{#InstanceId}
  • 无
无

请求语法

POST /webapi/cluster/update_name

请求参数

名称类型必填描述示例值
ClusterNamestring是

实例名称。

milvus-test
InstanceIdstring是

实例 ID。

c-123xxx

返回参数

名称类型描述示例值
object
HttpStatusCodeinteger

HTTP 请求状态码。

200
RequestIdstring

请求 ID。

ABCD-1234-5678-EFGH
Successboolean

请求是否成功。

true
ErrCodestring

错误码。

Instance.NotFound
ErrMessagestring

错误信息。

Failed to find instance c-123xxx
Databoolean

返回数据。

true
AccessDeniedDetailstring

权限校验失败详情。

{ "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": true,
  "AccessDeniedDetail": "{     \"PolicyType\": \"AccountLevelIdentityBasedPolicy\",     \"AuthPrincipalOwnerId\": \"xxxx\",     \"EncodedDiagnosticMessage\": \"xxxx\",     \"AuthPrincipalType\": \"SubUser\",     \"AuthPrincipalDisplayName\": \"xxxx\",     \"NoPermissionType\": \"ImplicitDeny\",     \"AuthAction\": \"milvus:xxxx\" }"
}

 

segwyang
关注
milvus可视化，增删查改api，元数据mysql理解
qq_15821487的博客
02-23 2579
官网：https://milvus.io/ 安装文档：https://milvus.io/cn/docs/v1.1.1/milvus_docker-cpu.md 可视化：https://zilliz.com/products/em CURD API文档来表示 增加:Create 修改:Update 查找:Read 删除:Delete 外 代码文档api:https://milvus.io/cn/api-reference/pymilvus/v1.1.2/api.html 函数说明：https://milvu
Milvus
forths的博客
07-27 586
架构图： https://milvus.io/docs/v2.0.0/architecture_overview.md Architecture overview Milvus operates on a shared-disk architecture that separates storage from computing and supports horizontally scalable computing nodes. 数据存储和计算分开，并且支持计算节点的水平扩展。 Overall .
API请求执行流程_milvus源码解析
shulu的专栏
11-13 235
为什么会是PreExecute()、Execute()、PostExecute()这个顺序，这个就需要阅读task调度器的源码了。会依次执行cct的PreExecute()、Execute()、PostExecute()方法。PostExecute()用来task完成后执行的动作，一般直接返回nil，也就是什么都不做。这样PreExecute()、Execute()、PostExecute()的逻辑就搞清楚了。这里再思考另一个问题，processTask()是由谁调用的，调度器是什么时候启动的。
通过API进行Milvus实例配置
10-14 2394
更新Milvus各个组件的配置参数。
5.pymilvus基本api使用
卷土的博客
03-24 238
【代码】6.pymilvus基本api使用。
Milvus 快速入门
沛哥儿的专栏
05-15 4913
Milvus Java SDK 是一个开源项目，其源代码托管在 GitHub 上。它允许 Java 开发者通过编写 Java 代码与 Milvus 进行交互，执行包括数据插入、查询、搜索、删除等操作。Milvus 的快速入门包括了基本概念的理解、一个简单的示例操作以及 Milvus API 的概览。通过这些步骤，你可以开始使用 Milvus 进行向量数据的存储和搜索。Milvus 的设计旨在简化向量数据库的使用，使其成为机器学习和人工智能应用中的有力工具。
milvus search api的数据结构
shulu的专栏
04-07 752
此api的功能是向量相似度搜索(vector similarity search)
milvus云托管，如何通过API获取数据库中的内容并在Android中使用
04-09
好的，我现在需要帮助用户了解如何通过API从Milvus云托管数据库获取内容并在Android应用中使用。首先，我应该先理解Milvus的基本概念和它提供的API类型。Milvus是一个开源的向量数据库，常用于处理非结构化数据，...
Milvus 全面解析
FeelTouch Labs
05-14 1093
Milvus是一种以猛禽命名的开源高性能矢量数据库，由Zilliz开发并捐赠给Linux基金会。它支持从本地到大规模分布式系统的多种部署模式，适用于处理非结构化数据，如文本、图像和音频。Milvus通过嵌入技术将非结构化数据转换为数值向量，实现快速搜索和分析。其设计优化了硬件性能，支持多种搜索算法和数据类型，确保高效和可扩展性。Milvus的云原生架构和高度解耦的系统设计使其能够轻松扩展，支持大规模数据处理。此外，Milvus提供了丰富的API和SDK，以及多种高级功能，如多租户支持、数据隔离和人工智能集成
深入探索 Milvus：处理大规模嵌入向量的利器
akhfuiigabv的博客
10-08 438
Milvus为处理和查询大规模向量提供了便捷的工具。通过结合使用Langchain和OpenAI的工具，开发者可以构建强大的应用。如果想进一步深入了解，可以参考以下资源。
使用Milvus和OpenAI实现RAG（检索增强生成）的实践指南
bavDHAUO的博客
02-19 388
RAG（检索增强生成）是一种结合了信息检索和文本生成的AI技术，能够在生成自然语言文本时利用外部知识库提供更准确的上下文。Milvus作为一个开源的向量数据库，能够快速存储和检索大规模向量数据，是实现RAG的理想选择。而OpenAI提供的强大生成能力可以完美补充Milvus的数据检索功能。
打造智能问答系统：使用Milvus和OpenAI实现RAG
akhfuiigabv的博客
11-08 839
通过结合Milvus和OpenAI，我们可以创建一个强大的问答系统。结合RAG模型的优点，您可以显著提升信息检索和生成的智能化水平。Milvus官方文档OpenAI API文档。
别再死磕 Milvus API 了！我们把这玩意儿搞成了 SQL 操作
云原生智能数据管理平台
07-03 765
在 AI 数据库领域，Milvus 是一个高性能的开源向量数据库，专为处理大规模向量数据和高效相似性搜索而设计，功能很好很强大。由于 Milvus API 调用的复杂性，对于刚接触的开发者来说，是有一定的学习成本的。比如翻 API 文档大半个小时，就想查个向量相似度；连个数据库还需要调 pymilvus.connect()......最终，老板霸气拍桌：把它 SQL 化！让 0 基础的程序猿也能直接上手！然后，NineData 的 SQL 窗口（Milvus 版）就这么华丽丽地登场了。
milvus Delete API流程源码分析
shulu的专栏
02-22 1380
delete api根据expr走simpleDelete还是complexDelete。complexDelete最终也会转化为simpleDelete。
用 Neo4j + Milvus 构建智能 API 匹配系统（支持多租户与私有向量）
最新发布
优秀码农的博客
07-17 532
适用于模块化能力调度 / 私有化大模型接入 / 多租户语义服务的通用架构。结合 NLP、知识图谱与向量搜索，构建智能、高可控的 API 管理调度系统。
Milvus 开发者专栏｜向量检索的应用
ZILLIZ
07-28 3201
作者：侯宇，业务架构师，Milvus 社区用户在深度学习的浪潮下，无论是文本、语音、图像、时间序列还是消费者特征，都可以用一组形如 [0.6, 0.3, 0.7,......0.19] ...
milvus数据库-连接
qq_43814415的博客
11-16 3150
端口 19530 用于 gRPC 和 RESTful API。这是您使用不同 Milvus SDK 或 HTTP 客户端连接到 Milvus 服务器时的默认端口。端口 9091 用于 Kubernetes 内的指标收集、pprof 分析和运行状况探测。1.连接到数据库服务器。
Milvus 最佳实践之如何设置API参数 （3）
ZILLIZ
02-26 3071
在上文《Milvus 最佳实践之如何设置系统配置项 （2）》中，针对Milvus 0.6.0版本的关键系统配置项给予了详细说明。本文针对Milvus 0.6.0版本的API...
向量数据库：Milvus
m0_37559973的博客
06-05 1408
Milvus 是一个开源的高性能向量数据库，旨在为嵌入式相似性搜索和人工智能应用提供强大支持。
评论
成就一亿技术人!
拼手气红包6.0元
还能输入1000个字符
 
红包 添加红包
表情包 插入表情
表情包 代码片
 条评论被折叠 查看
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值