文档

DescribeImageInstances - 获取镜像信息

更新时间:

获取镜像信息列表。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
yundun-sas:DescribeImageInstancesRead
  • 全部资源
    *

请求参数

名称类型必填描述示例值
Criteriastring

设置搜索资产的条件。该参数 JSON 格式,包含以下字段:

  • name:检索项
  • value:检索项值
  • logicalExp:多个检索项值生效的逻辑关系。取值:
    • OR:表示多个检索项值之间是的关系。
    • AND:表示多个检索项值之间是的关系。
说明 您可以调用 DescribeImageCriteria 接口查询支持的搜索条件。
[{"name":"instanceId","value":"390100182","logicalExp":"AND"}]
LogicalExpstring

设置多个搜索条件间生效的逻辑关系。取值:

  • OR:表示多个搜索条件之间是的关系。
  • AND:表示多个搜索条件之间是的关系。
OR
PageSizeinteger

指定分页查询时,每页显示的数据最大条数。每页默认显示的数据条数为 20 条,PageSize 参数值为空时,将默认返回 20 条数据。

说明 建议 PageSize 取值不要为空。
20
CurrentPageinteger

从返回结果中的第几页开始显示。起始值为 1。默认值为 1,表示从第 1 页开始显示。

1
Scannedboolean

镜像是否已扫描。取值:

  • true:已处理
  • false:未处理
true

返回参数

名称类型描述示例值
object

请求返回数据。

RequestIdstring

本次调用请求的 ID,是由阿里云为该请求生成的唯一标识符,可用于排查和定位问题。

BE120DAB-F4E7-4C53-ADC3-A97578ABF384
PageInfoobject

查询结果的分页信息。

CurrentPageinteger

分页查询时,当前页的页码。

1
PageSizeinteger

分页查询时,每页显示的镜像信息的数量。

20
TotalCountinteger

查询到的镜像总数量。

69
Countinteger

返回结果的当前页显示镜像得数量。

4
ImageInstanceListobject []

镜像信息列表。

Statusstring

镜像状态。取值:

  • NORMAL:正常
NORMAL
Digeststring

镜像 digest 值。

a5ccdd9b166b67e02954aa9b618fe19b7968bd56a15463d2ad7f2643ba5b****
RegistryTypestring

镜像类型。取值:

  • acr:acr。
  • harbor:harbor。
  • quay:quay。
  • CI/CD:CICD 仓类型。
acr
Tagstring

镜像的标签。

mysql_5.7
ImageUpdatestring

镜像更新的时间戳,单位为毫秒。

1600069948849
RepoTypestring

仓库类型,取值:

  • private:私有仓库
  • public:公开仓库
private
ImageSizestring

镜像的大小。单位 MB。

1604487690
HcStatusstring

存在基线风险状态。取值:

  • NO:不存在
  • YES:存在
NO
VulCountinteger

镜像中存在漏洞数量。

0
ImageIdstring

镜像的 ID。

c20987f18b130f9d144c9828df630417e2a9523148930dc3963e9d0dab30****
Endpointsstring

镜像资源地址。

[]
RiskStatusstring

是否存在风险 。取值:

  • NO:无风险
  • YES:有风险
NO
ImageCreatestring

镜像创建的时间戳,单位为毫秒。

1600069948849
VulStatusstring

镜像是否存在漏洞。取值:

  • YES:存在漏洞
  • NO:不存在漏洞
NO
AlarmStatusstring

镜像是否存在安全告警。取值:

  • YES:存在安全告警
  • NO:不存在安全告警
NO
ScaProgressinteger

镜像的扫描进度。取值范围:0~100。

100
InstanceIdstring

镜像资产实例 ID。

39010****
RegionIdstring

镜像所在区域的 ID。

cn-hangzhou
ScaStatusstring

镜像扫描状态。取值:

  • INIT:镜像扫描待启动
  • START:镜像扫描已启动
  • MESSAGE_SEND:镜像扫描消息已发出
  • START_RUN:镜像分析任务启动
  • DOWNLOAD:镜像扫描已下载
  • PRE_ANALYZER:镜像预分析已启动
  • WEB_SHELL_ANALYZER:镜像 WebShell 分析已完成
  • CVE_ANALYZER:镜像 CVE 分析已完成
  • BIN_ANALYZER:镜像二进制分析已完成
  • OTHER_ANALYZER:镜像拓展分析已完成
  • SUCCESS:镜像扫描已完成
  • PRE_ANALYZER_SUCCESS:镜像预分析已完成
  • FAIL:镜像扫描已失败
  • TIMEOUT:镜像扫描已超时
SUCCESS
Uuidstring

服务器 UUID。

12f80307-60aa-4efa-863a-56d72fb****
RepoIdstring

镜像仓库 ID。

f2b86d20bf0855af6aa268ce90fd****
HcCountinteger

基线风险数量。

0
ScaResultstring

镜像扫描结果错误码。取值:

  • TASK_NOT_EXISTS:任务不存在
  • TASK_NOT_SUPPORT_REGION:任务不支持该地域
  • forbid_create_repeat_task:不允许重复的任务
TASK_NOT_SUPPORT_REGION
RepoNamestring

镜像仓库名称。

sas-script-test
AlarmCountinteger

镜像存在安全告警数量。

0
RepoNamespacestring

镜像仓库的命名空间。

N/A
Deployedinteger

镜像是否已部署。取值:

  • 0:未部署
  • 1:已部署
1

示例

正常返回示例

JSON格式

{
  "RequestId": "BE120DAB-F4E7-4C53-ADC3-A97578ABF384",
  "PageInfo": {
    "CurrentPage": 1,
    "PageSize": 20,
    "TotalCount": 69,
    "Count": 4
  },
  "ImageInstanceList": [
    {
      "Status": "NORMAL",
      "Digest": "a5ccdd9b166b67e02954aa9b618fe19b7968bd56a15463d2ad7f2643ba5b****",
      "RegistryType": "acr",
      "Tag": "mysql_5.7",
      "ImageUpdate": "1600069948849",
      "RepoType": "private",
      "ImageSize": "1604487690",
      "HcStatus": "NO",
      "VulCount": 0,
      "ImageId": "c20987f18b130f9d144c9828df630417e2a9523148930dc3963e9d0dab30****",
      "Endpoints": "[]",
      "RiskStatus": "NO",
      "ImageCreate": "1600069948849",
      "VulStatus": "NO",
      "AlarmStatus": "NO",
      "ScaProgress": 100,
      "InstanceId": "39010****",
      "RegionId": "cn-hangzhou",
      "ScaStatus": "SUCCESS",
      "Uuid": "12f80307-60aa-4efa-863a-56d72fb****",
      "RepoId": "f2b86d20bf0855af6aa268ce90fd****",
      "HcCount": 0,
      "ScaResult": "TASK_NOT_SUPPORT_REGION",
      "RepoName": "sas-script-test",
      "AlarmCount": 0,
      "RepoNamespace": "N/A",
      "Deployed": 1
    }
  ]
}

错误码

HTTP status code错误码错误信息描述
403NoPermissioncaller has no permission当前操作未被授权,请联系主账号在RAM控制台进行授权后再执行操作。
500ServerErrorServerError服务故障,请稍后重试!

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
暂无变更历史
  • 本页导读 (1)
文档反馈