tencent cloud

APIs

DocumentationAPIsConfigData Types

Data Types

Download
Focus Mode
Font Size
Last updated: 2026-10-19 16:09:37

AggregateEvaluationResult

Assessment result

Used by actions: ListAggregateConfigRuleEvaluationResults.

Name Type Description
ResourceId String Resource ID
ResourceType String Resource type.
ResourceRegion String Resource region
ResourceName String Resource name
ConfigRuleId String Rule ID
ConfigRuleName String Rule name
CompliancePackId String Compliance package ID.
RiskLevel Integer Risk level
Annotation Annotation Assessment result
ComplianceType String Compliance type.
InvokingEventMessageType String Rule initiation type.
ConfigRuleInvokedTime String Evaluation initiation time.
ResultRecordedTime String Actual evaluation time.
ResourceOwnerId Integer Resource owner ID.
ResourceOwnerName String Resource owner user name.

AggregateResourceInfo

Resource list information

Used by actions: ListAggregateDiscoveredResources.

Name Type Description
ResourceType String Resource type.
ResourceName String Resource name
ResourceId String Resource ID
ResourceRegion String Region.
ResourceStatus String Resource status.
ResourceDelete Integer Deletion status. Valid values: 1 (deleted) and 0 (not deleted).
ResourceCreateTime String Resource creation time
Tags Array of Tag Tag information.
ResourceZone String AZ.
ComplianceResult String Compliance status
ResourceOwnerId Integer Resource owner ID.
ResourceOwnerName String User Nickname

Aggregator

User group list information.

Used by actions: ListAggregators.

Name Type Description
Name String Account group name
Description String Account group description
OwnerUin Integer Creator user ID.
CreateTime String Creation time.
AccountCount Integer Number of account group members.
Type String RD: global account group.
AccountGroupId String Account group ID.
AggregatorStatus Integer Account group status.
MemberName String Account group name

AggregatorAccount

Member information

Used by actions: CreateAggregator, DescribeAggregator, UpdateAggregator.

Name Type Required Description
MemberUin Integer Yes Member ID
MemberName String Yes Member name.

AlarmPolicyRsp

Structure of a single alarm policy record.

Used by actions: ListAlarmPolicy.

Name Type Required Description
AlarmPolicyId Integer No Unique alarm policy ID.
Name String No Policy name.
Type Integer No Event type
EventScope Array of Integer No Valid values: 1 (current account) and 2 (multi-account).
RiskLevel Array of Integer No Valid values: 1 (high risk), 2 (medium risk), and 3 (low risk).
NoticePeriod Array of Integer No Notification cycle. Value range: 1 to 7, representing Monday to Sunday respectively.
NoticeTime String No Notification period
NotificationMechanism String No Notification mechanism
Status Integer No Policy status. Valid values: 1 (enabled) and 2 (disabled).
Description String No Policy description

Annotation

Compliance details

Used by actions: DescribeAggregateConfigRule, DescribeConfigRule, ListAggregateConfigRuleEvaluationResults, ListAggregateConfigRuleResourceEvaluationResults, ListAggregateConfigRules, ListConfigRuleEvaluationResults, ListConfigRuleResourceEvaluationResults, ListConfigRules, PutEvaluations.

Name Type Required Description
Configuration String Yes Current actual resource configuration. A length of 0 to 256 characters indicates non-compliant resource configuration.
DesiredValue String Yes Expected resource configuration. A length of 0 to 256 characters indicates compliant resource configuration.
Operator String No Comparison operator between current and desired configuration of the resource. Length is 0-16 characters. This field may be empty when custom rule reporting evaluation result.
Property String No JSON path of current configuration in resource attribute structure. Length is 0-256 characters. This field may be empty when custom rule reporting evaluation result.

ComplianceConfigRule

Compliance package rule information.

Used by actions: DescribeAggregateCompliancePack, DescribeCompliancePack.

Name Type Description
RuleName String Rule name
RiskLevel Integer Risk level
Status String Rule status
ConfigRuleId String Rule ID
ComplianceResult String Assessment result
Compliant: 'COMPLIANT'
Non-compliant: 'NON_COMPLIANT'
Labels Array of String Keyword.
InputParameter Array of InputParameter Input parameters
SourceCondition Array of SourceConditionForManage Parameter format.
Identifier String Rule ID
CreateByType String Creation method. Valid values: user, compliancePack, and system.
Description String Rule description
ManageInputParameter Array of InputParameterForManage Parameter description

CompliancePackRule

Compliance package rule information.

Used by actions: AddAggregateCompliancePack, AddCompliancePack, UpdateAggregateCompliancePack, UpdateCompliancePack.

Name Type Required Description
RuleName String Yes

rule name
RiskLevel Integer Yes

Risk level.
InputParameter Array of InputParameter Yes

Input parameters.
Identifier String No

Rule ID
Description String No

Description.
ManagedRuleIdentifier String No

Preset rule identifier
ConfigRuleId String No

Rule ID.
CompliancePackId String No

Compliance package ID.

CompliancePackRuleForManage

System compliance package rules on the operation side.

Used by actions: DescribeSystemCompliancePack, ListSystemCompliancePacks.

Name Type Description
Identifier String

Unique rule ID.
RuleName String

rule name
Description String

Description.
RiskLevel Integer

Risk level.

Valid values: 1 (high risk), 2 (medium risk), and 3 (low risk).
CreateTime String

Creation time.
UpdateTime String

Update time.
CompliancePackRules Array of CompliancePackRules

Compliance package rules.
Control Array of Control

Rule number information.
ResourceTypes Array of String

Resource type.

CompliancePackRules

Compliance package rule information.

Used by actions: DescribeSystemCompliancePack, ListSystemCompliancePacks.

Name Type Required Description
Identifier String Yes

Rule ID.
Control Array of Control No

Rule number information.
ResourceTypes Array of String No

Resource type.

ConfigCompliancePack

User compliance package information.

Used by actions: ListAggregateCompliancePacks, ListCompliancePacks.

Name Type Description
Status String

Compliance package status
CompliancePackId String

Compliance package ID.
Description String

Description.
CompliancePackName String

Compliance package name.
RiskLevel Integer

Risk level.
ComplianceResult String

Evaluation results.
CreateTime String

Creation time.
NoCompliantNames Array of String

Non-compliant rule name
RuleCount Integer

Number of compliance package rules

ConfigResource

Resource type information.

Used by actions: ListResourceTypes.

Name Type Description
Product String product
ProductName String Product name
ResourceType String Resource type.
ResourceTypeName String Resource type name

ConfigRule

Rule details

Used by actions: DescribeAggregateConfigRule, DescribeConfigRule, ListAggregateConfigRules, ListConfigRules.

Name Type Description
Identifier String Rule ID
RuleName String Rule Name
InputParameter Array of InputParameter Rule parameters
SourceCondition Array of SourceConditionForManage Rule trigger condition.
ResourceType Array of String Resource types supported by the rule. The rule applies only to resources of the specified resource types.
Labels Array of String Rule tags.
RiskLevel Integer Rule risk level.
1: Low risk
2: Medium-risk
3: High-risk
ServiceFunction String Function corresponding to the rule.
CreateTime String Creation time.
Format: YYYY-MM-DD h:i:s
Description String Rule description
Status String ACTIVE: enable
NO_ACTIVE: Disabled
ComplianceResult String Compliant: 'COMPLIANT'
Non-compliance: 'NON_COMPLIANT'
Unable to apply rule: 'NOT_APPLICABLE'
Annotation Annotation ["",""]
ConfigRuleInvokedTime String Rule evaluation time
Format: YYYY-MM-DD h:i:s
ConfigRuleId String Rule ID
IdentifierType String CUSTOMIZE: custom rule
SYSTEM: managed rule
CompliancePackId String Compliance package ID.
TriggerType Array of TriggerType Trigger Type
ScheduledNotification: periodic trigger.
ConfigurationItemChangeNotification: Triggered by a change
ManageInputParameter Array of InputParameterForManage Parameter details
CompliancePackName String Compliance package name
RegionsScope Array of String Associated regions.
TagsScope Array of Tag Associated tag
ExcludeResourceIdsScope Array of String The rule is invalid for the specified resource ID, meaning that evaluation will not be performed on this resource.
AccountGroupId String Account group ID.
AccountGroupName String Account group name.
RuleOwnerId Integer Rule owner user ID.
ManageTriggerType Array of String Trigger methods supported by preset rules.
ScheduledNotification: periodic trigger
ConfigurationItemChangeNotification: Triggered by a change

ConfigRuleResourceEvaluationResult

Configuration rule resource evaluation result.

Used by actions: ListAggregateConfigRuleResourceEvaluationResults, ListConfigRuleResourceEvaluationResults.

Name Type Description
RuleId String Rule ID
RuleName String Rule name
RuleIdentifier String Rule ID.
RuleDescription String Rule description
RuleOwnerId Integer Account to which the rule belongs.
RuleRiskLevel Integer Rule risk level.
ResourceId String Resource ID
ResourceType String Resource type.
ResourceName String Resource name
ResourceRegion String Resource region
ResourceTags Array of Tag Resource tag
Annotation Annotation Compliance details

Control

Rule number information.

Used by actions: DescribeSystemCompliancePack, ListSystemCompliancePacks.

Name Type Required Description
Id String No

Rule number.
Description String No

Number description.

Evaluation

Custom rule evaluation result.

Used by actions: PutEvaluations.

Name Type Required Description
ComplianceResourceId String Yes Evaluated resource ID, which is 0 to 256 characters in length.
ComplianceResourceType String Yes Evaluated resource type.
Support
QCS::CVM::Instance, QCS::CBS::Disk,QCS::VPC::Vpc,QCS::VPC::Subnet,QCS::VPC::SecurityGroup, QCS::CAM::User,QCS::CAM::Group,QCS::CAM::Policy,QCS::CAM::Role,QCS::COS::Bucket
ComplianceRegion String Yes Evaluated resource region.
0 to 32 characters in length.
ComplianceType String Yes Compliance type. Value:
COMPLIANT: compliant
NON_COMPLIANT: non-compliance
Annotation Annotation No Supplementary information of non-compliant resources.

EvaluationResult

Assessment result.

Used by actions: ListConfigRuleEvaluationResults.

Name Type Description
ResourceId String Resource ID
ResourceType String Resource type.
ResourceRegion String Resource region
ResourceName String Resource name
ConfigRuleId String Rule ID
ConfigRuleName String Rule name
CompliancePackId String Compliance package ID.
RiskLevel Integer Risk level
Annotation Annotation Assessment result.
ComplianceType String Compliance type.
InvokingEventMessageType String Rule initiation type.
ConfigRuleInvokedTime String Evaluation initiation time.
ResultRecordedTime String Actual evaluation time.

Filter

Resource list filtering.

Used by actions: ListAggregateDiscoveredResources, ListDiscoveredResources.

Name Type Required Description
Name String No Query field name. Valid values: resourceName (resource name), resourceId (resource ID), resourceType (resource type), resourceRegion (resource region), resourceDelete (deletion status; 0 indicates not deleted and 1 indicates deleted), and resourceRegionAndZone (region and availability zone).
Values Array of String No Queried field values.

InputParameter

Parameter value

Used by actions: AddAggregateCompliancePack, AddAggregateConfigRule, AddCompliancePack, AddConfigRule, DescribeAggregateCompliancePack, DescribeAggregateConfigRule, DescribeCompliancePack, DescribeConfigRule, ListAggregateConfigRules, ListConfigRules, UpdateAggregateCompliancePack, UpdateAggregateConfigRule, UpdateCompliancePack, UpdateConfigRule.

Name Type Required Description
ParameterKey String Yes Parameter name
Type String No Parameter type. Required type: Require, optional type: Optional.
Value String No Parameter value.

InputParameterForManage

Rule input parameters.

Used by actions: DescribeAggregateCompliancePack, DescribeAggregateConfigRule, DescribeCompliancePack, DescribeConfigRule, DescribeSystemRule, ListAggregateConfigRules, ListConfigRules, ListSystemRules.

Name Type Required Description
ValueType String No Value type. Valid values: Integer and String.
ParameterKey String No Parameter key.
Type String No Parameter type. Valid values: Require (required) and Optional (optional).
DefaultValue String No Default value
Description String No Description

Remediation

Remediation settings.

Used by actions: ListRemediations.

Name Type Required Description
RemediationTemplateId String No Remediation template ID.
RemediationId String No Remediation settings ID.
RemediationSourceType String No Template source for executing remediation.
RemediationType String No Correction type. Valid values:
SCF: Function Compute (custom remediation).
OwnerUin String No Account ID
InvokeType String No Correction execution mode. Parameter value:
MANUAL_EXECUTION: manual execution.
RuleId String No Rule ID.

RemediationExecutions

Correction records.

Used by actions: ListRemediationExecutions.

Name Type Description
ExecutionStatus Integer Remediation status. Valid values: 1 (running), 2 (successful), and 3 (failed).
ExecutionResourceType String Resource type.
ExecutionCreateDate String Fixing time
ExecutionStatusMessage String Error message
ExecutionResourceIds String Resource ID

ResourceListInfo

Resource list information

Used by actions: ListDiscoveredResources.

Name Type Description
ResourceType String Resource type.
ResourceName String Resource name
ResourceId String Resource ID
ResourceRegion String Region.
ResourceStatus String Resource status.
ResourceDelete Integer Valid values: 1 (deleted) and 2 (not deleted).
ResourceCreateTime String Resource creation time
Tags Array of Tag Tag information.
ResourceZone String AZ.
ComplianceResult String Compliance status

SourceConditionForManage

Rule conditions on the operation side.

Used by actions: DescribeAggregateCompliancePack, DescribeAggregateConfigRule, DescribeCompliancePack, DescribeConfigRule, DescribeSystemRule, ListAggregateConfigRules, ListConfigRules, ListSystemRules.

Name Type Required Description
EmptyAs String No Compliance status when the condition is empty. Valid values: COMPLIANT, NON_COMPLIANT, and NOT_APPLICABLE.
SelectPath String No Configuration path
Operator String No Operator.
Required Boolean No Whether it is mandatory.
DesiredValue String No Expected value

SystemCompliancePack

System compliance package information.

Used by actions: ListSystemCompliancePacks.

Name Type Description
CompliancePackId String Compliance package ID.
CompliancePackName String Name
Description String Description
RiskLevel Integer Compliance package risk level 1: high-risk.
2: Medium-risk.
3: Low risk.
ConfigRules Array of CompliancePackRuleForManage Compliance package rule information.

SystemConfigRule

Rule details on the operation side.

Used by actions: DescribeSystemRule, ListSystemRules.

Name Type Description
Identifier String

Rule ID.
RuleName String

Rule name.
InputParameter Array of InputParameterForManage

Rule parameters
SourceCondition Array of SourceConditionForManage

Rule trigger condition
ResourceType Array of String

Supported resource types.
Label Array of String

Tag.
RiskLevel Integer

Risk level, 1, 2, 3
ServiceFunction String

Corresponding function
CreateTime String

Creation time.
UpdateTime String

Update time.
TriggerType Array of String

Trigger type.
Description String

Description.
ReferenceCount Integer

Number of use
IdentifierType String

Rule type.

Tag

Tag

Used by actions: AddAggregateConfigRule, AddConfigRule, DescribeAggregateConfigRule, DescribeAggregateDiscoveredResource, DescribeConfigRule, DescribeDiscoveredResource, ListAggregateConfigRuleResourceEvaluationResults, ListAggregateConfigRules, ListAggregateDiscoveredResources, ListConfigRuleResourceEvaluationResults, ListConfigRules, ListDiscoveredResources, UpdateAggregateConfigRule, UpdateConfigRule.

Name Type Required Description
TagKey String No Tag key
TagValue String No Tag value

TriggerType

Rule supports trigger type

Used by actions: AddAggregateConfigRule, AddConfigRule, DescribeAggregateConfigRule, DescribeConfigRule, ListAggregateConfigRules, ListConfigRules, UpdateAggregateConfigRule, UpdateConfigRule.

Name Type Required Description
MessageType String Yes Trigger Type
MaximumExecutionFrequency String No Triggering time period.

UserConfigResource

Resource type.

Used by actions: DescribeConfigRecorder.

Name Type Description
Product String product
ProductName String Product name
ResourceType String Resource type.
ResourceTypeName String Resource type name
UpdateTime String Update time.
Previous Topic: CreateAggregatorNext Topic: Error Codes

Help and Support

Was this page helpful?

Help us improve! Rate your documentation experience in 5 mins.

Feedback

Search
    Enter keywords to search documentation