ListOssBucketScanInfo - Security Center - Alibaba Cloud Documentation Center

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

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

Parameter	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	object []	The data returned.
BucketName	string	The name of the bucket.	hz-new02****
RegionId	string	The region ID.	cn-hangzhou
LastScanTime	long	The time when the bucket was last checked. Unit: milliseconds.	1698388233883
LastScanEndTime	long	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	long	The number of objects that are checked.	100
TotalObject	long	The total number of objects in the bucket.	100
HighRisk	long	The number of high-risk objects.	0
MediumRisk	long	The number of medium-risk objects.	0
LowRisk	long	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.	1

Examples

Sample success responses

JSONformat

{
  "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": 1
    }
  ]
}

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.

Change history

Change time

Summary of changes

Operation

2023-12-07

The Error code has changed. The response structure of the API has changed

see changesets

Change item	Change content
Error Codes	The Error code has changed.
	delete Error Codes: 403
	delete Error Codes: 500
Output Parameters	The response structure of the API has changed.