ListQueryViews - 获取查询视图列表

更新时间:
复制 MD 格式

获取查询视图列表。

接口说明

入参 JsonConfig 是一个非常复杂的 JSON 配置,为此我们提供了辅助工具类帮助具体配置示例,请参考 Demo 。

调试

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

调试

授权信息

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

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

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

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

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

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

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

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

操作

访问级别

资源类型

条件关键字

关联操作

yundun-sas:ListQueryViews

list

*全部资源

*

无 无

请求参数

名称

类型

必填

描述

示例值

RegionId

string

否

威胁分析的数据管理中心所在地。您需要根据资产所在地域,选择管理中心所在地。取值:

  • cn-hangzhou:资产属于中国内地与中国香港,选择该项。

  • ap-southeast-1:资产属于海外地域,选择该项。

cn-hangzhou

Lang

string

否

返回消息的语言类型。取值:

  • zh(默认):中文。

  • en:英文。 注意:此参数实际为必填项,未提供时 API 返回 400 错误「The specified Lang can not be empty.」,调用方必须显式传入 zh 或 en。

zh

QueryViewScene

string

否

查询视图所属场景。

Alert

QueryViewType

string

否

视图类型,为空返回全部。

preset

RoleFor

integer

否

管理员切换成其他成员视角的用户 ID。

113091674488****

RoleType

integer

否

视图类型。

  • 0:当前阿里云账号视图。

  • 1:企业下所有账号的视图。

1

MaxResults

integer

否

使用 NextToken 方式查询时,每次最多返回的结果数。取值范围:1~100。默认值:50。

50

NextToken

string

否

是否拥有下一次查询的令牌(Token)。取值:第一次查询和没有下一次查询时,均无需填写。如果有下一次查询,取值为上一次 API 调用返回的 NextToken 值。

AAAAAUqcj6VO4E3ECWIrFczs****

返回参数

名称

类型

描述

示例值

object

Schema of Response

RequestId

string

请求 ID。

9AAA9ED9-78F4-5021-86DC-D51C7511****

QueryViews

array<object>

查询视图列表。

object

视图。

QueryViewId

string

查询视图的唯一标识。

qv-a1b2c3d4e5f6g7h8****

QueryViewScene

string

视图所属场景。

Alert

QueryViewName

string

视图名称。

alert

QueryViewCriteria

string

视图的告警过滤语句。

module_code: alibaba_cloud_sas_custom_rule

QueryViewType

string

视图类型。

preset

QueryViewFields

string

展示字段列表。

["alert_name_cn","alert_type_cn","entity_list","alert_level","alert_status","start_time","end_time"]

QueryViewStatus

string

视图状态。

2

QueryViewOrder

string

展示顺序。

1

QueryViewCondition

string

自定义视图查询条件。

preset

LogRegionId

string

日志存储地域 ID。

cn-hangzhou

LogProjectName

string

日志服务项目名称。

aliyun-cloudsiem-data-173326*******-cn-hangzhou

LogStoreName

string

日志服务 LogStore 名称。

audit-activity

NextToken

string

是否拥有下一次查询的令牌(Token)。取值:第一次查询和没有下一次查询时,均无需填写。如果有下一次查询,取值为上一次 API 调用返回的 NextToken 值。

AAAAASLVeIxed4466E0LVmGkzwS6hJKd9DGVGMDRM6Lu****

MaxResults

integer

使用 NextToken 方式查询时,每次最多返回的结果数。取值范围:1~100。默认值:50。

50

示例

正常返回示例

JSON格式

{
  "RequestId": "9AAA9ED9-78F4-5021-86DC-D51C7511****",
  "QueryViews": [
    {
      "QueryViewId": "qv-a1b2c3d4e5f6g7h8****",
      "QueryViewScene": "Alert",
      "QueryViewName": "alert",
      "QueryViewCriteria": "module_code: alibaba_cloud_sas_custom_rule",
      "QueryViewType": "preset",
      "QueryViewFields": "[\"alert_name_cn\",\"alert_type_cn\",\"entity_list\",\"alert_level\",\"alert_status\",\"start_time\",\"end_time\"]",
      "QueryViewStatus": "2",
      "QueryViewOrder": "1",
      "QueryViewCondition": "preset"
    }
  ],
  "LogRegionId": "cn-hangzhou",
  "LogProjectName": "aliyun-cloudsiem-data-173326*******-cn-hangzhou",
  "LogStoreName": "audit-activity",
  "NextToken": "AAAAASLVeIxed4466E0LVmGkzwS6hJKd9DGVGMDRM6Lu****",
  "MaxResults": 50
}

错误码

HTTP status code

错误码

错误信息

描述

400 IdempotentParameterMismatch The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.

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

变更历史

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