All Products
Search
Document Center

Security Center:GetVirusScanConfig

Last Updated:Nov 25, 2024

Queries the configurations of a periodic virus scan task.

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

Request parameters

ParameterTypeRequiredDescriptionExample
TaskTypestringNo

The type of the task. Valid values:

  • VIRUS_VUL_SCHEDULE_SCAN: a virus scan task.
VIRUS_VUL_SCHEDULE_SCAN

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The request ID.

028CF634-5268-5660-9575-48C9ED6BDEFC
Dataobject

The data returned if the request was successful.

SelectionKeystring

The key that stores the asset information.

Note You can call the GetAssetSelectionConfig operation to obtain the key value.
345ddbea-a57f-437e-832f-fb7a1202xxxx
TaskTypestring

The type of the task. Valid value:

  • VIRUS_VUL_SCHEDULE_SCAN: a virus scan task.
VIRUS_VUL_SCHEDULE_SCAN
ScanTypestring

The type of the virus scan task. Valid values:

  • system: automatic scan.
  • user: custom scan.
user
ScanPatharray

The file paths.

scanPathstring

The path of the file that was scanned. This parameter is returned if ScanType is set to user.

/root
PeriodUnitstring

The unit of the interval at which virus scan tasks are run.

  • The value is fixed as day.
day
TargetStartTimeinteger

The start time of the virus scan task. The time is a time frame.

0
TargetEndTimeinteger

The end time of the virus scan task. The time is a time frame.

6
IntervalPeriodinteger

The interval at which virus scan tasks are run.

7
Enableinteger

Indicates whether the periodic scan feature is enabled. Valid value:

  • 1: The feature is enabled
  • 0: The feature is disabled.
1
ConfigIdstring

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 codeError codeError messageDescription
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
No change history