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

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String GetChain

系统规定参数。取值:GetChain

RegionId String cn-chengdu

地域ID

InstanceId String cri-4cdrlqmhn4gm****

实例ID

ChainId String chi-0ops0gsmw5x2****

交付链ID

返回数据

名称 类型 示例值 描述
ModifiedTime Long 1638259914000

交付链描述修改时间

ScopeId String crr-nyrh2oko32xb****

交付链作用域ID

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

请求ID

Description String description

交付链描述

CreateTime Long 1638255427000

交付链创建时间

ScopeType String REPOSITORY

交付链作用域类型

Code String success

返回码

ChainId String chi-0ops0gsmw5x2****

交付链ID

InstanceId String cri-4cdrlqmhn4gm****

实例ID

IsSuccess Boolean true

是否成功

Name String test

交付链名称

ChainConfig Object

交付链配置描述

ChainConfigId String cci-lz3ycgo69ukt****

交付链配置ID

IsActive Boolean true

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

  • true:生效
  • false:不生效
Version String 1

交付链版本

Routers Array of Routers

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

From Object

源节点

NodeName String DOCKER_IMAGE_BUILD

源节点名称

To Object

目的节点

NodeName String DOCKER_IMAGE_PUSH

目的节点名称

Nodes Array of Nodes

交付链中的每一个节点

NodeName String VULNERABILITY_SCANNING

交付链节点名称

Enable Boolean true

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

  • true:启用交付链节点
  • false:不启用交付链节点
NodeConfig Object

交付链节点配置

Timeout Long 5

超时时间

Retry Integer 3

重试次数

DenyPolicy Object

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

Logic String AND

扫描触发阻断的逻辑

IssueLevel String HIGH

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

IssueCount String 10

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

Action String BLOCK

阻断动作,取值:

  • BLOCK:阻断交付链继续执行
  • BLOCK_RETAG:阻断覆盖推送镜像 tag
  • BLOCK_DELETE_TAG:阻断删除镜像 tag
ScanEngine String ACR_SCAN_SERVICE

交付链扫描节点引擎

示例

请求示例

http(s)://[Endpoint]/?Action=GetChain
&InstanceId=cri-4cdrlqmhn4gm****
&ChainId=chi-0ops0gsmw5x2****
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<GetChainResponse>
    <ModifiedTime>1638259914000</ModifiedTime>
    <ScopeId>crr-nyrh2oko32xb****</ScopeId>
    <RequestId>C87993B5-7D61-5CAC-8D64-1AC732DD69FF</RequestId>
    <Description>description</Description>
    <CreateTime>1638255427000</CreateTime>
    <ScopeType>REPOSITORY</ScopeType>
    <Code>success</Code>
    <ChainId>chi-0ops0gsmw5x2****</ChainId>
    <InstanceId>cri-4cdrlqmhn4gm****</InstanceId>
    <IsSuccess>true</IsSuccess>
    <Name>test</Name>
    <ChainConfig>
        <ChainConfigId>cci-lz3ycgo69ukt****</ChainConfigId>
        <IsActive>true</IsActive>
        <Version>1</Version>
        <Routers>
            <From>
                <NodeName>DOCKER_IMAGE_BUILD</NodeName>
            </From>
            <To>
                <NodeName>DOCKER_IMAGE_PUSH</NodeName>
            </To>
        </Routers>
        <Nodes>
            <NodeName>VULNERABILITY_SCANNING</NodeName>
            <Enable>true</Enable>
            <NodeConfig>
                <Timeout>5</Timeout>
                <Retry>3</Retry>
                <DenyPolicy>
                    <Logic>AND</Logic>
                    <IssueLevel>HIGH</IssueLevel>
                    <IssueCount>10</IssueCount>
                    <Action>BLOCK</Action>
                </DenyPolicy>
                <ScanEngine>ACR_SCAN_SERVICE</ScanEngine>
            </NodeConfig>
        </Nodes>
    </ChainConfig>
</GetChainResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/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" : 5,
        "Retry" : 3,
        "DenyPolicy" : {
          "Logic" : "AND",
          "IssueLevel" : "HIGH",
          "IssueCount" : "10",
          "Action" : "BLOCK"
        },
        "ScanEngine" : "ACR_SCAN_SERVICE"
      }
    } ]
  }
}

错误码

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