This product(
Config/2020-09-07) OpenAPI adopts RPC Signature style. See signature details in Description of the signature mechanism. We have packaged SDKs for common programming languages for developers. Developers can directly call the OpenAPI of this product by downloading the SDK without paying attention to the technical details. If the existing SDK cannot meet the usage requirements, you can connect through the signature mechanism. It will take about 5 working days. Therefore, it is recommended to join our DingTalk service group (11370001915) and sign under the guidance of experts. Before using the API, you need to prepare your identity account and access key (AccessKey) to effectively access the API through client tools (SDK, CLI, etc.). For details see getAccessKey.
Resources
| API | Title | Description |
|---|---|---|
| Single-account | Single-account | |
| ListDiscoveredResources | ListDiscoveredResources | Queries the resources in the current Alibaba Cloud account. |
| GetDiscoveredResource | GetDiscoveredResource | Queries the details of a resource. |
| ListResourceRelations | ListResourceRelations | Queries a list of the relationships between a resource and the object that is associated with the resource. |
| GetResourceConfigurationTimeline | GetResourceConfigurationTimeline | Queries the configuration timeline of a resource. |
| GetResourceComplianceTimeline | GetResourceComplianceTimeline | Queries the compliance timeline of a resource. |
| ListResourcesByAdvancedSearch | ListResourcesByAdvancedSearch | Queries the resources of the current Alibaba Cloud account by using a SQL statement. |
| CreateAdvancedSearchFile | CreateAdvancedSearchFile | Creates a downloadable resource file for the current Alibaba Cloud account. |
| GetAdvancedSearchFile | GetAdvancedSearchFile | Queries the most recently generated resource file of the current Alibaba Cloud account. |
| GenerateResourceInventory | GenerateResourceInventory | Generates a resource inventory for global resources. |
| GetResourceInventory | GetResourceInventory | Queries the most recently generated resource inventory of the current Alibaba Cloud account. |
| GetDiscoveredResourceCountsGroupByRegion | GetDiscoveredResourceCountsGroupByRegion | Queries the statistics on resources by region. |
| GetDiscoveredResourceCountsGroupByResourceType | GetDiscoveredResourceCountsGroupByResourceType | Queries the statistics on resources by resource type. |
| GetResourceComplianceGroupByResourceType | GetResourceComplianceGroupByResourceType | Queries the evaluation results grouped by resource type for a rule. |
| GetResourceComplianceGroupByRegion | GetResourceComplianceGroupByRegion | Queries the evaluation results grouped by region for a rule. |
| Multi-account | Multi-account | |
| ListAggregateDiscoveredResources | ListAggregateDiscoveredResources | Queries a list of resources in an account group. |
| GetAggregateDiscoveredResource | GetAggregateDiscoveredResource | Queries the details of a resource in an account group. |
| ListAggregateResourceRelations | ListAggregateResourceRelations | Queries a list of the relationships between a resource and the object that is associated with the resource in an account group. |
| GetAggregateResourceConfigurationTimeline | GetAggregateResourceConfigurationTimeline | Queries the configuration timeline of a resource in an account group. |
| GetAggregateResourceComplianceTimeline | GetAggregateResourceComplianceTimeline | Queries the compliance timeline of a resource in an account group. |
| ListAggregateResourcesByAdvancedSearch | ListAggregateResourcesByAdvancedSearch | This topic provides an example on how to query all resources with the business tag key and the online tag value in an account group. |
| CreateAggregateAdvancedSearchFile | CreateAggregateAdvancedSearchFile | Creates a downloadable resource file for an account group. |
| GetAggregateAdvancedSearchFile | GetAggregateAdvancedSearchFile | Queries the most recently generated resource file of an account group. |
| GenerateAggregateResourceInventory | GenerateAggregateResourceInventory | Generates a downloadable inventory for global resources in an account group. |
| GetAggregateResourceInventory | GetAggregateResourceInventory | Queries the most recently generated resource inventory of an account group. |
| GetAggregateResourceCountsGroupByRegion | GetAggregateResourceCountsGroupByRegion | Queries the statistics on the resources in an account group by region. |
| GetAggregateResourceCountsGroupByResourceType | GetAggregateResourceCountsGroupByResourceType | Queries the statistics on the resources in an account group by resource type. |
| GetAggregateResourceComplianceGroupByRegion | GetAggregateResourceComplianceGroupByRegion | Queries the evaluation results grouped by resource type for an account group rule. |
| GetAggregateResourceComplianceGroupByResourceType | GetAggregateResourceComplianceGroupByResourceType | Queries the evaluation results grouped by resource type for an account group rule. |
| GetSupportedResourceRelationConfig | GetSupportedResourceRelationConfig | Queries the resource relationships supported by a resource type. |
| ListSupportedProducts | ListSupportedProducts | Queries the cloud services and resource types that are supported by Cloud Config. |
Rules
| API | Title | Description |
|---|---|---|
| Single-account | Single-account | |
| CreateConfigRule | CreateConfigRule | Creates a rule for the current account. |
| UpdateConfigRule | UpdateConfigRule | Modifies the rules of an account. |
| DeactiveConfigRules | DeactiveConfigRules | Disables one or more rules. |
| ListConfigRules | ListConfigRules | Queries the rules of the current account. |
| GetConfigRule | GetConfigRule | Queries the details of a rule. |
| ListConfigRuleEvaluationResults | ListConfigRuleEvaluationResults | Queries a list of compliance evaluation results of resources based on a rule. |
| ListResourceEvaluationResults | ListResourceEvaluationResults | Queries the compliance evaluation result of a resource. |
| StartConfigRuleEvaluation | StartConfigRuleEvaluation | Re-evaluates the compliance of resources based on a rule or compliance package. |
| ActiveConfigRules | ActiveConfigRules | Enables multiple rules at a time so that these rules enter the Active state. |
| DeleteConfigRules | DeleteConfigRules | Deletes rules. |
| IgnoreEvaluationResults | IgnoreEvaluationResults | Ignores one or more resources that are evaluated as non-compliant by using a rule. |
| RevertEvaluationResults | RevertEvaluationResults | Re-evaluates non-compliant resources that are evaluated based on a rule. |
| GenerateConfigRulesReport | GenerateConfigRulesReport | Generates a compliance evaluation report based on all existing rules. |
| GetConfigRulesReport | GetConfigRulesReport | Queries the compliance evaluation report that is generated based on all existing rules. |
| AttachConfigRuleToCompliancePack | AttachConfigRuleToCompliancePack | Adds one or more rules to a compliance package. |
| DetachConfigRuleToCompliancePack | DetachConfigRuleToCompliancePack | Removes one or more rules from a compliance package. |
| GetConfigRuleSummaryByRiskLevel | GetConfigRuleSummaryByRiskLevel | Queries the summary of compliance evaluation results by rule risk level. |
| GetResourceComplianceByConfigRule | GetResourceComplianceByConfigRule | Queries the compliance evaluation result of a resource by using a rule. |
| GetComplianceSummary | GetComplianceSummary | Queries the summary of compliance statistics within the current account. |
| ListConfigRuleEvaluationStatistics | ListConfigRuleEvaluationStatistics | Queries the statistics of compliance evaluation results of the current Alibaba Cloud account. |
| Multi-account | Multi-account | |
| CreateAggregateConfigRule | CreateAggregateConfigRule | Creates a rule for an account group. |
| UpdateAggregateConfigRule | UpdateAggregateConfigRule | Modifies a rule in an account group. |
| DeleteAggregateConfigRules | DeleteAggregateConfigRules | Deletes one or more rules from an account group. |
| ListAggregateConfigRules | ListAggregateConfigRules | Queries a list of rules in an account group. |
| GetAggregateConfigRule | GetAggregateConfigRule | Queries the details of a rule in an account group. |
| ListAggregateConfigRuleEvaluationResults | ListAggregateConfigRuleEvaluationResults | Queries the compliance evaluation results of resources based on a rule in an account group. |
| ListAggregateResourceEvaluationResults | ListAggregateResourceEvaluationResults | Queries the compliance evaluation results of resources in an account group. |
| ActiveAggregateConfigRules | ActiveAggregateConfigRules | Enables one or more rules in an account group. |
| DeactiveAggregateConfigRules | DeactiveAggregateConfigRules | Disables one or more rules in an account group. |
| IgnoreAggregateEvaluationResults | IgnoreAggregateEvaluationResults | Ignores the compliance evaluation results of one or more non-compliant resources that are evaluated based on a rule in an account group. |
| RevertAggregateEvaluationResults | RevertAggregateEvaluationResults | Re-evaluates one or more incompliant resources that are evaluated based on a rule in an account group. |
| AttachAggregateConfigRuleToCompliancePack | AttachAggregateConfigRuleToCompliancePack | Adds one or more rules in an account group to a compliance package. |
| DetachAggregateConfigRuleToCompliancePack | DetachAggregateConfigRuleToCompliancePack | Removes one or more rules in an account group from a compliance package. |
| StartAggregateConfigRuleEvaluation | StartAggregateConfigRuleEvaluation | Starts to evaluate the involved resources by using a rule in an account group. |
| GenerateAggregateConfigRulesReport | GenerateAggregateConfigRulesReport | Generates a compliance evaluation report based on all rules in an account group. |
| GetAggregateConfigRulesReport | GetAggregateConfigRulesReport | Queries the compliance evaluation report that is generated based on all rules in an account group. |
| GetAggregateConfigRuleSummaryByRiskLevel | GetAggregateConfigRuleSummaryByRiskLevel | Queries the summary of compliance evaluation results by rule risk level in an account group. |
| GetAggregateResourceComplianceByConfigRule | GetAggregateResourceComplianceByConfigRule | Queries compliance evaluation results based on the rules in a compliance package in an account group. |
| GetAggregateComplianceSummary | GetAggregateComplianceSummary | Queries the compliance statistics of an account group. |
| ListAggregateConfigRuleEvaluationStatistics | ListAggregateConfigRuleEvaluationStatistics | Queries the statistics of compliance evaluation results of an account group. |
| ListManagedRules | ListManagedRules | Queries managed rules. |
| GetManagedRule | GetManagedRule | Queries the details of a managed rule. |
| PutEvaluations | PutEvaluations | Submits the evaluation results of a custom rule to Function Compute. |
| ListPreManagedRules | ListPreManagedRules | Queries a list of evaluation rules. |
| EvaluatePreConfigRules | EvaluatePreConfigRules | Executes evaluation rules to evaluate resources. |
| CopyConfigRules | CopyConfigRules | Replicates rules. |
Compliance Package
| API | Title | Description |
|---|---|---|
| Single-account | Single-account | |
| CreateCompliancePack | CreateCompliancePack | Creates a compliance package for the current account. |
| UpdateCompliancePack | UpdateCompliancePack | Modifies the configurations of a compliance package within your account. |
| ListCompliancePacks | ListCompliancePacks | Queries a list of compliance packages. |
| GetCompliancePack | GetCompliancePack | Queries the details of a compliance package. |
| DeleteCompliancePacks | DeleteCompliancePacks | Deletes one or more compliance packages. |
| GenerateCompliancePackReport | GenerateCompliancePackReport | Generates a compliance evaluation report based on a compliance package. |
| GetCompliancePackReport | GetCompliancePackReport | Queries the compliance evaluation report that is generated based on a compliance package. |
| GetConfigRuleComplianceByPack | GetConfigRuleComplianceByPack | Queries compliance evaluation results based on the rules in a compliance package. |
| GetResourceComplianceByPack | GetResourceComplianceByPack | Queries the compliance evaluation results of resources evaluated based on a compliance package. |
| Multi-account | Multi-account | |
| CreateAggregateCompliancePack | CreateAggregateCompliancePack | Creates a compliance package for an account group. |
| UpdateAggregateCompliancePack | UpdateAggregateCompliancePack | Modifies the configurations of a compliance package in an account group. |
| ListAggregateCompliancePacks | ListAggregateCompliancePacks | Queries a list of compliance packages in an account group. |
| GetAggregateCompliancePack | GetAggregateCompliancePack | Queries the details of a compliance package in an account group. |
| DeleteAggregateCompliancePacks | DeleteAggregateCompliancePacks | Deletes the compliance packages of an account group. |
| GenerateAggregateCompliancePackReport | GenerateAggregateCompliancePackReport | Generates a compliance evaluation report based on a compliance package in an account group. |
| GetAggregateCompliancePackReport | GetAggregateCompliancePackReport | Queries the compliance evaluation report that is generated based on a compliance package of an account group. |
| GetAggregateResourceComplianceByPack | GetAggregateResourceComplianceByPack | Queries the compliance evaluation results of resources evaluated based on a compliance package of an account group. |
| GetAggregateConfigRuleComplianceByPack | GetAggregateConfigRuleComplianceByPack | Queries compliance evaluation results based on the rules in a compliance package in an account group. |
| GetAggregateAccountComplianceByPack | GetAggregateAccountComplianceByPack | Queries the compliance evaluation results of member accounts for which a compliance package takes effect in an account group. |
| ListCompliancePackTemplates | ListCompliancePackTemplates | Queries a list of compliance package templates. |
| CopyCompliancePacks | CopyCompliancePacks | Replicates compliance packages. |
Remediation templates
| API | Title | Description |
|---|---|---|
| Single-account | Single-account | |
| CreateRemediation | CreateRemediation | Creates a remediation template for a rule. |
| UpdateRemediation | UpdateRemediation | Updates a remediation template for a rule. |
| ListRemediations | ListRemediations | Queries the information about the execution of remediation templates. |
| DeleteRemediations | DeleteRemediations | Deletes one or more configured remediation templates that are associated with a rule. |
| StartRemediation | StartRemediation | Performs a remediation operation by using a rule. |
| ListRemediationExecutions | ListRemediationExecutions | Queries the remediation records of a rule. |
| DescribeRemediation | DescribeRemediation | This topic provides an example on how to query the details of a remediation configuration whose ID is crr-f381cf0c1c2f004e\\*\\*\\*\\*. |
| Multi-account | Multi-account | |
| CreateAggregateRemediation | CreateAggregateRemediation | Creates a remediation template for a rule in an account group. |
| UpdateAggregateRemediation | UpdateAggregateRemediation | Modifies a remediation template for a rule in an account group. |
| ListAggregateRemediations | ListAggregateRemediations | Queries a list of remediation templates for a rule in an account group. |
| DeleteAggregateRemediations | DeleteAggregateRemediations | Deletes one or more remediation templates from a rule in an account group. |
| StartAggregateRemediation | StartAggregateRemediation | Performs a remediation operation by using a rule in an account group. |
| ListAggregateRemediationExecutions | ListAggregateRemediationExecutions | Queries the remediation records of a rule in an account group. |
| ListRemediationTemplates | ListRemediationTemplates | Queries a list of remediation templates for a managed rule. |
| GetRemediationTemplate | GetRemediationTemplate | Queries the details of an automatic remediation template. |
Deliveries
| API | Title | Description |
|---|---|---|
| Single-account | Single-account | |
| CreateConfigDeliveryChannel | CreateConfigDeliveryChannel | Creates a delivery channel. |
| UpdateConfigDeliveryChannel | UpdateConfigDeliveryChannel | Modifies a delivery channel. |
| DeleteConfigDeliveryChannel | DeleteConfigDeliveryChannel | Deletes a delivery channel. |
| ListConfigDeliveryChannels | ListConfigDeliveryChannels | Queries a list of delivery channels. |
| GetConfigDeliveryChannel | GetConfigDeliveryChannel | Queries the information about a delivery channel. |
| CreateDeliveryChannel | CreateDeliveryChannel | Creates a delivery channel. |
| UpdateDeliveryChannel | UpdateDeliveryChannel | Modifies a delivery channel. |
| Multi-account | Multi-account | |
| CreateAggregateConfigDeliveryChannel | CreateAggregateConfigDeliveryChannel | Creates a delivery channel for an account group. |
| UpdateAggregateConfigDeliveryChannel | UpdateAggregateConfigDeliveryChannel | Modifies a delivery channel in an account group. |
| DeleteAggregateConfigDeliveryChannel | DeleteAggregateConfigDeliveryChannel | Deletes a delivery channel from an account group. |
| ListAggregateConfigDeliveryChannels | ListAggregateConfigDeliveryChannels | Queries the information about all delivery channels in an account group. |
| GetAggregateConfigDeliveryChannel | GetAggregateConfigDeliveryChannel | Queries the information about a delivery channel in an account group. |
Account Groups
| API | Title | Description |
|---|---|---|
| CreateAggregator | CreateAggregator | Creates an account group. |
| UpdateAggregator | UpdateAggregator | Modify an account group |
| DeleteAggregators | DeleteAggregators | Deletes an account group. |
| ListAggregators | ListAggregators | Queries a list of account groups that the current account manages or to which the current account belongs. |
| GetAggregator | GetAggregator | Queries the details of an account group. |
Tags
| API | Title | Description |
|---|---|---|
| ListTagResources | ListTagResources | Queries tags that are added to specified resources. |
| TagResources | TagResources | Adds tags to resources. |
| UntagResources | UntagResources | Removes tags from specified resources. |
Service integration
| API | Title | Description |
|---|---|---|
| GetIntegratedServiceStatus | GetIntegratedServiceStatus | Queries the status of a cloud service that is integrated with Cloud Config. |
| UpdateIntegratedServiceStatus | UpdateIntegratedServiceStatus | Enables or disables the integration of a cloud service. |
| ListIntegratedService | ListIntegratedService | Queries the cloud services that can be integrated by the current Alibaba Cloud account. |
Service settings
| API | Title | Description |
|---|---|---|
| GetConfigurationRecorder | GetConfigurationRecorder | Queries the activation status and resource monitoring scope of Cloud Config for the current account. |
| StartConfigurationRecorder | StartConfigurationRecorder | Enables Cloud Config to monitor the resources of your Alibaba Cloud account. |
| UpdateConfigurationRecorder | UpdateConfigurationRecorder | Modifies the resource monitoring scope of the current account. |
| StopConfigurationRecorder | StopConfigurationRecorder | Deactivates Cloud Config. |