Use ListOssBucketScanInfo to query risk and scan information for OSS buckets - Security Center

Queries the risk information of an Object Storage Service (OSS) bucket.

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:ListOssBucketScanInfo

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
CurrentPage	integer	Yes	The page number.	1
PageSize	integer	Yes	The number of entries per page.	20
BucketName	string	No	The name of the bucket.	iboxpublic****
Status	integer	No	The check status of the bucket. Valid values: 1: The bucket is not checked. 2: All objects in the bucket are being checked. 3: Only new objects in the bucket are being checked. 4: The bucket is checked.	1
HasRisk	integer	No	Specifies whether at-risk objects are detected. Valid values: 0: No at-risk objects are detected. 1: At-risk objects are detected.	1
FuzzBucketName	string	No	The name of the bucket that is used for fuzzy match.	test
Lang	string	No	The language of the content in the request and response. Default value: zh. Valid values: zh: Chinese. en: English.	zh

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	6C578F36-92D2-552C-8AA0-86EB1AC2****
PageInfo	object	The page information.
CurrentPage	integer	The page number.	1
PageSize	integer	The number of entries per page.	20
TotalCount	integer	The total number of entries returned.	165
Data	array<object>	The data returned.
	object
BucketName	string	The name of the bucket.	hz-new02****
RegionId	string	The region ID.	cn-hangzhou
LastScanTime	integer	The time when the bucket was last checked. Unit: milliseconds.	1698388233883
LastScanEndTime	integer	The time when the most recent check ended. Unit: milliseconds.	1698388233883
Scanned	boolean	Indicates whether the bucket is checked. Valid values: true false	false
ScanObject	integer	The number of objects that are checked.	100
TotalObject	integer	The total number of objects in the bucket.	100
HighRisk	integer	The number of high-risk objects.	0
MediumRisk	integer	The number of medium-risk objects.	0
LowRisk	integer	The number of low-risk objects.	0
Status	integer	The check status of the bucket. Valid values: 1: The bucket is not checked. 2: All objects in the bucket are being checked. 3: Only new objects are being checked. 4: The bucket is checked.	1
Support	boolean	Indicates whether the bucket can be checked. Valid values: true false	true
Message	string	The reason why the bucket cannot be checked.	Unsupported Region.
StorageClass	string	The storage class of the bucket. Valid values: Standard IA Archive ColdArchive	Archive
ConfigStatus	integer	Configuration status, valid values: 0: No Configuration. 1: Not Open. 2: Open.	0
DecompressStatus	integer	Bucket decompression configuration status, valid values: 0: Decompression not configured. 1: Decompression configured.	0

Examples

Success response

JSON format

{
  "RequestId": "6C578F36-92D2-552C-8AA0-86EB1AC2****",
  "PageInfo": {
    "CurrentPage": 1,
    "PageSize": 20,
    "TotalCount": 165
  },
  "Data": [
    {
      "BucketName": "hz-new02****",
      "RegionId": "cn-hangzhou",
      "LastScanTime": 1698388233883,
      "LastScanEndTime": 1698388233883,
      "Scanned": false,
      "ScanObject": 100,
      "TotalObject": 100,
      "HighRisk": 0,
      "MediumRisk": 0,
      "LowRisk": 0,
      "Status": 1,
      "Support": true,
      "Message": "Unsupported Region.",
      "StorageClass": "Archive",
      "ConfigStatus": 0,
      "DecompressStatus": 0
    }
  ]
}

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.