All Products
Search
Document Center

Security Center:GetVulWhitelist

Last Updated:Nov 25, 2024

Queries information about a vulnerability whitelist.

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.

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:GetVulWhitelistget
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
VulWhitelistIdlongNo

The ID of the whitelist.

1275

Response parameters

ParameterTypeDescriptionExample
object

The data returned.

RequestIdstring

The ID of the request, which is used to locate and troubleshoot issues.

09969D2C-4FAD-429E-BFBF-9A60DEF8BF6F
VulWhitelistobject

The information about the whitelist.

Idlong

The ID of the whitelist.

1275
Namestring

The name of the vulnerability.

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

The type of the vulnerability.

cve
AliasNamestring

The alias of the vulnerability.

RHSA-2017:3263: curl security update
Reasonstring

The reason why the vulnerability is added to the whitelist.

Ignore
Targetstring

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 parameter is empty, the rule is applied to all types of assets.
{ "type": "GroupId", "uuids": [], "groupIds": [ 10782678 ] }
Whiteliststring

The information about the vulnerability that is added to the whitelist. The value is a JSON string that contains the following fields:

  • Name: the name of the vulnerability.

  • Type: the type of the vulnerability. Valid values:

    • cve: Linux software vulnerability
    • sys: Windows system vulnerability
    • cms: Web-CMS vulnerability
    • app: application vulnerability
    • emg: urgent vulnerabilities
  • 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

{
  "RequestId": "09969D2C-4FAD-429E-BFBF-9A60DEF8BF6F",
  "VulWhitelist": {
    "Id": 1275,
    "Name": "oval:com.redhat.rhsa:def:20173263",
    "Type": "cve",
    "AliasName": "RHSA-2017:3263: curl security update",
    "Reason": "Ignore\n",
    "Target": "{\n      \"type\": \"GroupId\",\n      \"uuids\": [],\n      \"groupIds\": [\n            10782678\n      ]\n}",
    "Whitelist": "[\n      {\n            \"Name\": \"oval:com.redhat.rhsa:def:20173263\",\n            \"Type\": \"cve\",\n            \"AliasName\": \"RHSA-2017:3263: curl security update\"\n      }\n]"
  }
}

Error codes

HTTP status codeError codeError messageDescription
400InvalidIdInvalid ID.-
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
2023-12-06The Error code has changedView Change Details