Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

update docs #986

Merged
merged 1 commit into from
Jan 22, 2025
Merged

update docs #986

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 10 additions & 2 deletions API_Reference_MDX/milvus-restful/v2.5.x/v2/Alias (v2)/Alter.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,20 @@
---
displayed_sidebar: restfulSidebar
sidebar_positition: 49
sidebar_positition: 59
slug: /restful/Alter
title: "Alter Alias | RESTful"
description: "This operation reassigns the alias of one collection to another. | RESTful"
hide_table_of_contents: true
sidebar_label: "Alter Alias"
sidebar_custom_props: { badges: ['post']}
keywords:
- zilliz cloud
- zilliz
- cloud
- "Alter Alias"
- "post"
- RESTful
- API
---

# Alter Alias
Expand All @@ -15,6 +23,6 @@ import RestSpecs from '@site/src/components/RestSpecs';

<RestSpecs specs={specs} endpoint={endpoint} method={method} target="milvus" lang="en-US" />

export const specs = {"summary":"Alter Alias","deprecated":false,"description":"This operation reassigns the alias of one collection to another.","x-i18n":{"zh-CN":{"summary":"修改 Alias","description":"本接口将已分配给某 Collection 的别名重新分配给另一个 Collection。"}},"tags":["Alias Operations (V2)"],"parameters":[{"name":"Authorization","in":"header","description":"The authentication token should be <include target=\"zilliz\">an API key with appropriate privileges or </include>a pair of colon-joined username and password, like `username:password`.","required":true,"example":"Bearer {{TOKEN}}","schema":{"type":"string"},"x-i18n":{"zh-CN":{"description":"认证令牌，应为<include target=\"zilliz\">具备适当权限的 API 密钥或</include>用冒号分隔的用户名和密码，如 `username:password`。"}}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"dbName":{"type":"string","description":"The name of the database to which the collection belongs.","x-i18n":{"zh-CN":{"description":"数据库名称。"}},"x-include-target":["milvus"]},"collectionName":{"type":"string","description":"The name of the target collection to reassign an alias to.","x-i18n":{"zh-CN":{"description":"重新分配后当前别名所指向的 Collection 名称。"}}},"aliasName":{"type":"string","description":"The alias of the collection. ","x-i18n":{"zh-CN":{"description":"待重新分配的别名。"}}}},"required":["aliasName","collectionName"]},"example":{"aliasName":"bob","collectionName":"custom_setup_indexed"}}}},"responses":{"200":{"description":"Returns an empty object or an error message.","x-i18n":{"zh-CN":{"description":"返回一个空对象或一条错误消息。"}},"content":{"application/json":{"schema":{"anyOf":[{"x-tab-label":"success","description":"A success response","x-i18n":{"zh-CN":{"description":"成功响应。"}},"x-i18n-langs":["zh-CN"],"type":"object","properties":{"code":{"description":"Response code.","x-i18n":{"zh-CN":{"description":"响应码。"}},"type":"integer","example":0},"data":{"type":"object","properties":{},"description":"Response payload which is an empty object.","x-i18n":{"zh-CN":{"description":"响应载荷。为空对象。"}}}}},{"x-tab-label":"failure","description":"Returns an error message.","x-i18n":{"zh-CN":{"description":"返回错误消息。"}},"x-i18n-langs":["zh-CN"],"type":"object","properties":{"code":{"type":"integer","description":"Response code.","x-i18n":{"zh-CN":{"description":"响应码。"}}},"message":{"type":"string","description":"Error message.","x-i18n":{"zh-CN":{"description":"错误描述。"}}}}}]},"examples":{"1":{"summary":"success","x-target-response":"OPTION 1","value":{"code":0,"data":{}}},"2":{"summary":"failure","x-target-response":"OPTION 2","value":{"code":0,"message":"The token is illegal."}}}}}}},"security":[]}
export const specs = {"summary":"Alter Alias","deprecated":false,"description":"This operation reassigns the alias of one collection to another.","x-i18n":{"zh-CN":{"summary":"修改 Alias","description":"本接口将已分配给某 Collection 的别名重新分配给另一个 Collection。"}},"tags":["Alias Operations (V2)"],"parameters":[{"name":"Authorization","in":"header","description":"The authentication token should be <include target=\"zilliz\">an API key with appropriate privileges or </include>a pair of colon-joined username and password, like `username:password`.","required":true,"example":"Bearer {{TOKEN}}","schema":{"type":"string"},"x-i18n":{"zh-CN":{"description":"认证令牌，应为<include target=\"zilliz\">具备适当权限的 API 密钥或</include>用冒号分隔的用户名和密码，如 `username:password`。"}}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"dbName":{"type":"string","description":"The name of the database to which the collection belongs.","x-i18n":{"zh-CN":{"description":"数据库名称。"}}},"collectionName":{"type":"string","description":"The name of the target collection to reassign an alias to.","x-i18n":{"zh-CN":{"description":"重新分配后当前别名所指向的 Collection 名称。"}}},"aliasName":{"type":"string","description":"The alias of the collection. ","x-i18n":{"zh-CN":{"description":"待重新分配的别名。"}}}},"required":["aliasName","collectionName"]},"example":{"aliasName":"bob","collectionName":"custom_setup_indexed"}}}},"responses":{"200":{"description":"Returns an empty object or an error message.","x-i18n":{"zh-CN":{"description":"返回一个空对象或一条错误消息。"}},"content":{"application/json":{"schema":{"anyOf":[{"x-tab-label":"success","description":"A success response","x-i18n":{"zh-CN":{"description":"成功响应。"}},"x-i18n-langs":["zh-CN"],"type":"object","properties":{"code":{"description":"Response code.","x-i18n":{"zh-CN":{"description":"响应码。"}},"type":"integer","example":0},"data":{"type":"object","properties":{},"description":"Response payload which is an empty object.","x-i18n":{"zh-CN":{"description":"响应载荷。为空对象。"}}}}},{"x-tab-label":"failure","description":"Returns an error message.","x-i18n":{"zh-CN":{"description":"返回错误消息。"}},"x-i18n-langs":["zh-CN"],"type":"object","properties":{"code":{"type":"integer","description":"Response code.","x-i18n":{"zh-CN":{"description":"响应码。"}}},"message":{"type":"string","description":"Error message.","x-i18n":{"zh-CN":{"description":"错误描述。"}}}}}]},"examples":{"1":{"summary":"success","x-target-response":"OPTION 1","value":{"code":0,"data":{}}},"2":{"summary":"failure","x-target-response":"OPTION 2","value":{"code":1800,"message":"User hasn't authenticated"}}}}}}},"security":[]}
export const endpoint = "/v2/vectordb/aliases/alter"
export const method = "post"
12 changes: 10 additions & 2 deletions API_Reference_MDX/milvus-restful/v2.5.x/v2/Alias (v2)/Create.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,20 @@
---
displayed_sidebar: restfulSidebar
sidebar_positition: 74
sidebar_positition: 84
slug: /restful/Create
title: "Create Alias | RESTful"
description: "This operation creates an alias for an existing collection. A collection can have multiple aliases, while an alias can be associated with only one collection. | RESTful"
hide_table_of_contents: true
sidebar_label: "Create Alias"
sidebar_custom_props: { badges: ['post']}
keywords:
- zilliz cloud
- zilliz
- cloud
- "Create Alias"
- "post"
- RESTful
- API
---

# Create Alias
Expand All @@ -15,6 +23,6 @@ import RestSpecs from '@site/src/components/RestSpecs';

<RestSpecs specs={specs} endpoint={endpoint} method={method} target="milvus" lang="en-US" />

export const specs = {"summary":"Create Alias","deprecated":false,"description":"This operation creates an alias for an existing collection. A collection can have multiple aliases, while an alias can be associated with only one collection.","x-i18n":{"zh-CN":{"summary":"创建 Alias","description":"本接口可以为指定 Collection 创建别名。一个 Collection 可以有多个别名，而一个别名只能对应一个 Collection。"}},"tags":["Alias Operations (V2)"],"parameters":[{"name":"Authorization","in":"header","description":"The authentication token should be <include target=\"zilliz\">an API key with appropriate privileges or </include>a pair of colon-joined username and password, like `username:password`.","required":true,"example":"Bearer {{TOKEN}}","schema":{"type":"string"},"x-i18n":{"zh-CN":{"description":"认证令牌，应为<include target=\"zilliz\">具备适当权限的 API 密钥或</include>用冒号分隔的用户名和密码，如 `username:password`。"}}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"dbName":{"type":"string","description":"The name of the database to which the collection belongs.","x-i18n":{"zh-CN":{"description":"当前 Collection 所属的数据库名称。"}},"x-include-target":["milvus"]},"collectionName":{"type":"string","description":"The name of the target collection to assign the created alias to.","x-i18n":{"zh-CN":{"description":"待创建别名的 Collection 名称。"}}},"aliasName":{"type":"string","description":"The alias of the collection. ","x-i18n":{"zh-CN":{"description":"待创建的 Collection 别名。"}}}},"required":["aliasName","collectionName"]},"example":{"aliasName":"bob","collectionName":"quick_setup"}}}},"responses":{"200":{"description":"None","content":{"application/json":{"schema":{"anyOf":[{"x-tab-label":"success","description":"A success response","x-i18n":{"zh-CN":{"description":"成功响应。"}},"x-i18n-langs":["zh-CN"],"type":"object","properties":{"code":{"description":"Response code.","x-i18n":{"zh-CN":{"description":"响应码。"}},"type":"integer","example":0},"data":{"type":"object","properties":{},"description":"Response payload which is an empty object.","x-i18n":{"zh-CN":{"description":"响应载荷。为空对象。"}}}}},{"x-tab-label":"failure","description":"Returns an error message.","x-i18n":{"zh-CN":{"description":"返回错误消息。"}},"x-i18n-langs":["zh-CN"],"type":"object","properties":{"code":{"type":"integer","description":"Response code.","x-i18n":{"zh-CN":{"description":"响应码。"}}},"message":{"type":"string","description":"Error message.","x-i18n":{"zh-CN":{"description":"错误描述。"}}}}}]},"examples":{"1":{"summary":"success","x-target-response":"OPTION 1","value":{"code":0,"data":{}}},"2":{"summary":"failure","x-target-response":"OPTION 2","value":{"code":1802,"message":"reason for failure"}}}}}}},"security":[]}
export const specs = {"summary":"Create Alias","deprecated":false,"description":"This operation creates an alias for an existing collection. A collection can have multiple aliases, while an alias can be associated with only one collection.","x-i18n":{"zh-CN":{"summary":"创建 Alias","description":"本接口可以为指定 Collection 创建别名。一个 Collection 可以有多个别名，而一个别名只能对应一个 Collection。"}},"tags":["Alias Operations (V2)"],"parameters":[{"name":"Authorization","in":"header","description":"The authentication token should be <include target=\"zilliz\">an API key with appropriate privileges or </include>a pair of colon-joined username and password, like `username:password`.","required":true,"example":"Bearer {{TOKEN}}","schema":{"type":"string"},"x-i18n":{"zh-CN":{"description":"认证令牌，应为<include target=\"zilliz\">具备适当权限的 API 密钥或</include>用冒号分隔的用户名和密码，如 `username:password`。"}}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"dbName":{"type":"string","description":"The name of the database to which the collection belongs.","x-i18n":{"zh-CN":{"description":"当前 Collection 所属的数据库名称。"}}},"collectionName":{"type":"string","description":"The name of the target collection to assign the created alias to.","x-i18n":{"zh-CN":{"description":"待创建别名的 Collection 名称。"}}},"aliasName":{"type":"string","description":"The alias of the collection. ","x-i18n":{"zh-CN":{"description":"待创建的 Collection 别名。"}}}},"required":["aliasName","collectionName"]},"example":{"aliasName":"bob","collectionName":"quick_setup"}}}},"responses":{"200":{"description":"None","content":{"application/json":{"schema":{"anyOf":[{"x-tab-label":"success","description":"A success response","x-i18n":{"zh-CN":{"description":"成功响应。"}},"x-i18n-langs":["zh-CN"],"type":"object","properties":{"code":{"description":"Response code.","x-i18n":{"zh-CN":{"description":"响应码。"}},"type":"integer","example":0},"data":{"type":"object","properties":{},"description":"Response payload which is an empty object.","x-i18n":{"zh-CN":{"description":"响应载荷。为空对象。"}}}}},{"x-tab-label":"failure","description":"Returns an error message.","x-i18n":{"zh-CN":{"description":"返回错误消息。"}},"x-i18n-langs":["zh-CN"],"type":"object","properties":{"code":{"type":"integer","description":"Response code.","x-i18n":{"zh-CN":{"description":"响应码。"}}},"message":{"type":"string","description":"Error message.","x-i18n":{"zh-CN":{"description":"错误描述。"}}}}}]},"examples":{"1":{"summary":"success","x-target-response":"OPTION 1","value":{"code":0,"data":{}}},"2":{"summary":"failure","x-target-response":"OPTION 2","value":{"code":1800,"message":"User hasn't authenticated"}}}}}}},"security":[]}
export const endpoint = "/v2/vectordb/aliases/create"
export const method = "post"
12 changes: 10 additions & 2 deletions API_Reference_MDX/milvus-restful/v2.5.x/v2/Alias (v2)/Describe.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,20 @@
---
displayed_sidebar: restfulSidebar
sidebar_positition: 37
sidebar_positition: 47
slug: /restful/Describe
title: "Describe Alias | RESTful"
description: "This operation describes the details of a specific alias. | RESTful"
hide_table_of_contents: true
sidebar_label: "Describe Alias"
sidebar_custom_props: { badges: ['post']}
keywords:
- zilliz cloud
- zilliz
- cloud
- "Describe Alias"
- "post"
- RESTful
- API
---

# Describe Alias
Expand All @@ -15,6 +23,6 @@ import RestSpecs from '@site/src/components/RestSpecs';

<RestSpecs specs={specs} endpoint={endpoint} method={method} target="milvus" lang="en-US" />

export const specs = {"summary":"Describe Alias","deprecated":false,"description":"This operation describes the details of a specific alias.","x-i18n":{"zh-CN":{"summary":"查看 Alias 详情","description":"本接口可列出指定 Collection 别名的详细信息。"}},"tags":["Alias Operations (V2)"],"parameters":[{"name":"Authorization","in":"header","description":"The authentication token should be <include target=\"zilliz\">an API key with appropriate privileges or </include>a pair of colon-joined username and password, like `username:password`.","required":true,"example":"Bearer {{TOKEN}}","schema":{"type":"string"},"x-i18n":{"zh-CN":{"description":"认证令牌，应为<include target=\"zilliz\">具备适当权限的 API 密钥或</include>用冒号分隔的用户名和密码，如 `username:password`。"}}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"dbName":{"type":"string","description":"The name of the database to which the alias belongs.","x-i18n":{"zh-CN":{"description":"当前别名所属的数据库名称。"}},"x-include-target":["milvus"]},"aliasName":{"type":"string","description":"The name of the alias whose details are to be listed.","x-i18n":{"zh-CN":{"description":"目标别名。"}}}},"required":["aliasName"]},"example":{"aliasName":"alice"}}}},"responses":{"200":{"description":"An alias object that contains the detailed description of an alias.","x-i18n":{"zh-CN":{"description":"返回别名的详细信息。"}},"content":{"application/json":{"schema":{"anyOf":[{"x-tab-label":"success","type":"object","properties":{"code":{"description":"Response code.","x-i18n":{"zh-CN":{"description":"响应码。"}},"type":"integer","example":0},"data":{"type":"object","description":"Response payload which carries the detailed description of an alias.","x-i18n":{"zh-CN":{"description":"响应负载，包含了指定 Collection 别名的详细信息。"}},"properties":{"dbName":{"type":"string","description":"The name of the database to which the collection belongs.","x-i18n":{"zh-CN":{"description":"当前别名对应的 Collection 所属的数据库名称。"}},"x-include-target":["milvus"]},"collectionName":{"type":"string","description":"the name of the collection to which an alias belongs.","x-i18n":{"zh-CN":{"description":"当前别名所属的 Collection 名称。"}}},"aliasName":{"type":"string","description":"The name of the alias.","x-i18n":{"zh-CN":{"description":"当前别名。"}}}}}}},{"x-tab-label":"failure","description":"Returns an error message.","x-i18n":{"zh-CN":{"description":"返回错误消息。"}},"x-i18n-langs":["zh-CN"],"type":"object","properties":{"code":{"type":"integer","description":"Response code.","x-i18n":{"zh-CN":{"description":"响应码。"}}},"message":{"type":"string","description":"Error message.","x-i18n":{"zh-CN":{"description":"错误描述。"}}}}}]},"examples":{"1":{"summary":"success","x-target-response":"OPTION 1","value":{"code":0,"data":{"aliasName":"alice","collectionName":"quick_setup","dbName":"default"}}},"2":{"summary":"failure","x-target-response":"OPTION 2","value":{"code":0,"message":"The token is illegal."}}}}}}},"security":[]}
export const specs = {"summary":"Describe Alias","deprecated":false,"description":"This operation describes the details of a specific alias.","x-i18n":{"zh-CN":{"summary":"查看 Alias 详情","description":"本接口可列出指定 Collection 别名的详细信息。"}},"tags":["Alias Operations (V2)"],"parameters":[{"name":"Authorization","in":"header","description":"The authentication token should be <include target=\"zilliz\">an API key with appropriate privileges or </include>a pair of colon-joined username and password, like `username:password`.","required":true,"example":"Bearer {{TOKEN}}","schema":{"type":"string"},"x-i18n":{"zh-CN":{"description":"认证令牌，应为<include target=\"zilliz\">具备适当权限的 API 密钥或</include>用冒号分隔的用户名和密码，如 `username:password`。"}}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"dbName":{"type":"string","description":"The name of the database to which the alias belongs.","x-i18n":{"zh-CN":{"description":"当前别名所属的数据库名称。"}}},"aliasName":{"type":"string","description":"The name of the alias whose details are to be listed.","x-i18n":{"zh-CN":{"description":"目标别名。"}}}},"required":["aliasName"]},"example":{"aliasName":"alice"}}}},"responses":{"200":{"description":"An alias object that contains the detailed description of an alias.","x-i18n":{"zh-CN":{"description":"返回别名的详细信息。"}},"content":{"application/json":{"schema":{"anyOf":[{"x-tab-label":"success","type":"object","properties":{"code":{"description":"Response code.","x-i18n":{"zh-CN":{"description":"响应码。"}},"type":"integer","example":0},"data":{"type":"object","description":"Response payload which carries the detailed description of an alias.","x-i18n":{"zh-CN":{"description":"响应负载，包含了指定 Collection 别名的详细信息。"}},"properties":{"dbName":{"type":"string","description":"The name of the database to which the collection belongs.","x-i18n":{"zh-CN":{"description":"当前别名对应的 Collection 所属的数据库名称。"}}},"collectionName":{"type":"string","description":"the name of the collection to which an alias belongs.","x-i18n":{"zh-CN":{"description":"当前别名所属的 Collection 名称。"}}},"aliasName":{"type":"string","description":"The name of the alias.","x-i18n":{"zh-CN":{"description":"当前别名。"}}}}}}},{"x-tab-label":"failure","description":"Returns an error message.","x-i18n":{"zh-CN":{"description":"返回错误消息。"}},"x-i18n-langs":["zh-CN"],"type":"object","properties":{"code":{"type":"integer","description":"Response code.","x-i18n":{"zh-CN":{"description":"响应码。"}}},"message":{"type":"string","description":"Error message.","x-i18n":{"zh-CN":{"description":"错误描述。"}}}}}]},"examples":{"1":{"summary":"success","x-target-response":"OPTION 1","value":{"code":0,"data":{"aliasName":"alice","collectionName":"quick_setup","dbName":"default"}}},"2":{"summary":"failure","x-target-response":"OPTION 2","value":{"code":1800,"message":"User hasn't authenticated"}}}}}}},"security":[]}
export const endpoint = "/v2/vectordb/aliases/describe"
export const method = "post"
Loading