Query OSS file detection policy configurations with ListOssScanConfig - Security Center - Alibaba Cloud - Security Center

Queries the list of OSS file scan policy configurations.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

yundun-sas:ListOssScanConfig

list

*OssScanConfig

acs:yundun-sas:*:{#accountId}:ossscanconfig/*

None

Request parameters

Parameter	Type	Required	Description	Example
CurrentPage	integer	No	The current page number for paged queries.	1
PageSize	integer	No	The maximum number of entries to display on each page for paged queries.	20
Name	string	No	The policy name.	testName
Source	string	No	The business source. Valid values: OSS: OSS NAS: NAS	OSS

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID. It is a unique identifier generated by Alibaba Cloud for the request and can be used to troubleshoot and locate issues.	E10BAF1C-A6C5-51E2-866C-76D5922E****
PageInfo	object	The pagination information.
CurrentPage	integer	The current page number for paged queries.	1
PageSize	integer	The maximum number of entries displayed per page for paged queries.	20
TotalCount	integer	The total number of entries.	50
Data	array<object>	The returned data.
	object	The data details.
Id	integer	The configuration ID.	443496
Enable	integer	Specifies whether the configuration is enabled. Valid values: 1: Enabled. 0: Disabled.	1
Name	string	The configuration name.	test****
ScanDayList	array	The scan days. Each number represents a day of the week.
	integer	The scan days. Each number represents a day of the week.	1
StartTime	string	The detection start time in HH:mm:ss format.	00:00:00
EndTime	string	The detection end time in HH:mm:ss format.	06:00:00
BucketNameList	array	The list of bucket names.
	string	The bucket name.	amssev-oss****
KeySuffixList	array	The list of file suffixes to scan.
	string	The file suffix to scan.	.asp
KeyPrefixList	array	The list of file directories to scan.
	string	The file directory to scan.	/root
LastUpdateTime	integer	The last update timestamp.	1698388233883
BucketCount	integer	The number of buckets.	10
AllKeyPrefix	boolean	Specifies whether all prefixes are matched.	true
DecompressMaxLayer	integer	The maximum number of decompression layers for nested compressed archives. The minimum value is 1 and the maximum value is 5. If the maximum number of layers is exceeded, the decompression operation stops immediately. Files that have already been extracted are still scanned.	1
DecompressMaxFileCount	integer	The maximum number of files to extract. The minimum value is 1 and the maximum value is 1000. If the maximum number of files is exceeded, the decompression operation stops immediately. Files that have already been extracted are still scanned.	100
DecryptionList	array	The list of decryption types.
	string	The decryption type. Valid values: OSS: OSS fully managed. KMS: KMS.	KMS
LastModifiedStartTime	integer	The timestamp in milliseconds. Only files whose last modification time is after this timestamp are scanned.	1724301769834
RealTimeIncr	boolean	Specifies whether real-time incremental detection is enabled. If this parameter is set to true, the ScanDayList, StartTime, and EndTime parameters do not take effect.	true
Source	string	The business source. Valid values: OSS: OSS NAS: NAS	OSS
AutoAdd	integer	Specifies whether to automatically add new buckets to the scan policy. Valid values: 0 (disabled) and 1 (enabled).	0
AutoAddConfigName	string	The configuration name used when automatically adding buckets.

Examples

Success response

JSON format

{
  "RequestId": "E10BAF1C-A6C5-51E2-866C-76D5922E****",
  "PageInfo": {
    "CurrentPage": 1,
    "PageSize": 20,
    "TotalCount": 50
  },
  "Data": [
    {
      "Id": 443496,
      "Enable": 1,
      "Name": "test****",
      "ScanDayList": [
        1
      ],
      "StartTime": "00:00:00\n",
      "EndTime": "06:00:00",
      "BucketNameList": [
        "amssev-oss****"
      ],
      "KeySuffixList": [
        ".asp"
      ],
      "KeyPrefixList": [
        "/root"
      ],
      "LastUpdateTime": 1698388233883,
      "BucketCount": 10,
      "AllKeyPrefix": true,
      "DecompressMaxLayer": 1,
      "DecompressMaxFileCount": 100,
      "DecryptionList": [
        "KMS"
      ],
      "LastModifiedStartTime": 1724301769834,
      "RealTimeIncr": true,
      "Source": "OSS",
      "AutoAdd": 0,
      "AutoAddConfigName": ""
    }
  ]
}

Error codes

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

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.