tencent cloud

APIs

文档APIsConfigData Types

数据结构

聚焦模式
字号
最后更新时间： 2026-04-16 17:05:37

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 用户昵称

Annotation

合规详情

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

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

ConfigRule

规则详情

被如下接口引用：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：变更触发

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 否 不合规资源的补充信息。

Filter

资源列表筛选

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

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

InputParameter

参数值

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

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

InputParameterForManage

规则入参

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

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

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

管理端规则条件

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

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

Tag

标签

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

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

TriggerType

规则支持触发类型

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

名称 类型 必选 描述
MessageType String 是 触发类型
MaximumExecutionFrequency String 否 触发时间周期
上一篇: ListAggregateDiscoveredResources下一篇: Error Codes

帮助和支持

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

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

文档反馈