API概览

更新时间:
本产品(Milvus向量检索/2023-10-12)的OpenAPI采用ROA签名风格,签名细节参见签名机制说明我们已经为开发者封装了常见编程语言的SDK,开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求,可通过签名机制进行自签名对接。由于自签名细节非常复杂,需花费 5个工作日左右。因此建议加入我们的服务钉钉群(78410016550),在专家指导下进行签名对接。
在使用API前,您需要准备好身份账号及访问密钥(AccessKey),才能有效通过客户端工具(SDK、CLI等)访问API。细节请参见获取AccessKey

实例管理

API标题API概述
UpdateInstanceName修改实例名称修改实例名称。
GetInstanceDetail获取实例详情获取单个实例的详细信息。
ListInstances获取实例列表获取当前账号下Milvus实例列表。

实例配置

API标题API概述
ModifyInstanceConfig更新实例配置更新Milvus各个组件的配置参数。
DescribeInstanceConfigs获取实例配置信息获取Milvus各个组件自定义配置的信息。

实例安全

API标题API概述
DescribeAccessControlList获取公网访问白名单获取Milvus实例公网访问IP白名单。
UpdatePublicNetworkStatus开启/关闭公网访问开启/关闭Milvus公网访问能力。
UpdateAccessControlList设置公网访问白名单设置Milvus公网访问IP白名单。