DescribeVulWhitelist API Reference - Security Center - Alibaba Cloud - Security Center

Queries vulnerability whitelists by paging.

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:DescribeVulWhitelist

get

*VulWhitelist

acs:yundun-sas:{#regionId}:{#accountId}:vulwhitelist/*

None

Request parameters

Parameter	Type	Required	Description	Example
CurrentPage	integer	No	The page number in paging. Pages start from page 1. Default value: 1.	1
PageSize	integer	No	The number of entries per page in paging. Default value: 10.	10
Lang	string	No	The language of the content within the request and response. Default value: zh. Valid values: zh: Chinese en: English.	zh

Response elements

Element	Type	Description	Example
	object	The response parameters.
CurrentPage	integer	The page number of the current page in paging.	1
RequestId	string	The request ID.	74F97EF7-B543-43FD-A4E9-18456731F9C5
PageSize	integer	The number of entries per page in paging.	10
TotalCount	integer	The total number of entries.	1
Count	integer	The number of entries on the current page in paging.	2
VulWhitelists	array<object>	The list of whitelisted vulnerabilities.
	object	The vulnerability information.
Type	string	The vulnerability type.	cve
TargetInfo	string	The scope of the rule. The value is a JSON string that contains the following fields: type: The applicable type. Valid values: Uuid: host GroupId: group groupIds: The IDs of the applicable asset groups. uuids: The UUIDs of the applicable assets. Note If this value is empty, the rule applies to all assets.	{"type":"GroupId","groupIds":[916****],"uuids":[]}
AliasName	string	The alias of the vulnerability.	RHSA-2017:3263: curl security update
Name	string	The name of the vulnerability.	oval:com.redhat.rhsa:def:20173263
Reason	string	The reason for adding the vulnerability to the whitelist.	ignore
Id	string	The rule ID.	1275
Whitelist	string	The vulnerability information. The value is in JSON format. name: The name of the vulnerability. type: The type of the vulnerability. aliasName: The alias of the vulnerability.	[{ "name":"oval:com.redhat.rhsa:def:20173263", "type":"cve", "aliasName":"RHSA-2017:3263: curl security update" }]

Examples

Success response

JSON format

{
  "CurrentPage": 1,
  "RequestId": "74F97EF7-B543-43FD-A4E9-18456731F9C5",
  "PageSize": 10,
  "TotalCount": 1,
  "Count": 2,
  "VulWhitelists": [
    {
      "Type": "cve",
      "TargetInfo": "{\"type\":\"GroupId\",\"groupIds\":[916****],\"uuids\":[]}",
      "AliasName": "RHSA-2017:3263: curl security update",
      "Name": "oval:com.redhat.rhsa:def:20173263",
      "Reason": "ignore",
      "Id": "1275",
      "Whitelist": "[{\n\"name\":\"oval:com.redhat.rhsa:def:20173263\",\n\"type\":\"cve\",\n\"aliasName\":\"RHSA-2017:3263: curl security update\"\n}]"
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
500	ServerError	ServerError
403	NoPermission	caller has no permission

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.