GetVirusScanConfig - Security Center - Alibaba Cloud Documentation Center

Queries the configurations of a periodic virus scan task.

Debugging

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

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
TaskType	string	No	The type of the task. Valid values: VIRUS_VUL_SCHEDULE_SCAN: a virus scan task.	VIRUS_VUL_SCHEDULE_SCAN

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The request ID.	028CF634-5268-5660-9575-48C9ED6BDEFC
Data	object	The data returned if the request was successful.
SelectionKey	string	The key that stores the asset information. Note You can call the GetAssetSelectionConfig operation to obtain the key value.	345ddbea-a57f-437e-832f-fb7a1202xxxx
TaskType	string	The type of the task. Valid value: VIRUS_VUL_SCHEDULE_SCAN: a virus scan task.	VIRUS_VUL_SCHEDULE_SCAN
ScanType	string	The type of the virus scan task. Valid values: system: automatic scan. user: custom scan.	user
ScanPath	array	The file paths.
	string	The path of the file that was scanned. This parameter is returned if ScanType is set to user.	/root
PeriodUnit	string	The unit of the interval at which virus scan tasks are run. The value is fixed as day.	day
TargetStartTime	integer	The start time of the virus scan task. The time is a time frame.	0
TargetEndTime	integer	The end time of the virus scan task. The time is a time frame.	6
IntervalPeriod	integer	The interval at which virus scan tasks are run.	7
Enable	integer	Indicates whether the periodic scan feature is enabled. Valid value: 1: The feature is enabled 0: The feature is disabled.	1
ConfigId	string	The ID of the task configuration. Note You can call the DescribeCycleTaskList operation to query the IDs of task configurations.	97a1fed216908e417407344e1505xxxx

Examples

Sample success responses

JSONformat

{
  "RequestId": "028CF634-5268-5660-9575-48C9ED6BDEFC",
  "Data": {
    "SelectionKey": "345ddbea-a57f-437e-832f-fb7a1202xxxx",
    "TaskType": "VIRUS_VUL_SCHEDULE_SCAN",
    "ScanType": "user",
    "ScanPath": [
      "/root"
    ],
    "PeriodUnit": "day",
    "TargetStartTime": 0,
    "TargetEndTime": 6,
    "IntervalPeriod": 7,
    "Enable": 1,
    "ConfigId": "97a1fed216908e417407344e1505xxxx"
  }
}

Error codes

HTTP status code	Error code	Error message	Description
403	NoPermission	caller has no permission	You are not authorized to do this operation.
500	ServerError	ServerError	-

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