tencent cloud

配置审计

文档配置审计API 文档数据结构

数据结构

下载
聚焦模式
字号
最后更新时间： 2026-10-19 16:10:17

AggregateEvaluationResult

评估结果

被如下接口引用：ListAggregateConfigRuleEvaluationResults。

名称 类型 描述
ResourceId String 资源id
ResourceType String 资源类型
ResourceRegion String 资源地域
ResourceName String 资源名称
ConfigRuleId String 规则id
ConfigRuleName String 规则名称
CompliancePackId String 合规包id
RiskLevel Integer 风险等级
Annotation Annotation 评估结果
ComplianceType String 合规类型
InvokingEventMessageType String 规则发起类型
ConfigRuleInvokedTime String 评估发起时间
ResultRecordedTime String 评估实际时间
ResourceOwnerId Integer 资源所属用户ID
ResourceOwnerName String 资源所属用户名称

AggregateResourceInfo

资源列表信息

被如下接口引用：ListAggregateDiscoveredResources。

名称 类型 描述
ResourceType String 资源类型
ResourceName String 资源名称
ResourceId String 资源ID
ResourceRegion String 地域
ResourceStatus String 资源状态
ResourceDelete Integer 是否删除 1:已删除 0:未删除
ResourceCreateTime String 资源创建时间
Tags Array of Tag 标签信息
ResourceZone String 可用区
ComplianceResult String 合规状态
ResourceOwnerId Integer 资源所属用户ID
ResourceOwnerName String 用户昵称

Aggregator

用户组列表信息

被如下接口引用：ListAggregators。

名称 类型 描述
Name String 账号组名称
Description String 账号组描述
OwnerUin Integer 创建者用户ID
CreateTime String 创建时间
AccountCount Integer 账号组成员数量
Type String RD:全局账号组
AccountGroupId String 账号组ID
AggregatorStatus Integer 账号组状态
MemberName String 账号组名称

AggregatorAccount

成员信息

被如下接口引用：CreateAggregator, DescribeAggregator, UpdateAggregator。

名称 类型 必选 描述
MemberUin Integer 是 成员ID
MemberName String 是 成员名称

AlarmPolicyRsp

告警策略列表单个记录结构体

被如下接口引用：ListAlarmPolicy。

名称 类型 必选 描述
AlarmPolicyId Integer 否 告警策略唯一标识id
Name String 否 策略名称
Type Integer 否 事件类型
EventScope Array of Integer 否 1：当前账号 2：多账号
RiskLevel Array of Integer 否 1：高风险 2：中风险 3：低风险
NoticePeriod Array of Integer 否 通知周期，1-7数字分别代表周一至周日
NoticeTime String 否 通知时间段
NotificationMechanism String 否 通知机制
Status Integer 否 策略状态 1：启动 2：停止
Description String 否 策略描述

Annotation

合规详情

被如下接口引用：DescribeAggregateConfigRule, DescribeConfigRule, ListAggregateConfigRuleEvaluationResults, ListAggregateConfigRuleResourceEvaluationResults, ListAggregateConfigRules, ListConfigRuleEvaluationResults, ListConfigRuleResourceEvaluationResults, ListConfigRules, PutEvaluations。

名称 类型 必选 描述
Configuration String 是 资源当前实际配置。长度为0~256位字符，即资源不合规配置
DesiredValue String 是 资源期望配置。长度为0~256位字符，即资源合规配置
Operator String 否 资源当前配置和期望配置之间的比较运算符。长度为0~16位字符，自定义规则上报评估结果此字段可能为空
Property String 否 当前配置在资源属性结构体中的JSON路径。长度为0~256位字符，自定义规则上报评估结果此字段可能为空

ComplianceConfigRule

合规包规则信息

被如下接口引用：DescribeAggregateCompliancePack, DescribeCompliancePack。

名称 类型 描述
RuleName String 规则名称
RiskLevel Integer 风险等级
Status String 规则状态
ConfigRuleId String 规则ID
ComplianceResult String 评估结果
合规： 'COMPLIANT'
不合规： 'NON_COMPLIANT'
Labels Array of String 关键字
InputParameter Array of InputParameter 入参
SourceCondition Array of SourceConditionForManage 参数格式
Identifier String 规则标识
CreateByType String 创建方式 user、compliancePack、system
Description String 规则描述
ManageInputParameter Array of InputParameterForManage 参数描述

CompliancePackRule

合规包规则信息

被如下接口引用：AddAggregateCompliancePack, AddCompliancePack, UpdateAggregateCompliancePack, UpdateCompliancePack。

名称 类型 必选 描述
RuleName String 是

规则名称
RiskLevel Integer 是

风险等级
InputParameter Array of InputParameter 是

入参
Identifier String 否

规则身份标识
Description String 否

描述
ManagedRuleIdentifier String 否

预设规则身份标识
ConfigRuleId String 否

规则ID
CompliancePackId String 否

合规包ID

CompliancePackRuleForManage

管理端系统合规包规则

被如下接口引用：DescribeSystemCompliancePack, ListSystemCompliancePacks。

名称 类型 描述
Identifier String

规则唯一身份标识
RuleName String

规则名称
Description String

描述
RiskLevel Integer

风险等级

1：高风险 2：中风险 3：低风险
CreateTime String

创建时间
UpdateTime String

更新时间
CompliancePackRules Array of CompliancePackRules

合规包规则
Control Array of Control

规则编号信息
ResourceTypes Array of String

资源类型

CompliancePackRules

合规包规则信息

被如下接口引用：DescribeSystemCompliancePack, ListSystemCompliancePacks。

名称 类型 必选 描述
Identifier String 是

规则标识
Control Array of Control 否

规则编号信息
ResourceTypes Array of String 否

资源类型

ConfigCompliancePack

用户合规包信息

被如下接口引用：ListAggregateCompliancePacks, ListCompliancePacks。

名称 类型 描述
Status String

合规包状态
CompliancePackId String

合规包ID
Description String

描述
CompliancePackName String

合规包名称
RiskLevel Integer

风险等级
ComplianceResult String

评估结果
CreateTime String

创建时间
NoCompliantNames Array of String

不合规规则名
RuleCount Integer

合规包规则数

ConfigResource

资源类型信息

被如下接口引用：ListResourceTypes。

名称 类型 描述
Product String 产品
ProductName String 产品名
ResourceType String 资源类型
ResourceTypeName String 资源类型名

ConfigRule

规则详情

被如下接口引用：DescribeAggregateConfigRule, DescribeConfigRule, ListAggregateConfigRules, ListConfigRules。

名称 类型 描述
Identifier String 规则标识
RuleName String 规则名
InputParameter Array of InputParameter 规则参数
SourceCondition Array of SourceConditionForManage 规则触发条件
ResourceType Array of String 规则支持的资源类型，规则仅对指定资源类型的资源生效。
Labels Array of String 规则所属标签
RiskLevel Integer 规则风险等级
1:低风险
2:中风险
3:高风险
ServiceFunction String 规则对应的函数
CreateTime String 创建时间
格式：YYYY-MM-DD h:i:s
Description String 规则描述
Status String ACTIVE：启用
NO_ACTIVE：停止
ComplianceResult String 合规： 'COMPLIANT'
不合规： 'NON_COMPLIANT'
无法应用规则： 'NOT_APPLICABLE'
Annotation Annotation ["",""]
ConfigRuleInvokedTime String 规则评估时间
格式：YYYY-MM-DD h:i:s
ConfigRuleId String 规则ID
IdentifierType String CUSTOMIZE：自定义规则、
SYSTEM：托管规则
CompliancePackId String 合规包ID
TriggerType Array of TriggerType 触发类型
ScheduledNotification：周期触发、
ConfigurationItemChangeNotification：变更触发
ManageInputParameter Array of InputParameterForManage 参数详情
CompliancePackName String 合规包名称
RegionsScope Array of String 关联地域
TagsScope Array of Tag 关联标签
ExcludeResourceIdsScope Array of String 规则对指定资源ID无效，即不对该资源执行评估。
AccountGroupId String 账号组ID
AccountGroupName String 账号组名称
RuleOwnerId Integer 规则所属用户ID
ManageTriggerType Array of String 预设规则支持的触发方式
ScheduledNotification：周期触发
ConfigurationItemChangeNotification：变更触发

ConfigRuleResourceEvaluationResult

配置规则资源评估结果

被如下接口引用：ListAggregateConfigRuleResourceEvaluationResults, ListConfigRuleResourceEvaluationResults。

名称 类型 描述
RuleId String 规则ID
RuleName String 规则名称
RuleIdentifier String 规则身份标识
RuleDescription String 规则描述
RuleOwnerId Integer 规则归属账号
RuleRiskLevel Integer 规则风险等级
ResourceId String 资源ID
ResourceType String 资源类型
ResourceName String 资源名称
ResourceRegion String 资源地域
ResourceTags Array of Tag 资源标签
Annotation Annotation 合规详情

Control

规则编号信息

被如下接口引用：DescribeSystemCompliancePack, ListSystemCompliancePacks。

名称 类型 必选 描述
Id String 否

规则编号
Description String 否

编号描述

Evaluation

自定义规则评估结果

被如下接口引用：PutEvaluations。

名称 类型 必选 描述
ComplianceResourceId String 是 已评估资源ID。长度为0~256个字符
ComplianceResourceType String 是 已评估资源类型。
支持:
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 是 已评估资源地域。
长度为0~32个字符
ComplianceType String 是 合规类型。取值：
COMPLIANT：合规、
NON_COMPLIANT：不合规
Annotation Annotation 否 不合规资源的补充信息。

EvaluationResult

评估结果

被如下接口引用：ListConfigRuleEvaluationResults。

名称 类型 描述
ResourceId String 资源id
ResourceType String 资源类型
ResourceRegion String 资源地域
ResourceName String 资源名称
ConfigRuleId String 规则id
ConfigRuleName String 规则名称
CompliancePackId String 合规包id
RiskLevel Integer 风险等级
Annotation Annotation 评估结果
ComplianceType String 合规类型
InvokingEventMessageType String 规则发起类型
ConfigRuleInvokedTime String 评估发起时间
ResultRecordedTime String 评估实际时间

Filter

资源列表筛选

被如下接口引用：ListAggregateDiscoveredResources, ListDiscoveredResources。

名称 类型 必选 描述
Name String 否 查询字段名称 资源名称：resourceName 资源ID：resourceId 资源类型：resourceType 资源地域：resourceRegion 删除状态：resourceDelete 0未删除，1已删除 resourceRegionAndZone地域/可用区
Values Array of String 否 查询字段值

InputParameter

参数值

被如下接口引用：AddAggregateCompliancePack, AddAggregateConfigRule, AddCompliancePack, AddConfigRule, DescribeAggregateCompliancePack, DescribeAggregateConfigRule, DescribeCompliancePack, DescribeConfigRule, ListAggregateConfigRules, ListConfigRules, UpdateAggregateCompliancePack, UpdateAggregateConfigRule, UpdateCompliancePack, UpdateConfigRule。

名称 类型 必选 描述
ParameterKey String 是 参数名
Type String 否 参数类型。必填类型：Require，可选类型：Optional。
Value String 否 参数值

InputParameterForManage

规则入参

被如下接口引用：DescribeAggregateCompliancePack, DescribeAggregateConfigRule, DescribeCompliancePack, DescribeConfigRule, DescribeSystemRule, ListAggregateConfigRules, ListConfigRules, ListSystemRules。

名称 类型 必选 描述
ValueType String 否 值类型。数值：Integer， 字符串：String
ParameterKey String 否 参数Key
Type String 否 参数类型。必填类型：Require，可选类型：Optional。
DefaultValue String 否 默认值
Description String 否 描述

Remediation

修复设置

被如下接口引用：ListRemediations。

名称 类型 必选 描述
RemediationTemplateId String 否 修正模板 ID。
RemediationId String 否 修正设置 ID。
RemediationSourceType String 否 执行修正的模板来源
RemediationType String 否 修正类型。取值：
SCF：函数计算（自定义修正）。
OwnerUin String 否 账号ID
InvokeType String 否 修正执行方式。取值：
MANUAL_EXECUTION：手动执行。
RuleId String 否 规则 ID。

RemediationExecutions

修正记录

被如下接口引用：ListRemediationExecutions。

名称 类型 描述
ExecutionStatus Integer 修正状态 1：运行中 2：成功 3：失败
ExecutionResourceType String 资源类型
ExecutionCreateDate String 修复时间
ExecutionStatusMessage String 错误信息
ExecutionResourceIds String 资源ID

ResourceListInfo

资源列表信息

被如下接口引用：ListDiscoveredResources。

名称 类型 描述
ResourceType String 资源类型
ResourceName String 资源名称
ResourceId String 资源ID
ResourceRegion String 地域
ResourceStatus String 资源状态
ResourceDelete Integer 1 :已删除 2：未删除
ResourceCreateTime String 资源创建时间
Tags Array of Tag 标签信息
ResourceZone String 可用区
ComplianceResult String 合规状态

SourceConditionForManage

管理端规则条件

被如下接口引用：DescribeAggregateCompliancePack, DescribeAggregateConfigRule, DescribeCompliancePack, DescribeConfigRule, DescribeSystemRule, ListAggregateConfigRules, ListConfigRules, ListSystemRules。

名称 类型 必选 描述
EmptyAs String 否 条件为空，合规：COMPLIANT，不合规：NON_COMPLIANT，无法应用：NOT_APPLICABLE
SelectPath String 否 配置路径
Operator String 否 操作运算符
Required Boolean 否 是否必须
DesiredValue String 否 期望值

SystemCompliancePack

系统合规包信息

被如下接口引用：ListSystemCompliancePacks。

名称 类型 描述
CompliancePackId String 合规包ID
CompliancePackName String 名称
Description String 描述
RiskLevel Integer 合规包风险等级1：高风险。
2：中风险。
3：低风险。
ConfigRules Array of CompliancePackRuleForManage 合规包规则信息

SystemConfigRule

管理端规则详情

被如下接口引用：DescribeSystemRule, ListSystemRules。

名称 类型 描述
Identifier String

规则标识
RuleName String

规则名
InputParameter Array of InputParameterForManage

规则参数
SourceCondition Array of SourceConditionForManage

规则触发条件
ResourceType Array of String

支持的资源类型
Label Array of String

标签
RiskLevel Integer

风险等级，1，2，3
ServiceFunction String

对应的函数
CreateTime String

创建时间
UpdateTime String

更新时间
TriggerType Array of String

触发类型
Description String

描述
ReferenceCount Integer

使用次数
IdentifierType String

规则类型

Tag

标签

被如下接口引用：AddAggregateConfigRule, AddConfigRule, DescribeAggregateConfigRule, DescribeAggregateDiscoveredResource, DescribeConfigRule, DescribeDiscoveredResource, ListAggregateConfigRuleResourceEvaluationResults, ListAggregateConfigRules, ListAggregateDiscoveredResources, ListConfigRuleResourceEvaluationResults, ListConfigRules, ListDiscoveredResources, UpdateAggregateConfigRule, UpdateConfigRule。

名称 类型 必选 描述
TagKey String 否 标签key
TagValue String 否 标签value

TriggerType

规则支持触发类型

被如下接口引用：AddAggregateConfigRule, AddConfigRule, DescribeAggregateConfigRule, DescribeConfigRule, ListAggregateConfigRules, ListConfigRules, UpdateAggregateConfigRule, UpdateConfigRule。

名称 类型 必选 描述
MessageType String 是 触发类型
MaximumExecutionFrequency String 否 触发时间周期

UserConfigResource

资源类型

被如下接口引用：DescribeConfigRecorder。

名称 类型 描述
Product String 产品
ProductName String 产品名
ResourceType String 资源类型
ResourceTypeName String 资源类型名
UpdateTime String 更新时间
上一篇: 新建账号组下一篇: 错误码

帮助和支持

本页内容是否解决了您的问题？

填写满意度调查问卷，共创更好文档体验。

文档反馈

搜索
    请输入关键词搜索文档