DescribeChartData - 查询安全日报图表统计数据

查询安全报告中配置图表的统计数据。

调试

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

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
yundun-sas:DescribeChartDatanone
  • 全部资源
    *

请求参数

名称类型必填描述示例值
CharIdstring

图表 ID。

说明 调用 DescribeChartList 接口获取该参数。报告版本为 1.0.0 必填。
CID_ASSET_RISK_TREND
TimeStartlong

统计起始时间戳。单位:毫秒。

1683603086000
TimeEndlong

统计结束时间戳。单位:毫秒。

1683862286000
Langstring

设置请求和接收消息的语言类型,默认为 zh。取值:

  • zh:中文
  • en:英文
zh
ReportIdlong

报表 ID。

说明 调用 DescribeCustomizeReportList 接口获取该参数。
721734
ChartIdstring

图表 ID。

说明 调用 DescribeChartList 接口获取该参数。报告版本为 2.0.0 必填。
CID_VUL_SUMMARY

返回参数

名称类型描述示例值
object
PropertyValuestring

图表中的属性值。

{'totalCount': '0'}
ProperyArrayValuestring

图表的属性数组。

[]
ChartTypestring

图表类型。取值:

  • timeLine:时间轴线图
  • timeBar:时间轴柱状图
  • bar:柱状图
  • line:线图
  • pie:饼图
  • gauge:测量图
  • table:表格
  • text:文本
timeBar
ChartDataTypestring

图表数据类型。取值:

  • commonCoordinate:普通坐标
  • timeCoordinate:时间轴坐标
  • multipleValue:多值
  • singleValue:单值
  • propertyValue:属性值
  • propertyArrayValue:数组属性值
propertyArrayValue
CoordinateDataobject

坐标数据。

YAxisListarray<object>

纵轴值列表。

YAxisDoobject

纵轴值。

Typestring

数据类型。

high
Namestring

数据类型名称。

Port
Valuearray

各横坐标点对应的纵坐标的值。

LongItemstring

横坐标点对应的纵坐标的值。

1
SubTypestring

图表子类型数据。

CID_SUSPICIOUS_TREND-AL
XAxisarray

横坐标值列表。

StringItemstring

横坐标值。

2024-01-01
SingleDataobject

单值图数据。

Typestring

数据类型。

suspicious
Valuelong

单值图的数据值。

172
Namestring

数据类型名称。

suspicious
MultipleDataarray<object>

多值图数据。

MultipleDataItemobject

多值图。

Typestring

数据类型。

safe
Valuelong

属性值。

0
Colorstring

字体颜色,十六进制颜色码 RGBA。

#FFA800
Namestring

数据类型名称。

Safety
RequestIdstring

本次调用请求的 ID,是由阿里云为该请求生成的唯一标识符,可用于排查和定位问题。

50CCE62A-2BC4-5CF8-B976-E4F62A31****
ChartSubTypeListarray

选择的图表子类型值列表。

ChartSubTypestring

选择的图表子类型值。

["CID_VUL_TREND-CVE", "CID_VUL_TREND-SYS", "CID_VUL_TREND-CMS", "CID_VUL_TREND-APP", "CID_VUL_TREND-EMG"]
AllChartSubTypeListarray<object>

该图表所有子类型可选择值。

AllChartSubTypeobject
SubTypestring

图表子类型。

CID_SUSPICIOUS_TREND-ALL
SubTypeNamestring

图表子类型名称。

All Alerts
PropertyArrayValuestring

数组图表属性值。

[]

示例

正常返回示例

JSON格式

{
  "PropertyValue": "{'totalCount': '0'}",
  "ProperyArrayValue": "[]",
  "ChartType": "timeBar",
  "ChartDataType": "propertyArrayValue",
  "CoordinateData": {
    "YAxisList": [
      {
        "Type": "high",
        "Name": "Port",
        "Value": [
          "1"
        ],
        "SubType": "CID_SUSPICIOUS_TREND-AL"
      }
    ],
    "XAxis": [
      "2024-01-01"
    ]
  },
  "SingleData": {
    "Type": "suspicious",
    "Value": 172,
    "Name": "suspicious"
  },
  "MultipleData": [
    {
      "Type": "safe",
      "Value": 0,
      "Color": "#FFA800",
      "Name": "Safety"
    }
  ],
  "RequestId": "50CCE62A-2BC4-5CF8-B976-E4F62A31****",
  "ChartSubTypeList": [
    "[\"CID_VUL_TREND-CVE\", \"CID_VUL_TREND-SYS\", \"CID_VUL_TREND-CMS\", \"CID_VUL_TREND-APP\", \"CID_VUL_TREND-EMG\"]"
  ],
  "AllChartSubTypeList": [
    {
      "SubType": "CID_SUSPICIOUS_TREND-ALL",
      "SubTypeName": "All Alerts"
    }
  ],
  "PropertyArrayValue": "[]"
}

错误码

HTTP status code错误码错误信息描述
403NoPermissioncaller has no permission当前操作未被授权,请联系主账号在RAM控制台进行授权后再执行操作。
500ServerErrorServerError服务故障,请稍后重试!

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