GetScanRule - 获取扫描规则

获取扫描规则。

接口说明

获取扫描规则。

调试

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

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用前面加 * 表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
cr:GetScanRuleget
*ScanRule
acs:cr:{#regionId}:{#accountId}:instance/{#instanceId}/scanrule/{#scanRuleId}

请求参数

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

实例 id

cri-xkx6vujuhay0****
ScanRuleIdstring

扫描规则 Id

crscnr-2sdveqjhpzdcafyq

返回参数

名称类型描述示例值
object

Schema of Response

Codestring

返回值

success
IsSuccessboolean

是否调用 API 成功,取值:

  • true:调用 API 成功

  • false:调用 API 失败

true
RequestIdstring

请求 ID

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

扫描规则

InstanceIdstring

实例 ID

cri-szw6f6bhrky0c8jk
ScanRuleIdstring

扫描规则 Id

crscnr-aemytkwad2h7fyhb
RuleNamestring

事件规则名称

protection
ScanScopestring

扫描范围

REPO
TriggerTypestring

触发类型,取值:

  • ALL:全部触发

  • TAG_LISTTAG:触发

  • TAG_REG_EXP:表达式触发

AUTO
Namespacesarray

事件生效命名空间名称

Namespacesstring

事件生效命名空间名称

[\"lwc-app-group\"]
RepoNamesarray

事件生效仓库名称

RepoNamesstring

事件生效仓库名称

[\"lesson-kit-api\",\"lesson-kit-consumer-gen\"]
RepoTagFilterPatternstring

事件触发的 tag 过滤规则

.*
CreateTimelong

创建时间

2018-03-15T17:08Z
UpdateTimelong

更新时间

2025-08-28T20:07:33.164
ScanTypestring

漏洞类型

  • cve:系统漏洞

  • sca:应用漏洞

SBOM

示例

正常返回示例

JSON格式

{
  "Code": "success",
  "IsSuccess": true,
  "RequestId": "C87993B5-7D61-5CAC-8D64-1AC732DD69FF",
  "ScanRule": {
    "InstanceId": "cri-szw6f6bhrky0c8jk",
    "ScanRuleId": "crscnr-aemytkwad2h7fyhb",
    "RuleName": "protection",
    "ScanScope": "REPO",
    "TriggerType": "AUTO",
    "Namespaces": [
      "[\\\"lwc-app-group\\\"]"
    ],
    "RepoNames": [
      "[\\\"lesson-kit-api\\\",\\\"lesson-kit-consumer-gen\\\"]"
    ],
    "RepoTagFilterPattern": ".*",
    "CreateTime": 0,
    "UpdateTime": 0,
    "ScanType": "SBOM"
  }
}

错误码

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

变更历史

变更时间变更内容概要操作
2025-11-28新增 OpenAPI查看变更详情