QueryContextModel - 检索上下文模型元素

更新时间:
复制 MD 格式

SPL 查询 Semantic Model 内容

调试

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

调试

授权信息

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

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

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

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

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

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

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

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

操作

访问级别

资源类型

条件关键字

关联操作

log:QueryContextModel

list

*ContextModel

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

无 无

请求语法

POST /context-models/{name}/query HTTP/1.1

路径参数

名称

类型

必填

描述

示例值

name

string

否

待查询的上下文模型标识,取自请求路径 /context-models/{name}/query,仅支持大小写字母、数字、下划线(_)与短横线(-)。

orders

请求参数

名称

类型

必填

描述

示例值

body

object

否

请求体。JSON 对象,携带一条针对该模型元素定义的 SPL 查询。

query

string

是

SPL 查询语句,必填且不可为空串,否则返回 400。以 .umodel 作为数据源查询该模型的元素定义,支持 where、project、limit 等管道操作,例如 .umodel | where kind = 'log_set' | limit 50。

.umodel | where kind = 'log_set' | limit 50

返回参数

名称

类型

描述

示例值

object

响应体。返回本次查询命中的列名与数据行。

data

array

结果行数组,每行是与 header 按顺序一一对应的数组;无命中时返回空数组 []。

array

一行结果,元素顺序与 header 中的列名一一对应。

string

单元格值,恒为字符串;其中 metadata、schema、spec 三列的内容本身是 JSON 字符串,需要调用方自行解析。

log_set

header

array

列名数组,随 SPL 的投影而变;未显式投影时默认为 kind、metadata、schema、spec。

string

单个列名。

kind

示例

正常返回示例

JSON格式

{
  "data": [
    [
      "log_set"
    ]
  ],
  "header": [
    "kind"
  ]
}

错误码

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

变更历史

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