Detect Image Build Command Risks via DescribeImageBuildRiskByKey - Security Center - Alibaba Cloud - Security Center

Queries the build risks of images by paging.

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

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RiskKey	string	No	The key of the build risk rule. Note You can call the DescribeImageBuildRiskList operation to obtain this parameter.	no_user
ImageUuid	string	No	The UUID of the image.	a910053dd4710173ecc9e9d8931f****
Lang	string	No	The language of the content in the request and response. Valid values: zh: Chinese en: English.	zh
CurrentPage	integer	No	The page number of the current page in a paged query. Default value: 1.	1
PageSize	integer	No	The maximum number of entries per page in a paging query. Default value: 20. If you leave this parameter empty, 20 entries are returned per page. Note Do not leave PageSize empty.	20
Status	integer	No	The status of the alert event to query. Valid values: 0: unhandled. 1: ignored. 2: false positive.	1

Response elements

Element	Type	Description	Example
	object	PlainResult<PageResult>
Data	object	The returned data.
List	array<object>	The list of build risks.
	object
LayerDigest	string	The digest of the image.	6ec898e6274f942e0e4a053eff1c3119026a6704e56cff206b2cec71f636****
LayerCmd	string	The image build command.	user root
Advice	string	The suggestion on how to handle the risk.	do not use root user
Promt	string	The prompt message on the risk.	the root user has excessive permissions
Description	string	The description of the suggestion on how to handle the risk.	the root user has excessive permissions
RiskLevel	string	The risk level. Valid values: high medium low	medium
RiskKey	string	The key of the risk rule.	no_user
RiskKeyName	string	The name of the risk rule.	no_user
RiskClass	string	The type key of the risk rule.	other
RiskClassName	string	The type name of the risk rule.	other
PageInfo	object	The paging query parameters.
CurrentPage	integer	The page number. Default value: 1.	1
PageSize	integer	The number of entries per page. Default value: 20. If you leave this parameter empty, 20 entries are returned on each page. Note We recommend that you do not leave this parameter empty.	20
TotalCount	integer	The total number of entries returned.	109
Success	boolean	Indicates whether the call was successful. Valid values: true: The call was successful. false: The call failed.	true
Code	string	The status code of the API call.	200
Message	string	The detailed information about the error code.	successful
RequestId	string	The ID of the request.	52870893-48A7-5A9E-9E05-6253E5B6****

Examples

Success response

JSON format

{
  "Data": {
    "List": [
      {
        "LayerDigest": "6ec898e6274f942e0e4a053eff1c3119026a6704e56cff206b2cec71f636****",
        "LayerCmd": "user root",
        "Advice": "do not use root user",
        "Promt": "the root user has excessive permissions",
        "Description": "the root user has excessive permissions",
        "RiskLevel": "medium",
        "RiskKey": "no_user",
        "RiskKeyName": "no_user",
        "RiskClass": "other",
        "RiskClassName": "other"
      }
    ],
    "PageInfo": {
      "CurrentPage": 1,
      "PageSize": 20,
      "TotalCount": 109
    }
  },
  "Success": true,
  "Code": "200",
  "Message": "successful",
  "RequestId": "52870893-48A7-5A9E-9E05-6253E5B6****"
}

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.