The following tables list the API operations available for use in Cloud Config.
Ordinary accounts
An ordinary account is an independent Alibaba Cloud account that is not added to a resource directory by using a management account. The following table describes the API operations that you can call by using ordinary accounts.
Item | API | Overview |
---|---|---|
Compliance packages | ListCompliancePackTemplates | Queries compliance package templates. |
CreateCompliancePack | Creates a compliance package. | |
ListCompliancePacks | Queries compliance packages. | |
GetCompliancePack | Queries the details of a compliance package. | |
UpdateCompliancePack | Modifies the configurations of a compliance package. | |
DeleteCompliancePacks | Deletes one or more compliance packages. | |
GenerateCompliancePackReport | Generates a compliance evaluation report based on a compliance package. | |
GetCompliancePackReport | Queries the compliance evaluation report that is generated based on a compliance package. | |
GetConfigRuleComplianceByPack | Queries compliance evaluation results based on the rules in a compliance package. | |
GetResourceComplianceByPack | Queries the compliance evaluation results of resources monitored by a compliance package. | |
Rules | CreateConfigRule | Creates a rule. |
UpdateConfigRule | Modifies a rule. | |
GetConfigRule | Queries the details of a rule. | |
DeactiveConfigRules | Disables one or more rules. | |
ListResourceEvaluationResults | Queries the compliance evaluation results of resources. | |
ListConfigRuleEvaluationResults | Queries the compliance evaluation results of resources based on rules. | |
GenerateConfigRulesReport | Generates a compliance evaluation report based on all existing rules. | |
GetConfigRulesReport | Queries the compliance evaluation report that is generated based on all existing rules. | |
GetResourceComplianceByConfigRule | Queries the compliance evaluation results of a resource by using a specific rule. | |
GetConfigRuleSummaryByRiskLevel | Queries the summary of compliance evaluation results by rule risk level. | |
AttachConfigRuleToCompliancePack | Adds one or more rules to a compliance package. | |
DetachConfigRuleToCompliancePack | Removes one or more rules from a compliance package. | |
IgnoreEvaluationResults | Ignores the compliance evaluation results of one or more incompliant resources that are evaluated by a rule. | |
RevertEvaluationResults | Re-evaluates one or more incompliant resources that are evaluated by a rule. | |
ListManagedRules | Queries managed rules. | |
GetManagedRule | Queries the details of a managed rule. | |
Resources | GetResourceComplianceTimeline | Queries the compliance timeline of a resource. |
GetResourceConfigurationTimeline | Queries the configuration timeline of a resource. | |
GetDiscoveredResourceCountsGroupByResourceType | Queries the statistics on resources grouped by resource type. | |
GetDiscoveredResourceCountsGroupByRegion | Queries the statistics on resources grouped by region. | |
GetDiscoveredResource | Queries the details of a resource. | |
ListDiscoveredResources | Queries resources based on specified query criteria. | |
Remediation templates | ListRemediationTemplates | Queries the official remediation templates for a managed rule. |
CreateRemediation | Configures a remediation template for a rule. | |
ListRemediations | Queries the remediation templates for a rule. | |
DeleteRemediations | Deletes one or more configured remediation templates from a rule. | |
StartRemediation | Performs a remediation operation by using a rule. | |
Delivery channels | CreateConfigDeliveryChannel | Creates a delivery channel. |
UpdateConfigDeliveryChannel | Modifies a delivery channel. | |
ListConfigDeliveryChannels | Queries the information about all delivery channels. | |
GetConfigDeliveryChannel | Queries the information about a delivery channel. | |
CreateDeliveryChannel (not recommended) | Creates a delivery channel. | |
UpdateDeliveryChannel (not recommended) | Modifies a delivery channel. |
Management accounts
A management account is an Alibaba Cloud account that is used to create a resource directory and manages all member accounts in the resource directory. The following table describes the API operations that you can call by using management accounts.
Item | API | Overview |
---|---|---|
Account groups | CreateAggregator | Creates an account group. |
ListAggregators | Queries account groups. | |
GetAggregator | Queries the details of an account group. | |
UpdateAggregator | Modifies the configurations of an account group. | |
DeleteAggregators | Deletes one or more account groups. | |
Compliance packages | ListCompliancePackTemplates | Queries compliance package templates. |
CreateAggregateCompliancePack | Creates a compliance package for an account group. | |
ListAggregateCompliancePacks | Queries the compliance packages in an account group. | |
GetAggregateCompliancePack | Queries the details of a compliance package in an account group. | |
UpdateAggregateCompliancePack | Modifies the configurations of a compliance package in an account group. | |
DeleteAggregateCompliancePacks | Deletes one or more compliance packages from an account group. | |
GenerateAggregateCompliancePackReport | Generates a compliance evaluation report based on a compliance package in an account group. | |
GetAggregateCompliancePackReport | Queries the compliance evaluation report that is generated based on a compliance package in an account group. | |
GetAggregateResourceComplianceByPack | Queries the compliance evaluation results of resources monitored by a compliance package in an account group. | |
GetAggregateConfigRuleComplianceByPack | Queries compliance evaluation results based on the rules in a compliance package in an account group. | |
GetAggregateAccountComplianceByPack | Queries the compliance evaluation results of member accounts for which a compliance package takes effect in an account group. | |
Rules | CreateAggregateConfigRule | Creates a rule for an account group. |
ListAggregateConfigRules | Queries the rules in an account group. | |
GetAggregateConfigRule | Queries the details of a rule in an account group. | |
UpdateAggregateConfigRule | Modifies a rule in an account group. | |
DeleteAggregateConfigRules | Deletes one or more rules from an account group. | |
ActiveAggregateConfigRules | Enables one or more rules in an account group. | |
DeactiveAggregateConfigRules | Disables one or more rules in an account group. | |
GenerateAggregateConfigRulesReport | Generates a compliance evaluation report based on all rules in an account group. | |
GetAggregateConfigRulesReport | Queries the compliance evaluation report that is generated based on all rules in an account group. | |
StartAggregateConfigRuleEvaluation | Uses a rule in an account group to evaluate the involved resources. | |
GetAggregateResourceComplianceByConfigRule | Queries the compliance evaluation results based on a rule in an account group. | |
GetAggregateConfigRuleSummaryByRiskLevel | Queries the summary of compliance evaluation results by rule risk level in an account group. | |
ListAggregateConfigRuleEvaluationResults | Queries the compliance evaluation results of resources based on rules in an account group. | |
ListAggregateResourceEvaluationResults | Queries the compliance evaluation results of resources in an account group. | |
AttachAggregateConfigRuleToCompliancePack | Adds one or more rules in an account group to a compliance package. | |
DetachAggregateConfigRuleToCompliancePack | Removes one or more rules in an account group from a compliance package. | |
IgnoreAggregateEvaluationResults | Ignores the compliance evaluation results of one or more incompliant resources that are evaluated by a rule in an account group. | |
RevertAggregateEvaluationResults | Re-evaluates one or more incompliant resources that are evaluated by a rule in an account group. | |
Resource | GetAggregateResourceCountsGroupByResourceType | Queries the statistics on resources grouped by resource type in an account group. |
GetAggregateResourceCountsGroupByRegion | Queries the statistics on resources grouped by region in an account group. | |
GetAggregateResourceConfigurationTimeline | Queries the configuration timeline of a resource in an account group. | |
GetAggregateResourceComplianceTimeline | Queries the compliance timeline of a resource in an account group. | |
GetAggregateDiscoveredResource | Queries the details of a resource in an account group. | |
ListAggregateDiscoveredResources | Queries the resources in an account group. | |
Remediation templates | CreateAggregateRemediation | Configures a remediation template for a rule in an account group. |
ListAggregateRemediations | Queries the remediation templates for a rule in an account group. | |
DeleteAggregateRemediations | Deletes one or more configured remediation templates from a rule in an account group. | |
StartAggregateRemediation | Performs a remediation operation by using a rule in an account group. |
Member accounts
- If a member account is not added to an account group, you can use the member account to call all API operations that you can call by using an ordinary account. For more information, see the Ordinary accounts section of the "List of operations by function" topic.
- If a member account is added to an account group, you can use the member account to
call all API operations that you can call by using an ordinary account, and call the
query API operations that you can call by using a management account to query the
account group to which the member account belongs, and the compliance packages, rules,
resources, and remediation templates that the member account owns.
- For more information about all API operations that you can call by using an ordinary account, see the Ordinary accounts section of the "List of operations by function" topic.
- The following table describes the query API operations that you can call by using
a management account.
Item Operation Description Account groups ListAggregators Queries account groups. GetAggregator Queries the details of an account group. Compliance packages ListAggregateCompliancePacks Queries the compliance packages in an account group. GetAggregateCompliancePack Queries the details of a compliance package in an account group. GetAggregateResourceComplianceByPack Queries the compliance evaluation results of resources monitored by a compliance package in an account group. GetAggregateConfigRuleComplianceByPack Queries the compliance evaluation results based on rules in a compliance package in an account group. GetAggregateAccountComplianceByPack Queries the compliance evaluation results of member accounts on which a compliance package takes effect in an account group. Rules ListAggregateConfigRules Queries the rules in an account group. GetAggregateConfigRule Queries the details of a rule in an account group. GetAggregateResourceComplianceByConfigRule Queries the compliance evaluation results based on a rule in an account group. GetAggregateConfigRuleSummaryByRiskLevel Queries the summary of compliance evaluation results by rule risk level in an account group. ListAggregateConfigRuleEvaluationResults Queries the compliance evaluation results of resources based on rules in an account group. Note- If you do not set the request parameter
ResourceOwnerId
, Cloud Config queries the compliance evaluation results generated for specific resources based on the rules that belong to the current member account. - If you want to set the request parameter
ResourceOwnerId
, you must set this parameter to the ID of the current member account.
ListAggregateResourceEvaluationResults Queries the compliance evaluation results of resources in an account group. Resources ListAggregateDiscoveredResources Queries the resources in an account group. Note- If you do not set the request parameter
ResourceOwnerId
, Cloud Config queries the resources that belong to the current member account. - If you want to set the request parameter
ResourceOwnerId
, you must set this parameter to the ID of the current member account.
GetAggregateDiscoveredResource Queries the details of a resource in an account group. Note- If you do not set the request parameter
ResourceOwnerId
, Cloud Config queries the details of the resource that belongs to the current member account. - If you want to set the request parameter
ResourceOwnerId
, you must set this parameter to the ID of the current member account.
GetAggregateResourceCountsGroupByResourceType Queries the statistics on resources grouped by resource type in an account group. GetAggregateResourceCountsGroupByRegion Queries the statistics on resources grouped by region in an account group. GetAggregateResourceConfigurationTimeline Queries the configuration timeline of a resource in an account group. Note- If you do not set the request parameter
ResourceOwnerId
, Cloud Config queries the configuration timeline of the resource that belongs to the current member account. - If you want to set the request parameter
ResourceOwnerId
, you must set this parameter to the ID of the current member account.
GetAggregateResourceComplianceTimeline Queries the compliance timeline of a resource in an account group. Note- If you do not set the request parameter
ResourceOwnerId
, Cloud Config queries the compliance timeline of the resource that belongs to the current member account. - If you want to set the request parameter
ResourceOwnerId
, you must set this parameter to the ID of the current member account.
Remediation templates ListAggregateRemediations Queries the remediation templates for a rule in an account group. - If you do not set the request parameter