调用DescribeImageInstances获取镜像信息_云安全中心(Security Center)-阿里云帮助中心

获取镜像信息列表。

调试

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

授权信息

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

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

操作	访问级别	资源类型	条件关键字	关联操作
yundun-sas:DescribeImageInstances	get	全部资源 *	无	无

请求参数

名称	类型	必填	描述	示例值
Criteria	string	否	设置搜索资产的条件。该参数 JSON 格式，包含以下字段： name：检索项 value：检索项值 logicalExp：多个检索项值生效的逻辑关系。取值： OR：表示多个检索项值之间是或的关系。 AND：表示多个检索项值之间是与的关系。说明您可以调用 DescribeImageRepoCriteria 接口查询支持的搜索条件。	[{"name":"instanceId","value":"390100182","logicalExp":"AND"}]
LogicalExp	string	否	设置多个搜索条件间生效的逻辑关系。取值： OR：表示多个搜索条件之间是或的关系。 AND：表示多个搜索条件之间是与的关系。	OR
PageSize	integer	否	指定分页查询时，每页显示的数据最大条数。每页默认显示的数据条数为 20 条，PageSize 参数值为空时，将默认返回 20 条数据。说明建议 PageSize 取值不要为空。	20
CurrentPage	integer	否	从返回结果中的第几页开始显示。起始值为 1。默认值为 1，表示从第 1 页开始显示。	1
Scanned	boolean	否	镜像是否已扫描。取值： true：已处理 false：未处理	true

返回参数

名称	类型	描述	示例值
	object	请求返回数据。
RequestId	string	本次调用请求的 ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。	BE120DAB-F4E7-4C53-ADC3-A97578ABF384
PageInfo	object	查询结果的分页信息。
CurrentPage	integer	分页查询时，当前页的页码。	1
PageSize	integer	分页查询时，每页显示的镜像信息的数量。	20
TotalCount	integer	查询到的镜像总数量。	69
Count	integer	返回结果的当前页显示镜像得数量。	4
ImageInstanceList	array<object>	镜像信息列表。
responses	object	镜像信息。
Status	string	镜像状态。取值： NORMAL：正常	NORMAL
Digest	string	镜像 digest 值。	a5ccdd9b166b67e02954aa9b618fe19b7968bd56a15463d2ad7f2643ba5b****
RegistryType	string	镜像类型。取值： acr：acr。 harbor：harbor。 quay：quay。 CI/CD：CICD 仓类型。	acr
Tag	string	镜像的标签。	mysql_5.7
ImageUpdate	string	镜像更新的时间戳，单位为毫秒。	1600069948849
RepoType	string	仓库类型，取值： private：私有仓库 public：公开仓库	private
ImageSize	string	镜像的大小。单位 MB。	1604487690
HcStatus	string	存在基线风险状态。取值： NO：不存在 YES：存在	NO
VulCount	integer	镜像中存在漏洞数量。	0
ImageId	string	镜像的 ID。	c20987f18b130f9d144c9828df630417e2a9523148930dc3963e9d0dab30****
Endpoints	string	镜像资源地址。	[]
RiskStatus	string	是否存在风险。取值： NO：无风险 YES：有风险	NO
ImageCreate	string	镜像创建的时间戳，单位为毫秒。	1600069948849
VulStatus	string	镜像是否存在漏洞。取值： YES：存在漏洞 NO：不存在漏洞	NO
AlarmStatus	string	镜像是否存在安全告警。取值： YES：存在安全告警 NO：不存在安全告警	NO
ScaProgress	integer	镜像的扫描进度。取值范围：0~100。	100
InstanceId	string	镜像资产实例 ID。	39010****
RegionId	string	镜像所在区域的 ID。	cn-hangzhou
ScaStatus	string	镜像扫描状态。取值： 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
Uuid	string	服务器 UUID。	12f80307-60aa-4efa-863a-56d72fb****
RepoId	string	镜像仓库 ID。	f2b86d20bf0855af6aa268ce90fd****
HcCount	integer	基线风险数量。	0
ScaResult	string	镜像扫描结果错误码。取值： TASK_NOT_EXISTS：任务不存在 TASK_NOT_SUPPORT_REGION：任务不支持该地域 forbid_create_repeat_task：不允许重复的任务	TASK_NOT_SUPPORT_REGION
RepoName	string	镜像仓库名称。	sas-script-test
AlarmCount	integer	镜像存在安全告警数量。	0
RepoNamespace	string	镜像仓库的命名空间。	N/A
Deployed	integer	镜像是否已部署。取值： 0：未部署 1：已部署	1
LastScanTime	long	最新扫描的时间戳，单位：毫秒。	1721363159000

示例

正常返回示例

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,
      "LastScanTime": 1721363159000
    }
  ]
}

错误码

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

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

变更历史

变更时间	变更内容概要	操作
2024-07-19	OpenAPI 返回结构发生变更	查看变更详情
2024-06-26	OpenAPI 返回结构发生变更	查看变更详情