本产品（
Milvus向量检索/2023-10-12）的OpenAPI采用ROA签名风格，签名细节参见签名机制说明。我们已经为开发者封装了常见编程语言的SDK，开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求，可通过签名机制进行自签名对接。由于自签名细节非常复杂，需花费 5个工作日左右。因此建议加入我们的服务钉钉群（11370001915），在专家指导下进行签名对接。在使用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白名单。 |