All Products
Search
Document Center

Cloud Config:GetResourceComplianceTimeline

Last Updated:Mar 01, 2024

Queries the compliance timeline of a resource.

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. The 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:GetResourceComplianceTimelineList
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
ResourceTypestringYes

The type of the resource.

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

ACS::OSS::Bucket
ResourceIdstringYes

The ID of the resource.

For more information about how to obtain the ID of a resource, see ListDiscoveredResources .

new-bucket
StartTimelongNo

The timestamp that specifies the beginning of the time range to query. By default, Cloud Config retrieves the compliance evaluations in the last 30 days for the specified resource. Unit: milliseconds.

1623211156000
EndTimelongNo

The timestamp that specifies the end of the time range to query. The default value is the time when the GetResourceComplianceTimeline operation is called. Unit: milliseconds.

1625821156000
MaxResultsintegerNo

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

10
RegionstringYes

The ID of the region where the resource resides.

cn-hangzhou
NextTokenstringNo

The token that is used to initiate the next request. If the response of the current request is truncated, this token is used to initiate another request and obtain the remaining entries.

IWBjqMYSy0is7zSMGu16****

For information about common request parameters, see Common parameters.

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

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

The information about the compliance timeline.

NextTokenstring

The token that is used to initiate the next request.

5OVS5J4I1/UKTkHV5oNs****
MaxResultsinteger

The maximum number of entries that can be returned for a single request.

10
ComplianceListobject []

The compliance evaluation records on the compliance timeline.

Tagsstring

The tags of the resource.

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

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

100931896542****
AvailabilityZonestring

The zone where 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 where the resource resides.

cn-hangzhou
Configurationstring

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

{\"Compliance\":{\"complianceType\":\"COMPLIANT\",\"count\":1},\"ConfigRuleList\":[{\"accountId\":100931896542****,\"configRuleId\":\"cr-9524626622af003d****\",\"configRuleArn\":\"acs:config::100931896542****:rule/cr-9524626622af003d****\",\"configRuleName\":\"test-rule-name\",\"complianceType\":\"COMPLIANT\",\"riskLevel\":1,\"annotation\":\"\",\"invokingEventMessageType\":\"ScheduledNotification\"}]}
CaptureTimelong

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

1625200295276
ConfigurationDiffstring

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

{\"test-rule-name\":[{\"accountId\":100931896542****,\"configRuleId\":\"cr-965f626622af003d****\",\"configRuleArn\":\"acs:config::100931896542****:rule/cr-965f626622af003d****\",\"configRuleName\":\"test-rule-name\",\"complianceType\":\"COMPLIANT\",\"riskLevel\":1,\"annotation\":\"\",\"invokingEventMessageType\":\"ScheduledNotification\"},{}]}
ResourceIdstring

The ID of the resource.

new-bucket
ResourceNamestring

The name of the resource.

new-bucket
ResourceStatusstring

The status of the resource. The parameter value varies with 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, valid values of this parameter include Running and Stopped.
  • If the ResourceType parameter is set to ACS::OSS::Bucket, the resource is an Object Storage Service (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": "{\\\"Compliance\\\":{\\\"complianceType\\\":\\\"COMPLIANT\\\",\\\"count\\\":1},\\\"ConfigRuleList\\\":[{\\\"accountId\\\":100931896542****,\\\"configRuleId\\\":\\\"cr-9524626622af003d****\\\",\\\"configRuleArn\\\":\\\"acs:config::100931896542****:rule/cr-9524626622af003d****\\\",\\\"configRuleName\\\":\\\"test-rule-name\\\",\\\"complianceType\\\":\\\"COMPLIANT\\\",\\\"riskLevel\\\":1,\\\"annotation\\\":\\\"\\\",\\\"invokingEventMessageType\\\":\\\"ScheduledNotification\\\"}]}",
        "CaptureTime": 1625200295276,
        "ConfigurationDiff": "{\\\"test-rule-name\\\":[{\\\"accountId\\\":100931896542****,\\\"configRuleId\\\":\\\"cr-965f626622af003d****\\\",\\\"configRuleArn\\\":\\\"acs:config::100931896542****:rule/cr-965f626622af003d****\\\",\\\"configRuleName\\\":\\\"test-rule-name\\\",\\\"complianceType\\\":\\\"COMPLIANT\\\",\\\"riskLevel\\\":1,\\\"annotation\\\":\\\"\\\",\\\"invokingEventMessageType\\\":\\\"ScheduledNotification\\\"},{}]}",
        "ResourceId": "new-bucket",
        "ResourceName": "new-bucket",
        "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.
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.