Call GetOssBucketScanStatistic to query OSS bucket scan statistics - Security Center - Alibaba Cloud - Security Center

Retrieves OSS scan statistics.

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

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
BucketNameList	array	No	The list of bucket names.
	string	No	The bucket name.	hz-new02****
Source	string	No	The data source. Valid values: API: API-based scan. OSS: OSS-based scan.	API

Response elements

Element	Type	Description	Example
	object
RequestId	string	The ID of the request. The China Chinese system generates a unique identifier for the request. You can use the ID to troubleshoot issues.	FAC50208-E56B-5CC8-8738-2B219D1A****
Data	object	The returned data.
RiskBucket	integer	The number of buckets that contain risky files.	1
HighRisk	integer	The number of high-risk files.	0
MediumRisk	integer	The number of medium-risk files.	0
LowRisk	integer	The number of low-risk files.	0
NoScanBucket	integer	The number of buckets that have not been scanned.	1
TotalBucket	integer	The total number of buckets.	1
ScanObject	integer	The number of scanned files.	1
RemainAuth	integer	The remaining number of authorizations.	1
ExpireTime	integer	The timestamp when the authorization expires.	1714442403000
TotalObject	integer	The total number of files in the buckets.	1
PrePayAuthCount	integer	The number of prepaid authorization times.	10000
PrePayInvokeCount	integer	The number of prepaid invocations used.	100
PostPayInvokeCount	integer	The number of pay-as-you-go invocations used.	1000

Examples

Success response

JSON format

{
  "RequestId": "FAC50208-E56B-5CC8-8738-2B219D1A****",
  "Data": {
    "RiskBucket": 1,
    "HighRisk": 0,
    "MediumRisk": 0,
    "LowRisk": 0,
    "NoScanBucket": 1,
    "TotalBucket": 1,
    "ScanObject": 1,
    "RemainAuth": 1,
    "ExpireTime": 1714442403000,
    "TotalObject": 1,
    "PrePayAuthCount": 10000,
    "PrePayInvokeCount": 100,
    "PostPayInvokeCount": 1000
  }
}

Error codes

HTTP status code	Error code	Error message	Description
500	ServerError	ServerError
403	NoPermission	caller has no permission

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.