GetContextModel - 获取上下文模型

更新时间:
复制 MD 格式

获取 Semantic Model 详情

调试

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

调试

授权信息

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

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

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

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

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

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

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

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

操作

访问级别

资源类型

条件关键字

关联操作

log:GetContextModel

get

*ContextModel

acs:log:{#regionId}:{#accountId}:contextmodel/{#name}

无 无

请求语法

GET /context-models/{name} HTTP/1.1

路径参数

名称

类型

必填

描述

示例值

name

string

否

上下文模型的标识,取自请求路径 /context-models/{name},须为当前账号下已创建的模型名;仅支持大小写字母、数字、下划线(_)与短横线(-)。

orders

请求参数

名称

类型

必填

描述

示例值

当前API无需请求参数

返回参数

名称

类型

描述

示例值

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

上下文模型的标识,与请求路径中的 name 一致;在同一主账号下唯一,创建后不可修改。

orders

sources

object

引用的源:以 Project 名为 key,值为该 Project 下框选的 Logstore 列表,与创建时提交的结构一致。["*"] 表示该 Project 下全部 Logstore;否则为精确的 Logstore 名列表。未引用任何源时返回空对象 {}。

{"cn-hangzhou-app-logs": ["*"], "cn-hangzhou-order-logs": ["accesslog", "errorlog"]}

array

该 Project 下已框选的 Logstore 名列表,为字符串数组。["*"] 表示该 Project 下的全部 Logstore,不可与具体 Logstore 名混写。

string

该 Project 下已框选的 Logstore 名称;取值为 "*" 时表示该 Project 下的全部 Logstore。

order-log

updatedAt

string

模型最近一次更新时间,RFC3339 UTC 格式,形如 2026-07-09T05:33:37Z;修改显示名、描述或 sources 后更新。

2026-07-09T05:33:37Z

示例

正常返回示例

JSON格式

{
  "createdAt": "2026-07-09T05:33:37Z",
  "description": "End-to-end coverage from order creation to payment",
  "displayName": "订单分析模型",
  "name": "orders",
  "sources": {
    "key": [
      "order-log"
    ]
  },
  "updatedAt": "2026-07-09T05:33:37Z"
}

错误码

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

变更历史

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