文档

GetAggregateResourceComplianceTimeline - 查询账号组资源合规时间线

更新时间:

查询指定账号组内指定资源的合规时间线。合规时间线是资源的一组合规评估记录,包括合规时间线上的点和合规时间线的内容。

接口说明

在配置审计中,每个资源都有属于自己的合规时间线。当规则被触发评估资源时,产生合规评估记录,持续的合规评估形成了资源的合规时间线。规则触发方式包括:配置变更、周期执行和手动执行。

本文将提供一个示例,查询账号组ca-5885626622af0008****内的成员账号100931896542****的地域cn-hangzhou中资源new-bucket(存储空间)的合规时间线。返回结果显示,资源的合规时间线为1625200295276(北京时间:2021-07-02 12:31:35)和1625200228510(北京时间:2021-07-02 12:30:28)。

调试

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

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
config:GetAggregateResourceComplianceTimelineRead
  • 全部资源
    *

请求参数

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

资源类型。

关于如何获取资源类型,请参见 ListAggregateDiscoveredResources

ACS::OSS::Bucket
ResourceIdstring

资源 ID。

关于如何获取资源 ID,请参见 ListAggregateDiscoveredResources

new-bucket
StartTimelong

开始时间戳。默认查询发起调用前 30 天的时间。单位:毫秒。

1623211156000
EndTimelong

结束时间戳。默认查询发起调用时的时间。单位:毫秒。

1625821156000
MaxResultsinteger

单次请求返回结果的最大条数。取值范围:1~100。

10
AggregatorIdstring

账号组 ID。

关于如何获取账号组 ID,请参见 ListAggregators

ca-5885626622af0008****
Regionstring

资源归属的地域 ID。

关于如何获取资源归属的地域 ID,请参见 ListAggregateDiscoveredResources

cn-hangzhou
NextTokenstring

当请求的返回结果被截断时,您可以使用NextToken再次发起请求,获取从当前截断位置之后的内容。

5OVS5J4I1/UKTkHV5oNs****
ResourceAccountIdlong

账号组内待查询资源所属的阿里云账号 ID。

说明 参数 ResourceAccountId 和 ResourceOwnerId 必须设置其中一个,推荐使用本参数。
100931896542****

关于公共请求参数的详情,请参见公共参数

返回参数

名称类型描述示例值
object

无。

RequestIdstring

请求 ID。

8D53A78F-1EB8-4264-A554-72F07E34FAE6
ResourceComplianceTimelineobject

资源合规时间线。

NextTokenstring

查询下一页使用的 Token。

5OVS5J4I1/UKTkHV5oNs****
MaxResultsinteger

单次请求返回结果的最大条数。

10
ComplianceListobject []

资源合规时间线列表。

Tagsstring

资源标签。

{\"\"hc\"\":[\"\"value2\"\"]}
AccountIdstring

资源归属的阿里云账号 ID。

100931896542****
AvailabilityZonestring

资源可用区。

cn-hangzhou-f
ResourceTypestring

资源类型。

ACS::OSS::Bucket
ResourceCreateTimelong

创建资源的时间戳。单位:毫秒。

1624961112000
Regionstring

资源归属的地域 ID。

cn-hangzhou
Configurationstring

资源关联的规则列表和规则合规详情。

{\"Compliance\":{\"complianceType\":\"COMPLIANT\",\"count\":1},\"ConfigRuleList\":[{\"accountId\":100931896542****,\"configRuleId\":\"cr-9524626622af003d****\",\"configRuleArn\":\"acs:config::100931896542****:rule/cr-9524626622af003d****\",\"configRuleName\":\"OSS存储空间ACL禁止公共读写\",\"complianceType\":\"COMPLIANT\",\"riskLevel\":1,\"annotation\":\"\",\"invokingEventMessageType\":\"ScheduledNotification\"}]}
CaptureTimelong

记录资源合规评估的时间戳。单位:毫秒。

1625200295276
ConfigurationDiffstring

触发本次评估的资源变更细节。

{\"OSS存储空间ACL禁止公共读写\":[{\"accountId\":100931896542****,\"configRuleId\":\"cr-965f626622af003d****\",\"configRuleArn\":\"acs:config::100931896542****:rule/cr-965f626622af003d****\",\"configRuleName\":\"OSS存储空间ACL禁止公共读写\",\"complianceType\":\"COMPLIANT\",\"riskLevel\":1,\"annotation\":\"\",\"invokingEventMessageType\":\"ScheduledNotification\"},{}]}
ResourceIdstring

资源 ID。

new-bucket
ResourceNamestring

资源名称。

new-bucket
ResourceStatusstring

资源状态。资源状态取决于各云服务对其的定义,该参数可能为空。例如:

  • 当资源类型为 ACS::ECS::Instance 时,由于 ECS 实例有状态,因此该参数为 Running 或 Stopped。

  • 当资源类型为 ACS::OSS::Bucket 时,由于 OSS Bucket 无状态,因此该参数为空。

null

示例

正常返回示例

JSON格式

{
  "RequestId": "8D53A78F-1EB8-4264-A554-72F07E34FAE6",
  "ResourceComplianceTimeline": {
    "NextToken": "5OVS5J4I1/UKTkHV5oNs****",
    "MaxResults": 10,
    "ComplianceList": [
      {
        "Tags": "{\\\"\\\"hc\\\"\\\":[\\\"\\\"value2\\\"\\\"]}",
        "AccountId": "100931896542****",
        "AvailabilityZone": "cn-hangzhou-f",
        "ResourceType": "ACS::OSS::Bucket",
        "ResourceCreateTime": 1624961112000,
        "Region": "cn-hangzhou",
        "Configuration": "{\\\"Compliance\\\":{\\\"complianceType\\\":\\\"COMPLIANT\\\",\\\"count\\\":1},\\\"ConfigRuleList\\\":[{\\\"accountId\\\":100931896542****,\\\"configRuleId\\\":\\\"cr-9524626622af003d****\\\",\\\"configRuleArn\\\":\\\"acs:config::100931896542****:rule/cr-9524626622af003d****\\\",\\\"configRuleName\\\":\\\"OSS存储空间ACL禁止公共读写\\\",\\\"complianceType\\\":\\\"COMPLIANT\\\",\\\"riskLevel\\\":1,\\\"annotation\\\":\\\"\\\",\\\"invokingEventMessageType\\\":\\\"ScheduledNotification\\\"}]}",
        "CaptureTime": 1625200295276,
        "ConfigurationDiff": "{\\\"OSS存储空间ACL禁止公共读写\\\":[{\\\"accountId\\\":100931896542****,\\\"configRuleId\\\":\\\"cr-965f626622af003d****\\\",\\\"configRuleArn\\\":\\\"acs:config::100931896542****:rule/cr-965f626622af003d****\\\",\\\"configRuleName\\\":\\\"OSS存储空间ACL禁止公共读写\\\",\\\"complianceType\\\":\\\"COMPLIANT\\\",\\\"riskLevel\\\":1,\\\"annotation\\\":\\\"\\\",\\\"invokingEventMessageType\\\":\\\"ScheduledNotification\\\"},{}]}",
        "ResourceId": "new-bucket",
        "ResourceName": "new-bucket",
        "ResourceStatus": "null"
      }
    ]
  }
}

错误码

HTTP status code错误码错误信息描述
400NoPermissionYou are not authorized to perform this operation.您无权执行此操作。
400Invalid.AggregatorId.ValueThe specified AggregatorId is invalid.账号组ID不存在或无权限使用该账号组。
400Invalid.ResourceOwnerId.ValueThe specified ResourceOwnerId is invalid.该账号不存在或不在目标账号组内。
404AccountNotExistedYour account does not exist.您的账号不存在。
503ServiceUnavailableThe request has failed due to a temporary failure of the server.服务不可用。

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

变更历史

变更时间变更内容概要操作
2023-04-12OpenAPI 错误码发生变更、OpenAPI 入参发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:404
    删除错误码:503
入参OpenAPI 入参发生变更
    新增入参:ResourceAccountId