更新时间:2026-09-18 GMT+08:00
分享

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

功能介绍

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

调试

您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。

授权信息

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

授权项

访问级别

资源类型(*为必须)

条件键

别名

依赖的授权项

AccessAnalyzer:archiveRule:get

Read

archiveRule *

-

-

-

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

analyzer_id

是

String

参数解释 :

分析器的唯一标识符。

您可以调用 ListAnalyzers API来获取分析器ID。该API的响应参数中会返回一个分析器列表,其中每个分析器对象的 id 字段即为分析器ID。

取值范围 :

最小长度为1,最大长度为36。仅支持包含字母、数字、下划线(_)及中划线(-)。

archive_rule_id

是

String

参数解释 :

存档规则的唯一标识符。

您可以调用 ListArchiveRules API来检索为指定分析器创建的存档规则列表。该API的响应中会包含一个存档规则列表,列表中的每个存档规则对象都包含其唯一的id字段,这就是存档规则ID。

取值范围 :

最小长度为1,最大长度为36。仅支持包含字母、数字、下划线(_)和中划线(-)。

约束限制 :

不涉及。

默认取值 :

不涉及。

请求参数

无

响应参数

状态码:200

表2 响应Body参数

参数

参数类型

描述

archive_rule

ArchiveRuleSummary object

参数解释:

分析器创建的存档规则。

取值范围:

不涉及。

表3 ArchiveRuleSummary

参数

参数类型

描述

created_at

String

参数解释:

创建存档规则的时间。使用UTC +0时间格式,格式为yyyy-MM-ddTHH:mm:ss.SSSZ。例如:2023-09-07T07:51:10.502Z。

取值范围:

不涉及。

filters

Array of FindingFilter objects

参数解释:

匹配要返回的访问分析结果的筛选器。

取值范围:

数组长度为1到20。

id

String

参数解释:

存档规则的唯一标识符。

取值范围:

最小长度为1,最大长度为36。仅支持包含字母、数字、下划线(_)和中划线(-)。

name

String

参数解释:

创建存档规则的名称。

取值范围:

最小长度为1,最大长度为255。仅支持包含字母、数字、下划线(_)、中划线(-)和点号(.)。

updated_at

String

参数解释:

上次更新存档规则的时间。使用UTC +0时间格式,格式为yyyy-MM-ddTHH:mm:ss.SSSZ。例如:2023-09-07T07:51:10.502Z。

取值范围:

不涉及。

urn

String

参数解释:

存档规则的唯一资源标识符。

取值范围:

最大长度为1500。

表4 FindingFilter

参数

参数类型

描述

criterion

Criterion object

参数解释:

要在查找筛选器中使用的条件。

取值范围:

不涉及。

key

String

参数解释:

过滤键。

取值范围:

  • resource:资源URN

  • resource_type:资源类型

  • resource_owner_account:资源所有者账号

  • is_public:公共访问权限

  • id:分析结果ID

  • status:分析结果状态

  • principal_type:主体类型

  • principal_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}"
  }
}

状态码

状态码

描述

200

OK

错误码

请参见错误码。

相关文档