DescribeChartData - Security Center - Alibaba Cloud Documentation Center

Queries the chart data of a security report.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
yundun-sas:DescribeChartData	none	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
CharId	string	No	The ID of the chart. Note You can call the DescribeChartList operation to query the ID. This parameter is required if the report version is 1.0.0.	CID_ASSET_RISK_TREND
TimeStart	long	No	The beginning of the time range to query. The value is a UNIX timestamp. Unit: milliseconds.	1683603086000
TimeEnd	long	No	The end of the time range to query. The value is a UNIX timestamp. Unit: milliseconds.	1683862286000
Lang	string	No	The language of the content within the request and response. Default value: zh. Valid values: zh: Chinese en: English	zh
ReportId	long	No	The ID of the security report. Note You can call the DescribeCustomizeReportList operation to query the ID.	721734
ChartId	string	No	The ID of the chart. Note You can call the DescribeChartList operation to query the ID. This parameter is required if the report version is 2.0.0.	CID_VUL_SUMMARY

Response parameters

Parameter	Type	Description	Example
	object
PropertyValue	string	The data of the chart.	{'totalCount': '0'}
ProperyArrayValue	string	The array data of the chart.	[]
ChartType	string	The type of the chart. Valid values: timeLine timeBar bar line pie gauge table text	timeBar
ChartDataType	string	The data type of the chart. Valid values: commonCoordinate timeCoordinate multipleValue singleValue propertyValue propertyArrayValue	propertyArrayValue
CoordinateData	object	The coordinate data.
YAxisList	array<object>	The y-axis values.
YAxisDo	object	The value of the y-axis.
Type	string	The type of the data.	high
Name	string	The name of the data type.	Port
Value	array	The values of the y-axis that corresponds to x-axis points.
LongItem	string	The value of the y-axis that corresponds to the x-axis point.	1
SubType	string	The subtype data of the chart.	CID_SUSPICIOUS_TREND-AL
XAxis	array	The x-axis values.
StringItem	string	The value of the x-axis.	2024-01-01
SingleData	object	The data of the single value chart.
Type	string	The type of the data.	suspicious
Value	long	The value in the single value chart.	172
Name	string	The name of the data type.	suspicious
MultipleData	array<object>	The values in the multi-value charts.
MultipleDataItem	object	The value in the multi-value chart.
Type	string	The type of the data.	safe
Value	long	The attribute value.	0
Color	string	The font color, which is an RGBA value.	#FFA800
Name	string	The name of the data type.	Safety
RequestId	string	The request ID.	50CCE62A-2BC4-5CF8-B976-E4F62A31****
ChartSubTypeList	array	The subtype values in which the chart is selected.
ChartSubType	string	The subtype value in which the chart is selected.	["CID_VUL_TREND-CVE", "CID_VUL_TREND-SYS", "CID_VUL_TREND-CMS", "CID_VUL_TREND-APP", "CID_VUL_TREND-EMG"]
AllChartSubTypeList	array<object>	The valid values for all subtypes of the chart.
AllChartSubType	object
SubType	string	The subtype of the chart.	CID_SUSPICIOUS_TREND-ALL
SubTypeName	string	The name of the chart subtype.	All Alerts
PropertyArrayValue	string	The attribute value of the array chart.	[]

Examples

Sample success responses

JSONformat

{
  "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": "[]"
}

Error codes

HTTP status code	Error code	Error message	Description
403	NoPermission	caller has no permission	You are not authorized to do this operation.
500	ServerError	ServerError	-

For a list of error codes, visit the Service error codes.