请求参数 表1 请求Body参数 参数 是否必选 参数类型 描述 store_name 是 String 参数解释： 知识仓实例名称，region内唯一。 约束限制： 长度范围为3到63个字符，支持小写字母、数字、中划线（-），第一个字符只能够是小写字母，中划线(-)不得出现在字符串末尾。 取值范围： 不涉及。 默认取值： 不涉及。 collection_name 是 String 参数解释： collection名称。 约束限制： 可包含数字、字母和下划线 ()。资源名称必须以字母或下划线 () 开头。最大长度支持255。 取值范围： 不涉及。 默认取值: 不涉及。

响应示例 状态码：200 执行成功，release collection success { "code" : "LMS.00000000", "message" : "release collection success" } 状态码：400 集合卸载失败 { "code" : "LMS.00003001", "message" : "ErrCollectionNotFound: Collection not found" }

响应参数 状态码：200 表2 响应Body参数 参数 参数类型 描述 code String 参数解释： 返回码。参见错误码章节。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值: 不涉及。 message String 参数解释： 描述信息。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值: 不涉及。 状态码：400 表3 响应Body参数 参数 参数类型 描述 code String 参数解释： 返回码。参见错误码章节。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值: 不涉及。 message String 参数解释： 描述信息。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值: 不涉及。

响应示例 状态码：200 搜索成功 { "code" : "LMS.00000000", "message" : "search entities success", "data" : { "entities" : [ { "distance" : 0.8106635, "primary_key" : 200, "vector" : [ 22.33, 33.44, 44.55 ], "scalar_name" : "book1" }, { "distance" : 0.75336635, "primary_key" : 300, "vector" : [ 221.33, 331.441, 441.55 ], "scalar_name" : "book2" } ] } } 状态码：400 搜索失败 { "code" : "LMS.00001001", "message" : "ErrInvalidParameter : the input parameter is incorrect." }

响应参数 状态码：200 表2 响应Body参数 参数 参数类型 描述 code String 参数解释： 返回码。参见错误码章节。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值: 不涉及。 message String 参数解释： 描述信息。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值: 不涉及。 data list_jobs_data object 参数解释： 响应数据。 约束限制： 不涉及。 表3 list_jobs_data 参数 参数类型 描述 jobs Array of job_data objects 参数解释： 任务列表。 约束限制： 不涉及。 表4 job_data 参数 参数类型 描述 job_id String 参数解释： 创建知识仓实例的任务id。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值: 不涉及。 status String 参数解释： 任务执行状态。 约束限制： 不涉及。 取值范围： Running：任务正在执行 Completed：任务执行成功 Failed：任务执行失败 默认取值: 不涉及。 name String 参数解释： 任务名称。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值: 不涉及。 create_time String 参数解释： 创建时间。 约束限制： 格式为“yyyy-mm-ddThh:mm:ssZ”。 取值范围： 不涉及。 默认取值: 不涉及。 end_time String 参数解释： 结束时间。 约束限制： 格式为“yyyy-mm-ddThh:mm:ssZ”。 取值范围： 不涉及。 默认取值: 不涉及。 progress String 参数解释： 任务执行进度。运行中状态返回执行进度，例如“60%”，表示任务执行进度为60%。 约束限制： 不涉及。 取值范围： [1%-100%]。 默认取值: 不涉及。 store_name String 参数解释： 知识仓实例名称，region内唯一。 约束限制： 长度范围为3到63个字符，支持小写字母、数字、中划线（-），第一个字符只能够是小写字母，中划线(-)不得出现在字符串末尾。 取值范围： 不涉及 默认取值： 不涉及 fail_reason String 参数解释： 任务执行失败时的错误信息。 约束限制： 当status是Failed时生效。 取值范围： 不涉及。 默认取值: 不涉及。

响应示例 状态码：200 列举jobs信息 { "code" : "LMS.00000000", "message" : "list jobs success", "data" : { "jobs" : [ { "job_id" : "任务id", "status" : "Completed", "name" : "CreateStore", "create_time" : "2024-08-06T10:31:10T", "end_time" : "2024-08-06T10:32:10T", "progress" : "100%", "store_name" : "test_store" } ] } }

URI POST /v1/jobs/list 表1 Query参数 参数 是否必选 参数类型 描述 start_time 否 String 参数解释： 查询开始时间。 约束限制： 格式为“yyyy-mm-ddThh:mm:ssZ”。 取值范围： 不涉及。 默认取值: 不涉及。 end_time 否 String 参数解释： 查询结束时间。 约束限制： 格式为“yyyy-mm-ddThh:mm:ssZ”。 取值范围： 不涉及。 默认取值: 不涉及。 status 否 String 参数解释： 任务状态。 约束限制： 不涉及。 取值范围： 1、“Running”：执行中； 2、“Completed”：完成； 3、“Failed”：失败。 默认取值: 不涉及。 offset 否 Integer 参数解释： 索引位置，偏移量。从第一条数据偏移offset条数据后开始查询。 约束限制： 必须为数字，不能为负数。 取值范围： [0-4096] 默认取值: 默认为0（偏移0条数据，表示从第一条数据开始查询）。 limit 否 String 参数解释： 查询记录数。 约束限制： 不能为负数。 取值范围： [1-100]。 默认取值: 1。

响应示例 状态码：200 返回消息的参数 stores中以数组的形式，列出所有的stores名 { "code" : "LMS.00000000", "message" : "list store success", "data" : { "stores" : [ { "id" : "实例id", "store_name" : "test_store", "region" : "cn-north-7", "availability_zones" : [ "cn-north-7a" ], "create_time" : "2024-08-06T10:31:10Z", "status" : "NORMAL", "flavor" : { "cu" : "xlarge", "num" : 2 }, "charge_info" : { "charge_mode" : "postPaid" }, "description" : "this is a first store", "private_link" : "cn-north-7.lms-lz01.ce0fe887-9ba3-44aa-9982-595a3fb4b0af" }, { "id" : "实例id", "store_name" : "test_store1", "create_time" : "2024-08-06T10:31:10Z", "region" : "cn-north-7", "availability_zones" : [ "cn-north-7a" ], "status" : "CREATING", "flavor" : { "cu" : "xlarge", "num" : 1 }, "charge_info" : { "charge_mode" : "postPaid" }, "description" : "this is a second store", "private_link" : "cn-north-7.lms-lz01.ce0fe887-9ba3-44aa-9982-595a3fb4b0af" } ] } }

响应参数 状态码：200 表1 响应Body参数 参数 参数类型 描述 code String 参数解释： 返回码。参见错误码章节。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值: 不涉及。 message String 参数解释： 描述信息 约束限制： 不涉及。 取值范围： 不涉及。 默认取值: 不涉及。 data list_store_data object 参数解释： 响应数据。 约束限制： 不涉及。 表2 list_store_data 参数 参数类型 描述 stores Array of describe_store_data objects 参数解释： 列举store列表。 约束限制： 不涉及。 表3 describe_store_data 参数 参数类型 描述 id String 参数解释： 知识仓实例id。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值: 不涉及。 store_name String 参数解释： 知识仓实例名称，region内唯一。 约束限制： 长度范围为3到63个字符，支持小写字母、数字、中划线（-），第一个字符只能够是小写字母，中划线(-)不得出现在字符串末尾。 取值范围： 不涉及 默认取值： 不涉及 status String 参数解释： 知识仓实例状态。 约束限制： 不涉及。 取值范围： CREATING：创建中 NORMAL：正常 CREATED_FAILED：创建失败 ABNORMAL：异常 FROZEN：被冻结 DISK_FULL：存储空间已满 DROPPING：删除中 DELETE_FAILED：删除失败 默认取值: 不涉及。 create_time String 参数解释： 创建时间。 约束限制： 格式为“yyyy-mm-ddThh:mm:ssZ”。 取值范围： 不涉及。 默认取值: 不涉及。 region String 参数解释： 区域ID。 约束限制： 不涉及。 取值范围： 取值：非空，请参见地区和终端节点。 默认取值: 不涉及。 availability_zones Array of strings 参数解释： 可用区ID列表，支持1个，或者多个。 约束限制： 不涉及。 flavor flavor object 参数解释： 规格信息。 约束限制： 不涉及。 charge_info charge_info object 参数解释： 计费类型信息。 约束限制： 当前仅支持按需计费模式。 description String 参数解释： 知识仓实例描述信息。 约束限制： 有效长度0-255 取值范围： 不涉及。 默认取值: 不涉及。 private_link String 参数解释： 知识仓实例的私网链接信息，参考"VPCEP终端节点对接LMS知识仓实例"。 约束限制： 当前不支持公网访问。 取值范围： 不涉及。 默认取值: 不涉及。 表4 flavor 参数 参数类型 描述 cu String 参数解释： CU规格。 约束限制： 不涉及。 取值范围： xlarge, 2xlarge, 4xlarge, 8xlarge, 16xlarge。 默认取值: 不涉及。 num Integer 参数解释： 选择CU规格的数量。 约束限制： 不能超过CU配额，如有大量需求，请提工单申请。 取值范围： 不涉及。 默认取值: 不涉及。 表5 charge_info 参数 参数类型 描述 charge_mode String 参数解释： 计费模式。 约束限制： 当前只支持按需付费。 取值范围： prePaid：预付费，即包年/包月。 postPaid：后付费，即按需付费。 默认取值: 按需付费。 period_type String 参数解释： 订购周期类型。 约束限制： “charge_mode”为“prePaid”时生效，且为必选值。 取值范围： month：包月。 year：包年。 默认取值: 不涉及。 period_num Integer 参数解释： 订购的时间。 约束限制： “charge_mode”为“prePaid”时生效，且为必选值，指定订购的时间。 取值范围： 当“period_type”为“month”时，取值为1~9。 当“period_type”为“year”时，取值为1~3和5。 默认取值: 不涉及。 is_auto_renew Boolean 参数解释： 表示是否自动续订，续订的周期和原周期相同，且续订时会自动支付。 约束限制： 在创建包周期实例时可指定。 取值范围： 不涉及。 默认取值: 不涉及。 is_auto_pay Boolean 参数解释： 表示是否自动从客户的账户中支付，此字段不影响自动续订的支付方式。 约束限制： 在创建包周期时可指定。 取值范围： 不涉及。 默认取值: 不涉及。

响应参数 状态码：200 表3 响应Body参数 参数 参数类型 描述 code String 参数解释： 返回码。参见错误码章节。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值: 不涉及。 message String 参数解释： 描述信息。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值: 不涉及。 状态码：400 表4 响应Body参数 参数 参数类型 描述 code String 参数解释： 返回码。参见错误码章节。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值: 不涉及。 message String 参数解释： 描述信息。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值: 不涉及。

请求示例 向量索引示例 { "store_name" : "store_test", "collection_name" : "collection_test", "index_params" : { "index_name" : "vector_index", "field_name" : "vector", "metric_type" : "L2", "params" : { "index_type" : "HANNS", "dim" : 256, "max_degree" : 56, "search_list_size" : 200, "pq_code_buget_gb_ratio" : 0.125, "search_cache_budget_gb_ratio" : 0.125, "beamwidth_ratio" : 4 } } } 标量索引示例 { "store_name" : "store_test", "collection_name" : "collection_test", "index_params" : { "index_name" : "scalar_index", "field_name" : "id", "metric_type" : "L2", "params" : { "index_type" : "INVERTED" } } }

响应示例 状态码：200 创建索引成功 { "code" : "LMS.00001000", "message" : "create index success" } 状态码：400 Bad Request { "code" : "LMS.00001001", "message" : "ErrInvalidParameter: The input parameter is incorrect." }

响应示例 状态码：200 搜索成功 { "code" : "LMS.00000000", "message" : "hybrid search success", "data" : { "entities" : [ { "distance" : 0.025679013, "primary_key" : 200, "vector" : [ 22.33, 33.44, 44.55 ], "scalar_1" : "YouShangYun" }, { "distance" : 0.025674567, "primary_key" : 300, "vector" : [ 221.33, 331.441, 441.55 ], "scalar_1" : "NewYun" } ] } } 状态码：400 搜索失败 { "code" : "LMS.00001001", "message" : "ErrInvalidParameter : the input parameter is incorrect." }

状态码 表1 正常状态码 正常状态码 编码 说明 200 ok 操作正常返回。 表2 异常状态码 异常状态码 编码 说明 400 Bad Request 服务器未能处理请求。 401 Unauthorized 被请求的页面需要用户名和密码。 403 Forbidden 对被请求页面的访问被禁止。 404 Not Found 服务器无法找到被请求的页面。 405 Method Not Allowed 请求中指定的方法不被允许。 406 Not Acceptable 服务器生成的响应无法被客户端所接受。 408 Request Timeout 请求超出了服务器的等待时间。 500 Internal Server Error 请求未完成。服务异常。 501 Not Implemented 请求未完成。服务器不支持所请求的功能。 503 Service Unavailable 请求未完成。系统暂时异常。 504 Gateway Timeout 网关超时。 父主题： 附录

基本概念 账号 用户注册华为云时的账号，账号对其所拥有的资源及云服务具有完全的访问权限，可以重置用户密码、分配用户权限等。由于账号是付费主体，为了确保账号安全，建议您不要直接使用账号进行日常管理工作，而是创建用户并使用用户进行日常管理工作。 用户 由账号在 IAM 中创建的用户，是云服务的使用人员，具有身份凭证（密码和访问密钥）。 在我的凭证下，您可以查看账号ID和用户ID。通常在调用API的鉴权过程中，您需要用到账号、用户和密码等信息。 区域（Region） 从地理位置和网络时延维度划分，同一个Region内共享弹性计算、块存储、对象存储、VPC网络、弹性公网IP、镜像等公共服务。Region分为通用Region和专属Region，通用Region指面向公共租户提供通用云服务的Region；专属Region指只承载同一类业务或只面向特定租户提供业务服务的专用Region。 详情请参见区域和可用区。 可用区（AZ，Availability Zone） 一个AZ是一个或多个物理数据中心的集合，有独立的风火水电，AZ内逻辑上再将计算、网络、存储等资源划分成多个集群。一个Region中的多个AZ间通过高速光纤相连，以满足用户跨AZ构建高可用性系统的需求。 项目 华为云的区域默认对应一个项目，这个项目由系统预置，用来隔离物理区域间的资源（计算资源、存储资源和网络资源），以默认项目为单位进行授权，用户可以访问您账号中该区域的所有资源。如果您希望进行更加精细的权限控制，可以在区域默认的项目中创建子项目，并在子项目中购买资源，然后以子项目为单位进行授权，使得用户仅能访问特定子项目中资源，使得资源的权限控制更加精确。 图1 项目隔离模型 同样在我的凭证下，您可以查看项目ID。