DescribeChartData API Reference for Security Report Charts - Security Center - Alibaba Cloud - Security Center

Queries the statistics of charts configured in a security report.

Operation description

Before querying chart data for a custom report, perform the following steps in order:

Call DescribeCustomizeReportList to obtain the ReportId and confirm the report version.
Call DescribeChartList, set ProjectCode to customize_report, and pass in the ReportId to obtain the chart ID.
Call this operation to query chart data. If the report version is 1.0.0, the CharId parameter is required. If the report version is 2.0.0, the ChartId parameter is required. Use the IDs returned by the corresponding report and chart.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

yundun-sas:DescribeChartData

none

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
CharId	string	No	The chart ID. Note Call the DescribeChartList operation to obtain this parameter. This parameter is required if the report version is 1.0.0.	BIZ_STAT_QUERY_SECURITY_SCORE
TimeStart	integer	No	The start timestamp for statistics. Unit: milliseconds.	1683603086000
TimeEnd	integer	No	The end timestamp for statistics. Unit: milliseconds.	1683862286000
Lang	string	No	The language type for the request and response messages. Default value: zh. Valid values: zh: Chinese en: English	zh
ReportId	integer	No	The report ID. Note Call the DescribeCustomizeReportList operation to obtain this parameter.	721734
ChartId	string	No	The chart ID. Note Call the DescribeChartList operation to obtain this parameter. This parameter is required if the report version is 2.0.0.	BIZ_STAT_QUERY_SECURITY_SCORE
ResourceDirectoryAccountId	integer	No	The Alibaba Cloud account ID of the member accounts in the resource directory. Note Call the DescribeMonitorAccounts operation to obtain this parameter.	127608589417****

Response elements

Element	Type	Description	Example
	object
PropertyValue	string	The property value in the chart.	{'totalCount': '0'}
ProperyArrayValue	string	The property array of the chart.	[]
ChartType	string	The chart type. Valid values: timeLine: timeline chart timeBar: time-axis bar chart bar: bar chart line: line chart pie: pie chart gauge: gauge chart table: table text: text	timeBar
ChartDataType	string	The chart data type. Valid values: commonCoordinate: common coordinate timeCoordinate: time-axis coordinate multipleValue: multiple values singleValue: single value propertyValue: property value propertyArrayValue: array property value	propertyArrayValue
CoordinateData	object	The coordinate data.
YAxisList	array<object>	The list of Y-axis values.
	object	The Y-axis value.
Type	string	The data type.	high
Name	string	The data type name.	Port
Value	array	The Y-axis values corresponding to each X-axis point.
	string	The Y-axis value corresponding to the X-axis point.	1
SubType	string	The chart subtype data.	CID_SUSPICIOUS_TREND-AL
XAxis	array	The list of X-axis values.
	string	The X-axis value.	2024-01-01
SingleData	object	The single-value chart data.
Type	string	The data type.	suspicious
Value	integer	The data value of the single-value chart.	172
Name	string	The data type name.	suspicious
MultipleData	array<object>	The multiple-value chart data.
	object	The multiple-value chart.
Type	string	The data type.	safe
Value	integer	The property value.	0
Color	string	The font color in RGBA hexadecimal color code.	#FFA800
Name	string	The data type name.	Safety
RequestId	string	The request ID generated by Alibaba Cloud for this request. You can use this ID to troubleshoot issues.	50CCE62A-2BC4-5CF8-B976-E4F62A31****
ChartSubTypeList	array	The list of selected chart subtype values.
	string	The selected chart subtype value.	["CID_VUL_TREND-CVE", "CID_VUL_TREND-SYS", "CID_VUL_TREND-CMS", "CID_VUL_TREND-APP", "CID_VUL_TREND-EMG"]
AllChartSubTypeList	array<object>	The list of all available subtype values for the chart.
	object
SubType	string	The chart subtype.	CID_SUSPICIOUS_TREND-ALL
SubTypeName	string	The chart subtype name.	All Alerts
PropertyArrayValue	string	The array chart property values.	[]

Examples

Success response

JSON format

{
  "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
400	RdCheckNoPermission	Resource directory account verification has no permission.
500	ServerError	ServerError
500	RdCheckInnerError	Resource directory account service internal error.
403	NoPermission	caller has no permission	You are not authorized to do this operation.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.