API概览
更新时间：
复制为 MD 格式
API标准及多语言预置SDK
本产品（milvus/2023-10-12）的OpenAPI采用ROA签名风格。我们已经为开发者封装了常见编程语言的SDK，开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求，可通过签名机制进行自签名对接。由于自签名细节非常复杂，需花费 5个工作日左右。因此建议加入我们的服务钉钉群（147535001692），在专家指导下进行签名对接。
在使用API前，您需要准备好身份账号及访问密钥（AccessKey），才能有效通过客户端工具（SDK、CLI等）访问API。细节请参见获取AccessKey。
自定义签名场景
若您的业务场景有特殊需求，需通过自签名方式对接 API，建议优先咨询我们的技术支持团队（服务钉钉群：147535001692），获取专业指导以确保高效接入。
账号与安全准备
阿里云账号具备对所有资源的完全管理权限。一旦 AccessKey 泄露，所有相关资源都将面临未经授权访问的风险。为确保安全，建议创建一个仅具备 API 访问权限的RAM用户并配置其 AccessKey，同时基于最小权限原则 (PoLP) 配置 RAM 策略。仅在明确需要阿里云账号权限的特定场景下，才使用阿里云账号。
实例管理
|
API |
标题 |
API概述 |
| CreateInstance | 创建集群实例 | 创建集群实例 |
| ListInstancesV2 | 获取实例列表 | 根据集群ID或者名称搜索集群 |
| UpdateInstanceName | 修改实例名称 | 修改实例名称。 |
实例配置
|
API |
标题 |
API概述 |
| ModifyInstanceConfig | 更新实例配置 | 更新Milvus各个组件的配置参数。 |
| DescribeInstanceConfigs | 获取实例配置信息 | 获取Milvus各个组件自定义配置的信息。 |
实例安全
|
API |
标题 |
API概述 |
| DescribeAccessControlList | 获取公网访问白名单 | 获取Milvus实例公网访问IP白名单。 |
| UpdatePublicNetworkStatus | 开启/关闭公网访问 | 开启/关闭Milvus公网访问能力。 |
| UpdateAccessControlList | 设置公网访问白名单 | 设置Milvus公网访问IP白名单。 |
| CreateAclGroup | 创建分组白名单 | 创建白名单分组 |
| UpdateAclGroupCidrs | 修改分组内的白名单 | 修改分组内的白名单 |
| ListAclGroups | 展示分组白名单 | 获取当前用户下的分组信息和内容 |
其他
|
API |
标题 |
API概述 |
| CreateDefaultRole | 创建服务角色 | 创建Milvus访问其它云产品所需要的服务角色 |
| ChangeResourceGroup | 修改资源组 | 资源转组 |
| DeleteInstance | 删除实例 | 删除实例 |
| GetInstance | 获取实例详情 | 获取实例详情 |
| GetInstanceDetail | 获取实例详情 | 获取单个实例的详细信息。 |
| ListInstances | 获取实例列表 | 获取当前账号下Milvus实例列表。 |
| TagResources | 给指定资源打标签 | 打标 |
| UnTagResources | 删除资源标签 | 删除标签 |
| UpdateInstance | 更新实例 | 更新实例 |
该文章对您有帮助吗？