All Products
Search
Document Center

Cloud Config:GetAggregateResourceComplianceTimeline

Last Updated:Mar 01, 2024

Queries the compliance timeline of a resource in an account group.

Operation description

The sample request in this topic shows you how to query the compliance timeline of the new-bucket resource that resides in the cn-hangzhou region within the 100931896542**** member account of the ca-5885626622af0008**** account group. The new-bucket resource is an Object Storage Service (OSS) bucket. The return result shows the following two timestamps on the compliance timeline: 1625200295276 and 1625200228510. The first timestamp indicates 12:31:35 on July 2, 2021 (UTC+8), and the second timestamp indicates 12:30:28 on July 2, 2021 (UTC+8).

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
config:GetAggregateResourceComplianceTimelineRead
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
ResourceTypestringYes

The resource type.

For more information about how to obtain the type of a resource, see ListAggregateDiscoveredResources .

ACS::OSS::Bucket
ResourceIdstringYes

The resource ID.

For more information about how to query the ID of a resource, see ListAggregateDiscoveredResources .

new-bucket
StartTimelongNo

The beginning of the time range to query. By default, Cloud Config retrieves the configuration changes in the last 30 days for the specified resource. Unit: milliseconds.

1623211156000
EndTimelongNo

The end of the time range to query. The default value indicates the time when the GetAggregateResourceConfigurationTimeline operation is called. Unit: milliseconds.

1625821156000
MaxResultsintegerNo

The maximum number of entries returned for a single request. Valid values: 1 to 100.

10
AggregatorIdstringYes

The ID of the account group.

For information about how to obtain the ID of the account group, see ListAggregators .

ca-5885626622af0008****
RegionstringYes

The ID of the region where the resource resides.

For more information about how to obtain the ID of a region, see ListAggregateDiscoveredResources .

cn-hangzhou
NextTokenstringNo

The token that is used to initiate the next request if the response of the current request is truncated. You can use the token to initiate another request and obtain the remaining records.

5OVS5J4I1/UKTkHV5oNs****
ResourceAccountIdlongNo

The ID of the Alibaba Cloud account to which the resources in the account group belong.

Note You can use either the ResourceAccountId or ResourceOwnerId parameter. We recommend that you use the ResourceAccountId parameter.
100931896542****

For more information about common request parameters, see API Reference.

Response parameters

ParameterTypeDescriptionExample
object

The returned data.

RequestIdstring

The request ID.

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

The information about the compliance timeline.

NextTokenstring

A pagination token. It can be used in the next request to retrieve a new page of results.

5OVS5J4I1/UKTkHV5oNs****
MaxResultsinteger

The maximum number of entries returned for a single request.

10
ComplianceListobject []

The status of the resource. The parameter value varies based on the resource type and may be left empty. Examples:

  • If the value of the ResourceType parameter is ACS::ECS::Instance, the resource is an Elastic Compute Service (ECS) instance that has a specific state. In this case, the valid values of this parameter are Running and Stopped.
  • If the value of the ResourceType parameter is ACS::OSS::Bucket, the resource is an Object Storage Service (OSS) bucket that is not in a specific state. In this case, this parameter is empty.
Tagsstring

The tags of the resource.

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

The ID of the Alibaba Cloud account to which the resource belongs.

100931896542****
AvailabilityZonestring

The ID of the zone in which the resource resides.

cn-hangzhou-f
ResourceTypestring

The type of the resource.

ACS::OSS::Bucket
ResourceCreateTimelong

The timestamp when the resource was created. Unit: milliseconds.

1624961112000
Regionstring

The ID of the region in which the resource resides.

cn-hangzhou
Configurationstring

The information about the rules that evaluated the resource and the compliance evaluation result.

{ "AccessControlList": { "Grant": "private" }, "ServerSideEncryptionRule": { "SSEAlgorithm": "None" }, "Comment": "", "Owner": { "DisplayName": "126672004088****", "ID": "126672004088****" }, "ResourceGroupId": "rg-acfmy4dfoau****", "StorageClass": "Standard", "DataRedundancyType": "LRS", "AllowEmptyReferer": "true", "Name": "test-private-oss****", "BucketPolicy": { "LogPrefix": "", "LogBucket": "" }, "ExtranetEndpoint": "oss-cn-hangzhou.aliyuncs.com", "IntranetEndpoint": "oss-cn-hangzhou-internal.aliyuncs.com", "Location": "oss-cn-hangzhou" }
CaptureTimelong

The timestamp when the compliance evaluation was recorded. Unit: milliseconds.

1625200295276
ConfigurationDiffstring

The details of the resource change that triggered the compliance evaluation.

{ "ResourceGroupId": [ "rg-acfmy4dfoau****", "rg-a3dmy4lksta****" ] }
ResourceIdstring

The ID of the resource.

test-private-oss****
ResourceNamestring

The name of the resource.

test-private-oss****
ResourceStatusstring

The status of the resource. The parameter value varies based on the resource type and may be left empty. Examples:

  • If the ResourceType parameter is set to ACS::ECS::Instance, the resource is an Elastic Compute Service (ECS) instance that has a specific state. In this case, the valid values of this parameter are Running and Stopped.
  • If the ResourceType parameter is set to ACS::OSS::Bucket, the resource is an OSS bucket that does not have a specific state. In this case, this parameter is left empty.
Running

Examples

Sample success responses

JSONformat

{
  "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": "{\n    \"AccessControlList\": {\n        \"Grant\": \"private\"\n    },\n    \"ServerSideEncryptionRule\": {\n        \"SSEAlgorithm\": \"None\"\n    },\n    \"Comment\": \"\",\n    \"Owner\": {\n        \"DisplayName\": \"126672004088****\",\n        \"ID\": \"126672004088****\"\n    },\n    \"ResourceGroupId\": \"rg-acfmy4dfoau****\",\n    \"StorageClass\": \"Standard\",\n    \"DataRedundancyType\": \"LRS\",\n    \"AllowEmptyReferer\": \"true\",\n    \"Name\": \"test-private-oss****\",\n    \"BucketPolicy\": {\n        \"LogPrefix\": \"\",\n        \"LogBucket\": \"\"\n    },\n    \"ExtranetEndpoint\": \"oss-cn-hangzhou.aliyuncs.com\",\n    \"IntranetEndpoint\": \"oss-cn-hangzhou-internal.aliyuncs.com\",\n    \"Location\": \"oss-cn-hangzhou\"\n}",
        "CaptureTime": 1625200295276,
        "ConfigurationDiff": "{\n    \"ResourceGroupId\": [\n        \"rg-acfmy4dfoau****\",\n        \"rg-a3dmy4lksta****\"\n    ]\n}",
        "ResourceId": "test-private-oss****",
        "ResourceName": "test-private-oss****",
        "ResourceStatus": "Running"
      }
    ]
  }
}

Error codes

HTTP status codeError codeError messageDescription
400NoPermissionYou are not authorized to perform this operation.You are not authorized to perform this operation.
400Invalid.AggregatorId.ValueThe specified AggregatorId is invalid.The specified aggregator ID does not exist or you are not authorized to use the aggregator.
400Invalid.ResourceOwnerId.ValueThe specified ResourceOwnerId is invalid.The specified ResourceOwnerId is invalid.
404AccountNotExistedYour account does not exist.The specified account does not exist.
503ServiceUnavailableThe request has failed due to a temporary failure of the server.The request has failed due to a temporary failure of the server.

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2023-04-12The Error code has changed. The request parameters of the API has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 400
    delete Error Codes: 404
    delete Error Codes: 503
Input ParametersThe request parameters of the API has changed.
    Added Input Parameters: ResourceAccountId