查询镜像按次扫描统计数据 - ShowImagePayPerScanStatistics
功能介绍
查询镜像按次扫描统计数据
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,当前API调用无需身份策略权限。
URI
GET /v5/{project_id}/image/pay-per-scan/statistics
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
参数解释: 项目ID,用于明确项目归属,配置后可通过该ID查询项目下资产。获取方式请参见获取项目ID。 约束限制: 不涉及 取值范围: 字符长度1-256位 默认取值: 不涉及 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
enterprise_project_id |
否 |
String |
参数解释: 企业项目ID,用于过滤不同企业项目下的资产。获取方式请参见获取企业项目ID。 如需查询所有企业项目下的资产请传参“all_granted_eps”。 约束限制: 开通企业项目功能后才需要配置企业项目ID参数。 取值范围: 字符长度1-256位 默认取值: 0,表示默认企业项目(default)。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
参数解释: 用户Token,包含了用户的身份、权限等信息,在调用API接口时,可通过Token进行身份认证。获取方式请参见获取用户Token。 约束限制: 不涉及 取值范围: 字符长度1-32768位 默认取值: 不涉及 |
响应参数
状态码:200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
repository_scan_num |
Integer |
仓库镜像扫描成功次数 |
|
cicd_scan_num |
Integer |
CICD镜像扫描成功次数 |
|
free_quota_num |
Integer |
免费扫描次数 |
|
already_given |
Boolean |
是否赠送过免费次数 |
|
image_free_quota |
Integer |
登录容器镜像界面赠送的次数 |
|
high_risk |
ImageTypeRiskInfo object |
高风险镜像 |
|
has_risk |
ImageTypeRiskInfo object |
有风险镜像 |
|
total |
ImageTypeRiskInfo object |
总镜像数 |
|
unscan |
ImageTypeRiskInfo object |
未扫描镜像数 |
请求示例
无
响应示例
状态码:200
镜像按次扫描统计数据
{
"repository_scan_num" : 5,
"cicd_scan_num" : 10,
"free_quota_num" : 2,
"already_given" : true,
"image_free_quota" : 10
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
镜像按次扫描统计数据 |
错误码
请参见错误码。