GetDockerhubImageRiskRankInfo API Overview - Security Center - Alibaba Cloud - Security Center

Queries the rankings of images by various dimensions.

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

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Types	array	No	The image dimension types to query.
	string	No	The image dimension types to query. Valid values: vulAsap: vulnerability scan statistics. baseline: baseline check scan statistics.	baseline

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID. Alibaba Cloud generates a unique ID for each request. You can use the ID to troubleshoot issues.	30CBF632-109F-596F-97F2-451C8B2A****
RiskRankInfo	object	The risk information.
VulAsap	array<object>	The risk information about high-priority vulnerabilities.
	object	The risk information about high-priority vulnerabilities.
Uuid	string	The UUID of the record.	6636c286-8063-4c97-8508-6aaf16a8****
ImageSize	integer	The image size.	1024
Digest	string	The digest value of the image.	d97c1348e56eb52902888e6e5673623321b1f19ac45ed532c3114dc0f989****
HcCount	integer	The number of risks detected on the image repository.	0
Tag	string	The tag of the image.	app:app01-ubuntu
VulCount	integer	The number of vulnerabilities.	1
ImageId	string	The image ID.	fabe4203a89765a2c99554040bda51eac7885a18216f4ac0be82710cff60****
RepoName	string	The name of the image repository.	lkl-zf-ss-ordapi-labs
RepoNamespace	string	The namespace to which the image repository belongs.	namespace-01
RiskLevelDetail	string	The risk statistics of all hosts, images, and containers.	{\"account\":0,\"agentlessAll\":0,\"agentlessBaseline\":0,\"agentlessMalicious\":0,\"agentlessSensitiveFile\":0,\"agentlessVulCve\":0,\"agentlessVulSca\":0,\"agentlessVulSys\":0,\"appNum\":0,\"asapVulCount\":0,\"baselineHigh\":0,\"baselineLow\":0,\"baselineMedium\":0,\"baselineNum\":0,\"cmsNum\":0,\"containerAsap\":0,\"containerLater\":0,\"containerNntf\":0,\"containerRemind\":0,\"containerSerious\":0,\"containerSuspicious\":0,\"cveNum\":513,\"emgNum\":0,\"health\":0,\"imageBaselineHigh\":0,\"imageBaselineLow\":0,\"imageBaselineMedium\":0,\"imageBaselineNum\":0,\"imageMaliciousFileRemind\":0,\"imageMaliciousFileSerious\":0,\"imageMaliciousFileSuspicious\":0,\"imageVulAsap\":3,\"imageVulLater\":182,\"imageVulNntf\":328,\"laterVulCount\":0,\"newSuspicious\":0,\"nntfVulCount\":0,\"remindNum\":0,\"scaNum\":0,\"seriousNum\":0,\"suspNum\":0,\"suspicious\":0,\"sysNum\":0,\"trojan\":0,\"uuid\":\"44ffb29d6f66d8509598bcdfa660a21d\",\"vul\":513,\"weakPWNum\":0}
Baseline	array<object>	The baseline risk information.
	object	The baseline risk information struct.
Uuid	string	The UUID of the record.	5583aa03-922e-4709-a888-389f2489****
ImageSize	integer	The image size.	1024
Digest	string	The digest value of the image.	f28ecca63bfaf22ead4b28b63d752a21e4d2c1de90b8549fbde880d619f3****
HcCount	integer	The number of baseline risks detected on the image repository.	1
Tag	string	The tag of the image.	machineResource
VulCount	integer	The number of detected vulnerabilities.	1
ImageId	string	The ID of the image.	7c5ad02865aef575387a05bb3c81b27e0d8ed1f2e3f722ea05523b72882f****
RepoName	string	The name of the Container Registry repository.	glz123
RepoNamespace	string	The namespace to which the repository belongs.	namespace-01
RiskLevelDetail	string	The risk statistics of all hosts, images, and containers.	{\"account\":0,\"agentlessAll\":0,\"agentlessBaseline\":0,\"agentlessMalicious\":0,\"agentlessSensitiveFile\":0,\"agentlessVulCve\":0,\"agentlessVulSca\":0,\"agentlessVulSys\":0,\"appNum\":0,\"asapVulCount\":0,\"baselineHigh\":0,\"baselineLow\":0,\"baselineMedium\":0,\"baselineNum\":0,\"cmsNum\":0,\"containerAsap\":0,\"containerLater\":0,\"containerNntf\":0,\"containerRemind\":0,\"containerSerious\":0,\"containerSuspicious\":0,\"cveNum\":0,\"emgNum\":0,\"health\":0,\"imageBaselineHigh\":1,\"imageBaselineLow\":0,\"imageBaselineMedium\":0,\"imageBaselineNum\":1,\"imageMaliciousFileRemind\":0,\"imageMaliciousFileSerious\":0,\"imageMaliciousFileSuspicious\":0,\"imageVulAsap\":0,\"imageVulLater\":0,\"imageVulNntf\":0,\"laterVulCount\":0,\"newSuspicious\":0,\"nntfVulCount\":0,\"remindNum\":0,\"scaNum\":0,\"seriousNum\":0,\"suspNum\":0,\"suspicious\":0,\"sysNum\":0,\"trojan\":0,\"uuid\":\"009635bf00c0585e3122ab92f5449919\",\"vul\":0,\"weakPWNum\":0}

Examples

Success response

JSON format

{
  "RequestId": "30CBF632-109F-596F-97F2-451C8B2A****",
  "RiskRankInfo": {
    "VulAsap": [
      {
        "Uuid": "6636c286-8063-4c97-8508-6aaf16a8****",
        "ImageSize": 1024,
        "Digest": "d97c1348e56eb52902888e6e5673623321b1f19ac45ed532c3114dc0f989****",
        "HcCount": 0,
        "Tag": "app:app01-ubuntu",
        "VulCount": 1,
        "ImageId": "fabe4203a89765a2c99554040bda51eac7885a18216f4ac0be82710cff60****",
        "RepoName": "lkl-zf-ss-ordapi-labs",
        "RepoNamespace": "namespace-01",
        "RiskLevelDetail": "{\\\"account\\\":0,\\\"agentlessAll\\\":0,\\\"agentlessBaseline\\\":0,\\\"agentlessMalicious\\\":0,\\\"agentlessSensitiveFile\\\":0,\\\"agentlessVulCve\\\":0,\\\"agentlessVulSca\\\":0,\\\"agentlessVulSys\\\":0,\\\"appNum\\\":0,\\\"asapVulCount\\\":0,\\\"baselineHigh\\\":0,\\\"baselineLow\\\":0,\\\"baselineMedium\\\":0,\\\"baselineNum\\\":0,\\\"cmsNum\\\":0,\\\"containerAsap\\\":0,\\\"containerLater\\\":0,\\\"containerNntf\\\":0,\\\"containerRemind\\\":0,\\\"containerSerious\\\":0,\\\"containerSuspicious\\\":0,\\\"cveNum\\\":513,\\\"emgNum\\\":0,\\\"health\\\":0,\\\"imageBaselineHigh\\\":0,\\\"imageBaselineLow\\\":0,\\\"imageBaselineMedium\\\":0,\\\"imageBaselineNum\\\":0,\\\"imageMaliciousFileRemind\\\":0,\\\"imageMaliciousFileSerious\\\":0,\\\"imageMaliciousFileSuspicious\\\":0,\\\"imageVulAsap\\\":3,\\\"imageVulLater\\\":182,\\\"imageVulNntf\\\":328,\\\"laterVulCount\\\":0,\\\"newSuspicious\\\":0,\\\"nntfVulCount\\\":0,\\\"remindNum\\\":0,\\\"scaNum\\\":0,\\\"seriousNum\\\":0,\\\"suspNum\\\":0,\\\"suspicious\\\":0,\\\"sysNum\\\":0,\\\"trojan\\\":0,\\\"uuid\\\":\\\"44ffb29d6f66d8509598bcdfa660a21d\\\",\\\"vul\\\":513,\\\"weakPWNum\\\":0}"
      }
    ],
    "Baseline": [
      {
        "Uuid": "5583aa03-922e-4709-a888-389f2489****",
        "ImageSize": 1024,
        "Digest": "f28ecca63bfaf22ead4b28b63d752a21e4d2c1de90b8549fbde880d619f3****",
        "HcCount": 1,
        "Tag": "machineResource",
        "VulCount": 1,
        "ImageId": "7c5ad02865aef575387a05bb3c81b27e0d8ed1f2e3f722ea05523b72882f****",
        "RepoName": "glz123",
        "RepoNamespace": "namespace-01\n",
        "RiskLevelDetail": "{\\\"account\\\":0,\\\"agentlessAll\\\":0,\\\"agentlessBaseline\\\":0,\\\"agentlessMalicious\\\":0,\\\"agentlessSensitiveFile\\\":0,\\\"agentlessVulCve\\\":0,\\\"agentlessVulSca\\\":0,\\\"agentlessVulSys\\\":0,\\\"appNum\\\":0,\\\"asapVulCount\\\":0,\\\"baselineHigh\\\":0,\\\"baselineLow\\\":0,\\\"baselineMedium\\\":0,\\\"baselineNum\\\":0,\\\"cmsNum\\\":0,\\\"containerAsap\\\":0,\\\"containerLater\\\":0,\\\"containerNntf\\\":0,\\\"containerRemind\\\":0,\\\"containerSerious\\\":0,\\\"containerSuspicious\\\":0,\\\"cveNum\\\":0,\\\"emgNum\\\":0,\\\"health\\\":0,\\\"imageBaselineHigh\\\":1,\\\"imageBaselineLow\\\":0,\\\"imageBaselineMedium\\\":0,\\\"imageBaselineNum\\\":1,\\\"imageMaliciousFileRemind\\\":0,\\\"imageMaliciousFileSerious\\\":0,\\\"imageMaliciousFileSuspicious\\\":0,\\\"imageVulAsap\\\":0,\\\"imageVulLater\\\":0,\\\"imageVulNntf\\\":0,\\\"laterVulCount\\\":0,\\\"newSuspicious\\\":0,\\\"nntfVulCount\\\":0,\\\"remindNum\\\":0,\\\"scaNum\\\":0,\\\"seriousNum\\\":0,\\\"suspNum\\\":0,\\\"suspicious\\\":0,\\\"sysNum\\\":0,\\\"trojan\\\":0,\\\"uuid\\\":\\\"009635bf00c0585e3122ab92f5449919\\\",\\\"vul\\\":0,\\\"weakPWNum\\\":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.