ListContextModels - 列出上下文模型

更新时间:
复制 MD 格式

列出 Semantic Model

接口说明

请求说明

  • 该接口用于查询当前账户下的 ContextModel 资源,按更新时间倒序返回。

  • 支持三类过滤,可任意叠加(AND 关系):按名称模糊过滤(name)、按名称/显示名/描述模糊过滤(keyword)、按引用的 Project 精确反查(projectName)。

  • 分页参数 page 从 1 开始;page / size 超出取值范围时会被服务端截断到边界值,不报错。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

log:ListContextModels

list

*全部资源

*

无 无

请求语法

GET /context-models HTTP/1.1

请求参数

名称

类型

必填

描述

示例值

page

integer

否

查询页码,从 1 开始。

1

size

integer

否

每页返回的 ContextModel 数量,取值范围为 1~1000。

20

name

string

否

用于模糊过滤的名称关键词,仅匹配名称、不匹配描述。可与 keyword 叠加。

order

keyword

string

否

用于模糊过滤的关键词,同时匹配名称、显示名与描述。

order

projectName

string

否

按引用关系查询:只返回 sources 中引用了该 Project 的 ContextModel,用于查看某个 Project 被哪些 ContextModel 引用。取值为完整的 Project 名,按精确匹配处理,不做模糊匹配 —— 例如传入 order-prod 时,仅引用了 order-prod-canary 的模型不会被返回。取值需为合法的 Project 名,否则返回 400。

cn-hangzhou-app-logs

返回参数

名称

类型

描述

示例值

object

响应体。返回分页的上下文模型摘要列表。

items

array<object>

当前页的上下文模型摘要列表,按更新时间倒序排列;无命中或页码越界时返回空数组 []。摘要中不含 sources 与 updatedAt,如需完整信息请调用 GetContextModel。

object

单个上下文模型的摘要信息。

createdAt

string

模型创建时间,RFC3339 UTC 格式,形如 2026-07-09T05:33:37Z。

2026-07-09T05:33:37Z

description

string

模型描述,最长 1024 个字符;未填写时返回空串 ""。

End-to-end coverage from order creation to payment

displayName

string

显示名。未设置时返回空串 ""(不会回填成 name),展示时请按 displayName || name 回退。

订单分析模型

name

string

上下文模型的标识,在同一主账号下唯一,创建后不可修改;可作为路径参数传给 GetContextModel 等接口。

orders

page

integer

本次实际生效的页码。页码小于 1 时按 1 处理。

1

size

integer

本次实际生效的每页条数。小于 1 时按默认值 20 处理,大于 1000 时按 1000 处理。

20

total

integer

满足本次过滤条件的上下文模型总数,不受分页影响。

4

示例

正常返回示例

JSON格式

{
  "items": [
    {
      "createdAt": "2026-07-09T05:33:37Z",
      "description": "End-to-end coverage from order creation to payment",
      "displayName": "订单分析模型",
      "name": "orders"
    }
  ],
  "page": 1,
  "size": 20,
  "total": 4
}

错误码

访问错误中心查看更多错误码。

变更历史

更多信息,参考变更详情。