Method 与 URL
别名可以是一个简短的字符串,方便标识和访问对应的集合。通常,别名会替换 Collection 或 CollectionView 的名称用于业务切换等场景。
为 Base 数据库的 Collection 指定别名:
POST https://{实例访问 IP 地址}:{实例网络端口}/alias/set
为 AI 类数据库的 CollectionView 指定别名:
POST https://{实例访问 IP 地址}:{实例网络端口}/ai/alias/set
接口约束
DB 和 Collection 级别(包含 AI 类数据库的 CollectionView )的 drop 操作会同时删除库表下的所有别名。
Document 与 DocumentSet 层级的访问优先访问别名,其余级别仅支持原 Collection 或 CollectionView 名操作。
集合或集合视图的别名可以和名称重复,一个集合或集合视图的多个别名之间不能重复。
说明:
通过集合的别名做业务迁移时,仅需通过 /alias/set 或 /ai/alias/set 接口将同一别名指向新的集合,别名与集合的映射关系将自动更新为新集合,可直接通过别名访问新集合。
使用示例
注意:
如下示例 api_key 的值 A5VOgsMpGWJhUI0WmUbY******************** 与 10.0.X.X,需要分别替换为具体实例的 API Key 以及访问地址。
curl -i -X POST \\-H 'Content-Type: application/json' \\-H 'Authorization: Bearer account=root&api_key=A5VOgsMpGWJhUI0WmUbY********************' \\http://10.0.X.X:80/alias/set \\-d '{"database": "db-test","collection": "book-emb","alias": "alias-book-emb"}'
执行成功,返回消息,如下所示。
{"code":0,"msg":"operation success","affectedCount":1}
curl -i -X POST \\-H 'Content-Type: application/json' \\-H 'Authorization: Bearer account=root&api_key=A5VOgsMpGWJhUI0WmUbY********************' \\http://10.0.X.X:80/ai/alias/set \\-d '{"database": "db-test-ai","collectionView": "coll-ai-files","alias": "alias-coll-ai-files"}'
执行成功,返回消息,如下所示。
{"code":0,"msg":"operation success","requestId: 46ef397c7e059c1769bcef**********","affectedCount":1}
请求参数
参数 | 是否必选 | 参数含义 | 配置方法及要求 |
database | 是 | 指定需创建别名的 Collection 或 CollectionView 所对应的 Database 名。 | |
collection | 是 | 为 Collection 设置别名,指定需创建别名的 Collection 名。 | |
collectionView
| 是 | 为 CollectionView 设置别名,指定需创建别名的 CollectionView 名。 | |
alias | 是 | 设置别名。 | 别名要求如下: 只能使用英文字母,数字,下划线_、中划线-,并以英文字母开头。 长度要求:[1,128]。 |
响应消息
{"code": 0,"msg": "operation success","affectedCount": 1}
参数名 | 参数含义 |
affectedCount | 创建别名的集合数量。 |