ListDockerhubImage API Overview for Docker Hub Risk Detection - Security Center - Alibaba Cloud - Security Center

Queries the risk overview of official Docker Hub images.

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

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Query	string	Yes	The image query condition. The format is `[namespace/]repoName[:version]`. The query conditions in `[]` are optional.	python:3.9

Response elements

Element	Type	Description	Example
	object
RequestId	string	The unique identifier that Alibaba Cloud generates for the request.	F8B6F758-BCD4-597A-8A2C-DA5A552C****
ImageList	array<object>	The list of image information.
	object
Uuid	string	The UUID of the image.	a9b50827-801f-414c-900d-c4a223d*****
ImageSize	integer	The image size, in bytes.	1024
Digest	string	The digest value of the image.	5ffded22661b0f1e9c7fcccb0d488cff*****f8c52a819bd7179ef3e4a041988
HcCount	integer	The number of baseline risks.	0
Tag	string	The image tag.	3.9
VulCount	integer	The number of detected vulnerabilities.	0
ImageId	string	The image ID.	d943de1933650d74b415d3ae8b37c064a0e0c700574d7a949c26db3291******
RepoName	string	The image repository name.	python
RepoNamespace	string	The image namespace.	python
RiskLevelDetail	string	The risk details of the image.	{"vul":0}

Examples

Success response

JSON format

{
  "RequestId": "F8B6F758-BCD4-597A-8A2C-DA5A552C****",
  "ImageList": [
    {
      "Uuid": "a9b50827-801f-414c-900d-c4a223d*****",
      "ImageSize": 1024,
      "Digest": "5ffded22661b0f1e9c7fcccb0d488cff*****f8c52a819bd7179ef3e4a041988",
      "HcCount": 0,
      "Tag": "3.9",
      "VulCount": 0,
      "ImageId": "d943de1933650d74b415d3ae8b37c064a0e0c700574d7a949c26db3291******",
      "RepoName": "python",
      "RepoNamespace": "python",
      "RiskLevelDetail": "{\"vul\":0}"
    }
  ]
}

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.