Docker Hub Image Risk Statistics API Overview - Security Center - Alibaba Cloud - Security Center

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

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Types	array	No	The risk types that you want to query.
	string	No	The dimension by which to query image risk statistics. Valid values: totalScanned: the number of scanned Docker Hub images. vulAsap: the number of high-risk vulnerabilities. baseline: the number of baselines.	totalScanned

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	7532B7EE-7CE7-5F4D-BF04-B12447DD****
RiskRankInfo	object	The information about the risk source.
ScanTime	integer	The timestamp when the scan was performed.	1693997625000
ScanTimeTimestamp	integer	The timestamp when the scan was performed.	1693997625000
VulAsap	integer	The number of high-risk vulnerabilities.	1
Baseline	integer	The number of baseline risks.	1
TotalScanned	integer	The number of scanned Docker Hub images.	1

Examples

Success response

JSON format

{
  "RequestId": "7532B7EE-7CE7-5F4D-BF04-B12447DD****",
  "RiskRankInfo": {
    "ScanTime": 1693997625000,
    "ScanTimeTimestamp": 1693997625000,
    "VulAsap": 1,
    "Baseline": 1,
    "TotalScanned": 1
  }
}

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.