Querying a Custom Scan Policy List

Function

This API is used to query the custom scan policy list.

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}/antivirus/policy

**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

**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.
offset	Yes	Integer	Definition Offset, which specifies the start position of the record to be returned. Constraints N/A Range The value range is 0 to 2,000,000. Default Value N/A
limit	Yes	Integer	Definition Number of records displayed on each page. Constraints N/A Range Value range: 10 to 200 Default Value 10
policy_name	No	String	Policy name

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
total_num	Integer	Definition Total number. Range The value range is 0 to 2,147,483,647.
data_list	Array of AntiVirusPolicyResponseInfo objects	data list

**Table 5** AntiVirusPolicyResponseInfo
Parameter	Type	Description
policy_id	String	Policy ID
policy_name	String	Policy name
start_type	String	Definition Startup mode. Range Its value can be: now: Start now. later: Start later. period: Start periodically.
scan_period	String	Start type. Its value can be: day: every day week: weekly month: every month
scan_period_date	Integer	Scan period date. (1-28) When the scan period is week, 1-7 indicates Sunday to Saturday. When the scan period is month, 1-28 indicates the first day to 28th day of each month.
scan_time	Integer	Scan timestamp, in milliseconds. (This parameter is valid only when the startup type is later.)
scan_hour	Integer	Scan hours (The parameter is available only when the startup type is period.)
scan_minute	Integer	Scan minutes (This parameter is valid only when the startup type is period.)
next_start_time	Integer	Next startup time, in milliseconds
scan_dir	String	Scan directories. Use semicolons (;) to separate multiple directories.
ignore_dir	String	Excluded directories. Use semicolons (;) to separate multiple directories.
action	String	Definition Action Range auto: automatic handling manual: manual handling
invalidate	Boolean	Invalid. The options are as follows: true: yes false: no
host_num	Integer	Definition Number of affected servers. Range The value range is 0 to 2,147,483,647.
host_info_list	Array of AntiVirusPolicyHostResponseInfo objects	Server information
whether_paid_task	Boolean	Whether the scan task is paid.
file_type_list	Array of integers	File type set

**Table 6** AntiVirusPolicyHostResponseInfo
Parameter	Type	Description
host_id	String	Definition Unique ID of a server (host). Range The value can contain 1 to 64 characters.
host_name	String	Definition Server name. Range The value can contain 1 to 256 characters.
private_ip	String	Definition Server private IP address. Range The value can contain 1 to 128 characters.
public_ip	String	Definition Elastic IP Address (EIP) Range The value is a string of 1 to 256 characters and can be an IPv4 or IPv6 address. (An IPv4 address can contain 7 to 15 characters. An IPv6 address can contain 15 to 39 characters.)
asset_value	String	Definition Asset importance. Range important common test

Example Requests

None

Example Responses

Status code: 200

Request succeeded.

{
  "total_num" : 85,
  "data_list" : [ {
    "policy_id" : "16***0dc-94cb-4ca3-9087-06***cd168c1",
    "policy_name" : "Custom Scan - 20240418173443",
    "start_type" : "period",
    "scan_period" : "day",
    "scan_hour" : 17,
    "scan_minute" : 40,
    "next_start_time" : 1737538800000,
    "file_type_list" : [ 1, 2, 3, 4, 6 ],
    "scan_dir" : "",
    "ignore_dir" : "/test",
    "action" : "manual",
    "invalidate" : true,
    "host_num" : 0,
    "host_info_list" : [ ],
    "whether_paid_task" : false
  } ]
}