GetChain - 获取交付链定义

更新时间:
复制 MD 格式

获取交付链定义,用于了解交付链的节点执行顺序。

调试

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

调试

授权信息

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

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

cr:GetChain

get

*Chain

acs:cr:{#regionId}:{#accountId}:instance/{#InstanceId}/chain/{#ChainId}

无 无

请求参数

名称

类型

必填

描述

示例值

InstanceId

string

是

实例 ID

cri-4cdrlqmhn4gm****

ChainId

string

是

交付链 ID

chi-0ops0gsmw5x2****

返回参数

名称

类型

描述

示例值

object

ModifiedTime

integer

交付链描述修改时间,使用 UNIX 时间戳,单位为毫秒。

1638259914000

ScopeId

string

交付链作用域 ID

crr-nyrh2oko32xb****

RequestId

string

请求 ID

C87993B5-7D61-5CAC-8D64-1AC732DD69FF

Description

string

交付链描述

description

CreateTime

integer

交付链创建时间,使用 UNIX 时间戳,单位为毫秒。

1638255427000

ScopeType

string

交付链作用域类型

REPOSITORY

Code

string

返回码

success

ChainId

string

交付链 ID

chi-0ops0gsmw5x2****

InstanceId

string

实例 ID

cri-4cdrlqmhn4gm****

IsSuccess

boolean

是否成功

true

Name

string

交付链名称

test

ChainConfig

object

交付链配置描述

ChainConfigId

string

交付链配置 ID

cci-lz3ycgo69ukt****

IsActive

boolean

交付链配置是否有生效,取值:

  • true:生效

  • false:不生效

true

Version

string

交付链版本

1

Routers

array<object>

交付链节点间执行顺序关系

array<object>

From

object

源节点

NodeName

string

源节点名称

DOCKER_IMAGE_BUILD

To

object

目的节点

NodeName

string

目的节点名称

DOCKER_IMAGE_PUSH

Nodes

array<object>

交付链中的每一个节点

array<object>

NodeName

string

交付链节点名称

VULNERABILITY_SCANNING

Enable

boolean

是否启用该交付链节点,取值:

  • true:启用交付链节点

  • false:不启用交付链节点

true

NodeConfig

object

交付链节点配置

Timeout

integer

超时时间(单位秒)

900

Retry

integer

重试次数

3

DenyPolicy

object

交付链节点中扫描节点的阻断规则

Logic

string

扫描触发阻断的逻辑

AND

IssueLevel

string

扫描漏洞等级达到多少时触发阻断

HIGH

IssueCount

string

扫描漏洞数达到多少时触发阻断

10

Action

string

阻断动作,取值:

  • BLOCK:阻断交付链继续执行

  • BLOCK_RETAG:阻断覆盖推送镜像 tag

  • BLOCK_DELETE_TAG:阻断删除镜像 tag

BLOCK

IssueList

string

需要阻断的 CVE 漏洞集合,多个 CVE 漏洞名用英文逗号分隔

CVE-2020-8286,CVE-2020-8285

MaliciousList

string

需要阻断的恶意样本集合,多个恶意样本名用英文逗号分隔

mutate_cockhorse,abnormal_program

BaselineList

string

需要阻断的基线样本集合,多个基线样本名用英文逗号分隔

identification,hc_image_exploit

ScanEngine

string

交付链扫描节点引擎

  • SAS_SCAN_SERVICE, 云安全扫描引擎(需要付费开通)

  • ACR_SCAN_SERVICE, ACR 扫描引擎

ACR_SCAN_SERVICE

ScopeExclude

array

不被交付链执行的仓库集合

string

不被交付链执行的仓库名,多个仓库名用英文逗号分隔

repo_name1,repo_name2

示例

正常返回示例

JSON格式

{
  "ModifiedTime": 1638259914000,
  "ScopeId": "crr-nyrh2oko32xb****",
  "RequestId": "C87993B5-7D61-5CAC-8D64-1AC732DD69FF",
  "Description": "description",
  "CreateTime": 1638255427000,
  "ScopeType": "REPOSITORY",
  "Code": "success",
  "ChainId": "chi-0ops0gsmw5x2****",
  "InstanceId": "cri-4cdrlqmhn4gm****",
  "IsSuccess": true,
  "Name": "test",
  "ChainConfig": {
    "ChainConfigId": "cci-lz3ycgo69ukt****",
    "IsActive": true,
    "Version": "1",
    "Routers": [
      {
        "From": {
          "NodeName": "DOCKER_IMAGE_BUILD"
        },
        "To": {
          "NodeName": "DOCKER_IMAGE_PUSH"
        }
      }
    ],
    "Nodes": [
      {
        "NodeName": "VULNERABILITY_SCANNING",
        "Enable": true,
        "NodeConfig": {
          "Timeout": 900,
          "Retry": 3,
          "DenyPolicy": {
            "Logic": "AND",
            "IssueLevel": "HIGH",
            "IssueCount": "10",
            "Action": "BLOCK",
            "IssueList": "CVE-2020-8286,CVE-2020-8285",
            "MaliciousList": "mutate_cockhorse,abnormal_program",
            "BaselineList": "identification,hc_image_exploit"
          },
          "ScanEngine": "ACR_SCAN_SERVICE"
        }
      }
    ]
  },
  "ScopeExclude": [
    "repo_name1,repo_name2\n"
  ]
}

错误码

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

变更历史

更多信息,参考变更详情。