Querying Details About a Process Whitelist Policy

Function

This API is used to query details about a process whitelist policy.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
If you are using identity policy-based authorization, no identity policy-based permission required for calling this API.

URI

GET /v5/{project_id}/app/{policy_id}/detail

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition Project ID, which is used to specify the project that an asset belongs to. After the project ID is configured, you can query assets in the project using the project ID. For details about how to obtain it, see Obtaining a Project ID. Constraints N/A Range The value can contain 1 to 256 characters. Default Value N/A
policy_id	Yes	String	Definition Policy ID. Constraints Mandatory. Range The value can contain 1 to 64 characters. Default Value N/A

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
enterprise_project_id	No	String	Definition Enterprise project ID, which is used to filter assets in different enterprise projects. For details, see Obtaining an Enterprise Project ID. To query assets in all enterprise projects, set this parameter to all_granted_eps. Constraints You need to set this parameter only after the enterprise project function is enabled. Range The value can contain 1 to 256 characters. Default Value 0: default enterprise project.

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition User token, which contains user identity and permissions. The token can be used for identity authentication when an API is called. For details about how to obtain the token, see Obtaining a User Token. Constraints N/A Range The value can contain 1 to 32,768 characters. Default Value N/A

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
policy_id	String	Policy ID
policy_name	String	Policy name
policy_type	String	Definition Process whitelist policy type. Range block: conservative mode
intercept	Boolean	Definition Whether to enable blocking. Range true: Yes false: No
update_time	Integer	Update time, in milliseconds
total_num	Integer	Definition Total number of processes. Range The value range is 0 to 2,147,483,647.
unconfirmed_num	Integer	Definition Processes to be confirmed. Range The value range is 0 to 2,147,483,647.
trust_num	Integer	Definition Number of identified trustworthy processes. Range The value range is 0 to 2,147,483,647.
suspicious_num	Integer	Definition Number of identified suspicious processes. Range The value range is 0 to 2,147,483,647.
malicious_num	Integer	Definition Number of identified malicious processes. Range The value range is 0 to 2,147,483,647.
unknown_num	Integer	Definition Number of identified unknown processes. Range The value range is 0 to 2,147,483,647.
auto_apply	Boolean	Definition Whether to automatically apply a policy. Range true: Yes false: No

Example Requests

None

Example Responses

Status code: 200

Request succeeded.

{
  "policy_id" : "5b0ab452-e5d2-473e-a313-23eca885ee28",
  "policy_name" : "app_whitelist_h00657476",
  "policy_type" : "block",
  "intercept" : false,
  "auto_apply" : true,
  "update_time" : 1753189843022,
  "total_num" : 78,
  "unconfirmed_num" : 0,
  "trust_num" : 78,
  "suspicious_num" : 0,
  "malicious_num" : 0,
  "unknown_num" : 0
}