列举collection
功能介绍
列举指定知识仓实例中所有的collections。
URI
POST /v1/collections/list
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
store_name |
是 |
String |
参数解释: 知识仓实例名称,region内唯一。 约束限制: 长度范围为3到63个字符,支持小写字母、数字、中划线(-),第一个字符只能够是小写字母,中划线(-)不得出现在字符串末尾。 取值范围: 不涉及 默认取值: 不涉及 |
detail |
否 |
Boolean |
参数解释: 列举collection的详细信息。 约束限制: 不涉及。 取值范围: true 或者 false。 默认取值: false。 |
响应参数
状态码:200
参数 |
参数类型 |
描述 |
---|---|---|
code |
String |
参数解释: 返回码。参见错误码章节。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
message |
String |
参数解释: 描述信息。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
data |
list_collection_data object |
参数解释: 响应数据。 约束限制: 不涉及。 |
参数 |
参数类型 |
描述 |
---|---|---|
collections |
Array of strings |
参数解释: 知识仓实例下所有collection名称列表。 约束限制: 不涉及。 |
details |
Array of list_collection_details objects |
参数解释: 知识仓实例下所有collection详细信息列表。 约束限制: 在指定detail字段为true时生效。 |
参数 |
参数类型 |
描述 |
---|---|---|
collection_name |
String |
参数解释: collection名称。 约束限制: 可包含数字、字母和下划线 ()。资源名称必须以字母或下划线 () 开头。最大长度支持255。 取值范围: 不涉及。 默认取值: 不涉及。 |
index_num |
Integer |
参数解释: 索引数量。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
entity_num |
Long |
参数解释: collection中的entity数量。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
load_state |
String |
参数解释: 标识当前Collection加载状态。 约束限制: 不涉及。 取值范围: 1、LoadStateLoaded:表示当前Collection已准备就绪,可正常使用。 2、LoadStateLoading:表示当前Collection正在load。 3、LoadStateNotLoad:表示collection未加载。 默认取值: 不涉及。 |
create_time |
String |
参数解释: 创建时间。 约束限制: 格式为“yyyy-mm-ddThh:mm:ssZ"。 取值范围: 不涉及。 默认取值: 不涉及。 |
description |
String |
参数解释: collection的描述信息。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
状态码:400
参数 |
参数类型 |
描述 |
---|---|---|
code |
String |
参数解释: 返回码。参见错误码章节。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
message |
String |
参数解释: 描述信息。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
请求示例
{ "store_name" : "test-storename" }
响应示例
状态码:200
执行成功返回指定store中所有的collection的名字
{ "code" : "LMS.00000000", "data" : { "collections" : [ "test-collection" ] }, "message" : "list collection success" }
状态码
状态码 |
描述 |
---|---|
200 |
执行成功返回指定store中所有的collection的名字 |
400 |
Bad Request |
错误码
请参见错误码。