All Products
Search
Document Center

Security Center:DescribeVulWhitelist

Last Updated:Feb 20, 2024

Queries the whitelist of vulnerabilities by page.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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.
OperationAccess levelResource typeCondition keyAssociated operation
yundun-sas:DescribeVulWhitelistRead
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
CurrentPageintegerNo

The number of the page to return. Pages start from page 1. Default value: 1.

1
PageSizeintegerNo

The number of entries to return on each page. Default value: 10.

10

Response parameters

ParameterTypeDescriptionExample
object

The returned data.

CurrentPageinteger

The page number of the returned page.

1
RequestIdstring

The ID of the request.

74F97EF7-B543-43FD-A4E9-18456731F9C5
PageSizeinteger

The number of entries returned per page.

10
TotalCountinteger

The total number of entries returned.

1
Countinteger

The number of entries returned on the current page.

2
VulWhitelistsobject []

An array that consists of information about the whitelist of vulnerabilities.

Typestring

The type of the vulnerability.

cve
TargetInfostring

The application scope of the rule. The value is a JSON string that contains the following fields:

  • type: the type of the assets to which the rule is applied. Valid values:

    • Uuid: server
    • GroupId: server group
  • groupIds: the ID of the server group

  • uuids: the UUID of the server

Note If this field is empty, the rule is applied to all assets.
{"type":"GroupId","groupIds":[916****],"uuids":[]}
AliasNamestring

The alias of the vulnerability.

RHSA-2017:3263: curl security update
Namestring

The name of the vulnerability.

oval:com.redhat.rhsa:def:20173263
Reasonstring

The reason why the vulnerability is added to the whitelist.

ignore
Idstring

The ID of the rule.

1275
Whiteliststring

The information about the vulnerability. The value of this parameter is in the JSON format. Valid values:

  • 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

Sample success responses

JSONformat

{
  "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 codeError codeError messageDescription
403NoPermissioncaller has no permissionYou are not authorized to do this operation.
500ServerErrorServerError-

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

Change history

Change timeSummary of changesOperation
No change history