获取镜像构建指令风险信息 - ListImageBuildCommandRisks
功能介绍
获取镜像构建指令风险信息
授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
- 如果使用身份策略授权，当前API调用无需身份策略权限。
URI
GET /v5/{project_id}/image/build-command-risks
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
参数解释: 项目ID，用于明确项目归属，配置后可通过该ID查询项目下资产。获取方式请参见获取项目ID。 约束限制: 不涉及 取值范围: 字符长度1-256位 默认取值: 不涉及 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
enterprise_project_id |
否 |
String |
参数解释: 企业项目ID，用于过滤不同企业项目下的资产。获取方式请参见获取企业项目ID。 如需查询所有企业项目下的资产请传参“all_granted_eps”。 约束限制: 开通企业项目功能后才需要配置企业项目ID参数。 取值范围: 字符长度1-256位 默认取值: 0，表示默认企业项目（default）。 |
|
limit |
否 |
Integer |
参数解释: 每页显示个数 约束限制: 不涉及 取值范围: 取值10-200 默认取值: 10 |
|
offset |
否 |
Integer |
参数解释: 偏移量：指定返回记录的开始位置 约束限制: 不涉及 取值范围: 最小值0，最大值2000000 默认取值: 默认为0 |
|
image_type |
是 |
String |
参数解释: 镜像类型 约束限制: 不涉及 取值范围:
字符长度1-32 默认取值: 不涉及 |
|
image_id |
否 |
String |
参数解释： 镜像id 约束限制： 不涉及 取值范围： 字符长度0-128位 默认取值： 不涉及 |
|
risk_name |
否 |
String |
参数解释： 风险名称 约束限制： 不涉及 取值范围： 字符长度1-512位 默认取值： 不涉及 |
|
risk_level |
否 |
String |
参数解释: 风险程度 约束限制: 不涉及 取值范围:
字符长度1-64 默认取值: 不涉及 |
请求参数
响应参数
状态码：200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
total_num |
Integer |
参数解释 总数 取值范围 取值0-2147483547 |
|
data_list |
Array of ImageBuildCommandRiskResponseInfo objects |
参数解释: 风险列表 取值范围: 取值0-200 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
latest_scan_time |
Long |
参数解释: 最后一次检测时间，时间单位 毫秒（ms） 取值范围: 大小0-9223372036854775807 |
|
image_num |
Integer |
参数解释: 受影响的镜像的数量，进行了当前构建指令的镜像数量 取值范围: 大小0-2097152 |
|
risk_id |
String |
参数解释 风险id 取值范围 字符长度1-64位 |
|
rule_id |
String |
参数解释 风险检测规则id 取值范围 字符长度1-64位 |
|
risk_name |
String |
参数解释 风险名称 取值范围 字符长度1-512位 |
|
risk_level |
String |
参数解释 风险程度 取值范围
|
|
description |
String |
参数解释 风险描述 取值范围 字符长度0-65534位 |
|
image_type |
String |
参数解释 镜像类型 取值范围 字符长度1-32位 |
请求示例
无
响应示例
状态码：200
请求已成功
{
"data_list" : [ {
"image_type" : "registry",
"risk_id" : "ea967dad-f4bf-4dd1-8900-d15cc6025fa8",
"rule_id" : "DS002",
"risk_name" : "Image user should not be 'root'",
"risk_level" : "high",
"image_num" : 1,
"description" : "Running containers with 'root' user can lead to a container escape situation. It is a best practice to run containers as non-root users, which can be done by adding a 'USER' statement to the Dockerfile.",
"latest_scan_time" : 1691748641788
} ],
"total_num" : 1
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
请求已成功 |
错误码
请参见错误码。
