检索有关存档规则的信息 - ShowArchiveRule

功能介绍

检索有关存档规则的信息。

授权信息

账号根用户具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备如下身份策略权限，更多的权限说明请参见权限和授权项。

授权项	访问级别	资源类型（*为必须）	条件键	别名	依赖的授权项
AccessAnalyzer:archiveRule:get	Read	archiveRule *	-	-	-

URI

GET /v5/analyzers/{analyzer_id}/archive-rules/{archive_rule_id}

表1 路径参数
参数	是否必选	参数类型	描述
analyzer_id	是	String	分析器的唯一标识符。最小长度：1 最大长度：36
archive_rule_id	是	String	存档规则的唯一标识符。最小长度：1 最大长度：36

请求参数

无

响应参数

状态码：200

表2 响应Body参数
参数	参数类型	描述
archive_rule	ArchiveRuleSummary object	分析器创建的存档规则。

表3 ArchiveRuleSummary
参数	参数类型	描述
created_at	String	创建存档规则的时间。
filters	Array of FindingFilter objects	匹配要返回的访问分析结果的筛选器。
id	String	存档规则的唯一标识符。
name	String	创建存档规则的名称。
updated_at	String	上次更新存档规则的时间。
urn	String	存档规则的唯一资源标识符。

表4 FindingFilter
参数	参数类型	描述
criterion	Criterion object	要在查找筛选器中使用的条件。最多只能有一个运算符。
key	String	过滤键。 resource：资源URN resource_type：资源类型 resource_owner_account：资源所有者账号 is_public：公共访问权限 id：分析结果ID status：分析结果类型 principal_type：主体类型 principal_identifier：主体Identifier change_type：分析结果状态的变化 existing_finding_id：已有分析结果ID existing_finding_status：已有分析结果状态 condition.g:PrincipalUrn：主体URN condition.g:PrincipalId：主体ID condition.g:PrincipalAccount：主体账号 condition.g:PrincipalOrgId：主体OrgID condition.g:PrincipalOrgPath：主体组织路径 condition.g:PrincipalOrgManagementAccountId：主体组织管理账号ID condition.g:SourceIp：源IP condition.g:SourceVpc：源VPC condition.g:SourceVpce：源VPCE finding_type：分析结果类型

表5 Criterion
参数	参数类型	描述
contains	Array of strings	要匹配筛选器的“包含”运算符。数组长度：1 - 20
eq	Array of strings	要匹配筛选器的“等于”运算符。数组长度：1 - 20
exists	Boolean	要匹配筛选器的“存在”运算符。
neq	Array of strings	要匹配筛选器的“不等于”运算符。数组长度：1 - 20

请求示例

检索有关存档规则的信息。

GET https://{hostname}/v5/analyzers/{analyzer_id}/archive-rules/{archive_rule_id}

响应示例

状态码：200

{
  "archive_rule" : {
    "created_at" : "2023-09-07T08:35:41.997Z",
    "filters" : [ {
      "criterion" : {
        "eq" : [ "iam:agency" ]
      },
      "key" : "resource_type"
    } ],
    "id" : "{archive_rule_id}",
    "name" : "my-archive-rules",
    "updated_at" : "2023-09-07T08:35:41.997Z",
    "urn" : "AccessAnalyzer:{region_id}:{domain_id}:archiveRule:{analyzer_id}/{archive_rule_id}"
  }
}