All Products
Search
Document Center

Security Center:DescribeWhiteListProcess

Last Updated:Aug 28, 2024

Queries the information about the processes that are detected in an application whitelist policy.

Operation description

The application whitelist feature is in public preview. You cannot apply for a trial of the feature. If you applied for a trial of the feature or the feature is in use, you can call this operation.

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

Request parameters

ParameterTypeRequiredDescriptionExample
SourceIpstringNo

The source IP address of the request. You do not need to specify this parameter. It is automatically obtained by the system.

27.223.XX.XX
LangstringNo

The language of the content within the request and response. Default value: zh. Valid values:

  • zh: Chinese
  • en: English
zh
StrategyIdlongYes

The ID of the policy.

Note You can call the DescribeWhiteListStrategyList operation to obtain the ID.
8562
ProcessNamestringNo

The name of the process.

sys_creat
ProcessTypeintegerNo

The type of the process. Valid values:

  • 1: trusted
  • 2: suspicious
  • 3: malicious
1
OrderByintegerNo

The item based on which you want to sort the returned results. Default value: process type. Valid values:

  • 1: process type
  • 2: degree of trustability
1
DescintegerNo

The sort order. Default value: descending order. Valid values:

  • 1: ascending order
  • 2: descending order
2
PageSizeintegerNo

The number of entries per page. Maximum value: 1000. Default value: 20. If you leave this parameter empty, 20 data entries are returned per page.

Note We recommend that you do not leave this parameter empty.
20
CurrentPageintegerNo

The page number. Default value: 1. Pages start from page 1.

1

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

CurrentPageinteger

The page number.

1
PageSizeinteger

The number of entries per page.

200
RequestIdstring

The request ID.

D81DD78E-E006-5C65-A171-C8CB09XXXXX
TotalCountinteger

The total number of entries returned.

44
Countinteger

The number of entries returned on the current page.

1
Processesarray<object>

The information about the processes.

object

The information about the process.

Statusinteger

Indicates whether the process is trusted. Valid values:

  • 1: no
  • 2: yes
1
ProcessNamestring

The name of the process.

vim
ProcessIdinteger

The ID of the process.

53090
FilePathstring

The path to the process startup file.

/root/bash1
Md5string

The MD5 hash value of the process startup file.

a28e8eba54ece1f3748d80e57dc89400
Idlong

The primary key of the process information.

2100019
Levelinteger

The trust score of the process.

99
ProcessTypeinteger

The type of the process. Valid values:

  • 1: trusted
  • 2: suspicious
  • 3: malicious
1

Examples

Sample success responses

JSONformat

{
  "CurrentPage": 1,
  "PageSize": 200,
  "RequestId": "D81DD78E-E006-5C65-A171-C8CB09XXXXX",
  "TotalCount": 44,
  "Count": 1,
  "Processes": [
    {
      "Status": 1,
      "ProcessName": "vim",
      "ProcessId": 53090,
      "FilePath": "/root/bash1",
      "Md5": "a28e8eba54ece1f3748d80e57dc89400",
      "Id": 2100019,
      "Level": 99,
      "ProcessType": 1
    }
  ]
}

Error codes

HTTP status codeError codeError messageDescription
400-101%s %s-
403NoPermissioncaller has no permissionYou are not authorized to do this operation.
500ServerErrorServerError-

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