数据结构

最近更新时间:2026-03-25 01:31:07

我的收藏

AggregateEvaluationResult

评估结果

被如下接口引用:ListAggregateConfigRuleEvaluationResults。

名称 类型 描述
ResourceId String 资源id
示例值:vpc-1222
ResourceType String 资源类型
示例值:QCS::VPC::Subnet
ResourceRegion String 资源地域
示例值:ap-gaungzhou
ResourceName String 资源名称
示例值:私有网络1
ConfigRuleId String 规则id
示例值:cr-13vkg****ixgabkepxe
ConfigRuleName String 规则名称
示例值:CAM访问管理子用户必须关联用户组
CompliancePackId String 合规包id
注意:此字段可能返回 null,表示取不到有效值。
示例值:cp-xzfz0*07feuhwi8auv
RiskLevel Integer 风险等级
示例值:1
Annotation Annotation 评估结果
注意:此字段可能返回 null,表示取不到有效值。
ComplianceType String 合规类型
注意:此字段可能返回 null,表示取不到有效值。
示例值:COMPLIANT
InvokingEventMessageType String 规则发起类型
示例值:Manul
ConfigRuleInvokedTime String 评估发起时间
示例值:2022-10-10 12:56:37
ResultRecordedTime String 评估实际时间
示例值:2022-10-10 12:56:37
ResourceOwnerId Integer 资源所属用户ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:324****234234
ResourceOwnerName String 资源所属用户名称
注意:此字段可能返回 null,表示取不到有效值。

AggregateResourceInfo

资源列列表信息

被如下接口引用:ListAggregateDiscoveredResources。

名称 类型 描述
ResourceType String 资源类型
示例值:cvm
ResourceName String 资源名称
示例值:云服务器
ResourceId String 资源ID
示例值:ins-4ynwt8x5
ResourceRegion String 地域
示例值:ap-hangzhou
ResourceStatus String 资源状态
示例值:Running
ResourceDelete Integer 是否删除 1:已删除 0:未删除
示例值:1
ResourceCreateTime String 资源创建时间
示例值:2022-10-10 12:56:37
Tags Array of Tag 标签信息
ResourceZone String 可用区
示例值:ap-hangzhou-3
ComplianceResult String 合规状态
示例值:COMPLIANT
ResourceOwnerId Integer 资源所属用户ID
示例值:23423****4234
ResourceOwnerName String 用户昵称
示例值:张*

Aggregator

用户组列表信息

被如下接口引用:ListAggregators。

名称 类型 描述
Name String 账号组名称
示例值:账号组1
Description String 账号组描述
示例值:账号组描述
OwnerUin Integer 创建者用户ID
示例值:6958****3922
CreateTime String 创建时间
示例值:2022-10-09 09:04:37
AccountCount Integer 账号组成员数量
示例值:4
Type String RD:全局账号组
示例值:账号组类型
AccountGroupId String 账号组ID
示例值:ca-acco****
AggregatorStatus Integer 账号组状态
示例值:1
MemberName String 账号组名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:计费组

AggregatorAccount

成员信息

被如下接口引用:CreateAggregator, DescribeAggregator。

名称 类型 必选 描述
MemberUin Integer 成员ID
示例值:345****4234
MemberName String 成员名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:张*

Annotation

合规详情

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

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

ComplianceConfigRule

合规包规则信息

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

名称 类型 描述
RuleName String 规则名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:规则1
RiskLevel Integer 风险等级
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
Status String 规则状态
注意:此字段可能返回 null,表示取不到有效值。
示例值:ACTIVE
ConfigRuleId String 规则ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:cr-a234
ComplianceResult String 评估结果
合规: 'COMPLIANT'
不合规: 'NON_COMPLIANT'
注意:此字段可能返回 null,表示取不到有效值。
示例值:COMPLIANT
Labels Array of String 关键字
注意:此字段可能返回 null,表示取不到有效值。
示例值:lab
InputParameter Array of InputParameter 入参
注意:此字段可能返回 null,表示取不到有效值。
SourceCondition Array of SourceConditionForManage 参数格式
注意:此字段可能返回 null,表示取不到有效值。
Identifier String 规则标识
注意:此字段可能返回 null,表示取不到有效值。
CreateByType String 创建方式 user、compliancePack、system
注意:此字段可能返回 null,表示取不到有效值。
Description String 规则描述
注意:此字段可能返回 null,表示取不到有效值。
ManageInputParameter Array of InputParameterForManage 参数描述
注意:此字段可能返回 null,表示取不到有效值。

CompliancePackRule

合规包规则信息

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

名称 类型 必选 描述
RuleName String 规则名称
示例值:CAM访问管理子用户必须关联用户组
RiskLevel Integer 风险等级
示例值:1
InputParameter Array of InputParameter 入参
Identifier String 规则身份标识
示例值:cam-user-group-bound
Description String 描述
注意:此字段可能返回 null,表示取不到有效值。
示例值:帐号访问管理中用户至少关联一个用户组,则符合规则。
ManagedRuleIdentifier String 预设规则身份标识
注意:此字段可能返回 null,表示取不到有效值。
示例值:cam-user-group-bound
ConfigRuleId String 规则ID
示例值:cr-13vkg9c31dixgabkepxe
CompliancePackId String 合规包ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:cp-xzfz0vu007feuhwi8auv

CompliancePackRuleForManage

管理端系统合规包规则

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

名称 类型 描述
Identifier String

规则唯一身份标识


注意:此字段可能返回 null,表示取不到有效值。
示例值:cbs-disk-encrypted
RuleName String

规则名称


注意:此字段可能返回 null,表示取不到有效值。
示例值:CAM访问管理不存在闲置的权限策略
Description String

描述


注意:此字段可能返回 null,表示取不到有效值。
示例值:CBS自动快照策略设置快照保留天数大于设置的天数,视为“合规”。默认值:7天。
RiskLevel Integer

风险等级

1:高风险 2:中风险 3:低风险


注意:此字段可能返回 null,表示取不到有效值。
示例值:1
CreateTime String

创建时间


注意:此字段可能返回 null,表示取不到有效值。
示例值:2022-09-01 12:00:00
UpdateTime String

更新时间


注意:此字段可能返回 null,表示取不到有效值。
示例值:2022-09-01 12:00:00
CompliancePackRules Array of CompliancePackRules

合规包规则

Control Array of Control

规则编号信息

ResourceTypes Array of String

资源类型


示例值:["QCS::SCF::Namespace"]

CompliancePackRules

合规包规则信息

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

名称 类型 必选 描述
Identifier String

规则标识


示例值:cbs-snapshot-retention-days
Control Array of Control

规则编号信息

ResourceTypes Array of String

资源类型


示例值:["QCS::CBS::Disk"]

ConfigCompliancePack

用户合规包信息

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

名称 类型 描述
Status String 合规包状态
示例值:ACTIVE
CompliancePackId String 合规包ID
示例值:cp-fc507gbwtks141giu8p2
Description String 描述
注意:此字段可能返回 null,表示取不到有效值。
示例值:帐号访问管理中用户至少关联一个用户组,则符合规则。
CompliancePackName String 合规包名称
示例值:安全合规包
RiskLevel Integer 风险等级
示例值:1
ComplianceResult String 评估结果
注意:此字段可能返回 null,表示取不到有效值。
示例值:NON_COMPLIANT
CreateTime String 创建时间
示例值:2022-11-16 14:11:48
NoCompliantNames Array of String 不合规规则名
注意:此字段可能返回 null,表示取不到有效值。
示例值:""
RuleCount Integer 合规包规则数
注意:此字段可能返回 null,表示取不到有效值。
示例值:2

ConfigResource

资源类型信息

被如下接口引用:ListResourceTypes。

名称 类型 描述
Product String 产品
注意:此字段可能返回 null,表示取不到有效值。
示例值:CAM
ProductName String 产品名
注意:此字段可能返回 null,表示取不到有效值。
示例值:访问管理
ResourceType String 资源类型
注意:此字段可能返回 null,表示取不到有效值。
示例值:QCS::CAM::Group
ResourceTypeName String 资源类型名
注意:此字段可能返回 null,表示取不到有效值。
示例值:访问管理-用户组

ConfigRule

规则详情

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

名称 类型 描述
Identifier String 规则标识
示例值:cam-user-invalid-ak-check
RuleName String 规则名
示例值:配置规则1
InputParameter Array of InputParameter 规则参数
SourceCondition Array of SourceConditionForManage 规则触发条件
ResourceType Array of String 规则支持的资源类型,规则仅对指定资源类型的资源生效。
示例值: [ "QCS::CAM::User" ]
Labels Array of String 规则所属标签
示例值:[ "用户", "密钥" ]
RiskLevel Integer 规则风险等级
1:低风险
2:中风险
3:高风险
示例值:1
ServiceFunction String 规则对应的函数
示例值:scf1
CreateTime String 创建时间
格式:YYYY-MM-DD h:i:s
示例值:2022-09-01 12:00:00
Description String 规则描述
示例值:Redis实例内存总量大于等于指定的参数值,视为“合规”。默认值:1000MB
Status String ACTIVE:启用
NO_ACTIVE:停止
示例值:规则状态
ComplianceResult String 合规: 'COMPLIANT'
不合规: 'NON_COMPLIANT'
无法应用规则: 'NOT_APPLICABLE'
示例值:合规状态
Annotation Annotation ["",""]
示例值:合规详情
ConfigRuleInvokedTime String 规则评估时间
格式:YYYY-MM-DD h:i:s

示例值:2022-09-01 12:00:00
ConfigRuleId String 规则ID
示例值:cr-24234234werw234
IdentifierType String CUSTOMIZE:自定义规则、
SYSTEM:托管规则
示例值:规则类型
CompliancePackId String 合规包ID
示例值:cp-342424dfsdfdf
TriggerType Array of TriggerType 触发类型
ScheduledNotification:周期触发、
ConfigurationItemChangeNotification:变更触发
示例值:[ { "MaximumExecutionFrequency": null, "MessageType": "ConfigurationItemChangeNotification" } ]
ManageInputParameter Array of InputParameterForManage 参数详情
CompliancePackName String 合规包名称
示例值:合规包1
RegionsScope Array of String 关联地域
示例值: ["ap-guangzhou"]
TagsScope Array of Tag 关联标签
ExcludeResourceIdsScope Array of String 规则对指定资源ID无效,即不对该资源执行评估。
示例值:["23424"]
AccountGroupId String 账号组ID
示例值:ca-34sdf345345
AccountGroupName String 账号组名称
示例值:账号组1
RuleOwnerId Integer 规则所属用户ID
示例值:3444***4455
ManageTriggerType Array of String 预设规则支持的触发方式
ScheduledNotification:周期触发
ConfigurationItemChangeNotification:变更触发
示例值:["ScheduledNotification"]

Control

规则编号信息

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

名称 类型 必选 描述
Id String

规则编号


示例值:3546
Description String

编号描述


示例值:567567

Evaluation

自定义规则评估结果

被如下接口引用:PutEvaluations。

名称 类型 必选 描述
ComplianceResourceId String 已评估资源ID。长度为0~256个字符
示例值:disk-26itbqha
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
示例值:QCS::CBS::Disk
ComplianceRegion String 已评估资源地域。
长度为0~32个字符
示例值:ap-guangzhou
ComplianceType String 合规类型。取值:
COMPLIANT:合规、
NON_COMPLIANT:不合规
示例值:NON_COMPLIANT
Annotation Annotation 不合规资源的补充信息。

EvaluationResult

评估结果

被如下接口引用:ListConfigRuleEvaluationResults。

名称 类型 描述
ResourceId String 资源id
注意:此字段可能返回 null,表示取不到有效值。
示例值:vpc-1222
ResourceType String 资源类型
注意:此字段可能返回 null,表示取不到有效值。
示例值:QCS::VPC::Subnet
ResourceRegion String 资源地域
注意:此字段可能返回 null,表示取不到有效值。
示例值:ap-gaungzhou
ResourceName String 资源名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:私有网络1
ConfigRuleId String 规则id
注意:此字段可能返回 null,表示取不到有效值。
示例值:cr-13vkg9c31dixgabkepxe
ConfigRuleName String 规则名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:CAM访问管理子用户必须关联用户组
CompliancePackId String 合规包id
注意:此字段可能返回 null,表示取不到有效值。
示例值:cp-xzfz0vu007feuhwi8auv
RiskLevel Integer 风险等级
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
Annotation Annotation 评估结果
注意:此字段可能返回 null,表示取不到有效值。
ComplianceType String 合规类型
注意:此字段可能返回 null,表示取不到有效值。
示例值:COMPLIANT
InvokingEventMessageType String 规则发起类型
注意:此字段可能返回 null,表示取不到有效值。
示例值:Manul
ConfigRuleInvokedTime String 评估发起时间
注意:此字段可能返回 null,表示取不到有效值。
示例值:2022-10-10 12:56:37
ResultRecordedTime String 评估实际时间
注意:此字段可能返回 null,表示取不到有效值。
示例值:2022-10-10 12:56:37

Filter

资源列表筛选

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

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

InputParameter

参数值

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

名称 类型 必选 描述
ParameterKey String 参数名
示例值:days
Type String 参数类型。必填类型:Require,可选类型:Optional。
示例值:Require
Value String 参数值
示例值:1

InputParameterForManage

规则入参

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

名称 类型 必选 描述
ValueType String 值类型。数值:Integer, 字符串:String
示例值:1
ParameterKey String 参数Key
示例值:1
Type String 参数类型。必填类型:Require,可选类型:Optional。
示例值:1
DefaultValue String 默认值
示例值:1
Description String 描述
示例值:1

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 资源类型
示例值:cvm
ResourceName String 资源名称
示例值:云服务器
ResourceId String 资源ID
示例值:ins-4ynwt8x5
ResourceRegion String 地域
示例值:ap-hangzhou
ResourceStatus String 资源状态
示例值:Running
ResourceDelete Integer 1 :已删除 2:未删除
示例值:2
ResourceCreateTime String 资源创建时间
示例值:2022-10-10 12:56:37
Tags Array of Tag 标签信息
ResourceZone String 可用区
示例值:ap-hangzhou-3
ComplianceResult String 合规状态
示例值:COMPLIANT

SourceConditionForManage

管理端规则条件

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

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

SystemCompliancePack

系统合规包信息

被如下接口引用:ListSystemCompliancePacks。

名称 类型 描述
CompliancePackId String 合规包ID
示例值:cp-fc507gbwtks141giu8p2
CompliancePackName String 名称
示例值:网络实践
Description String 描述
注意:此字段可能返回 null,表示取不到有效值。
示例值:安全合规包描述
RiskLevel Integer 合规包风险等级1:高风险。
2:中风险。
3:低风险。
示例值:1
ConfigRules Array of CompliancePackRuleForManage 合规包规则信息
注意:此字段可能返回 null,表示取不到有效值。

SystemConfigRule

管理端规则详情

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

名称 类型 描述
Identifier String 规则标识
注意:此字段可能返回 null,表示取不到有效值。
示例值:cam-user-group-bound
RuleName String 规则名
注意:此字段可能返回 null,表示取不到有效值。
示例值:CAM访问管理子用户必须关联用户组
InputParameter Array of InputParameterForManage 规则参数
注意:此字段可能返回 null,表示取不到有效值。
SourceCondition Array of SourceConditionForManage 规则触发条件
注意:此字段可能返回 null,表示取不到有效值。
ResourceType Array of String 支持的资源类型
注意:此字段可能返回 null,表示取不到有效值。
示例值:[ "QCS::CAM::User" ]
Label Array of String 标签
注意:此字段可能返回 null,表示取不到有效值。
示例值:[ "用户", "用户组" ]
RiskLevel Integer 风险等级,1,2,3
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
ServiceFunction String 对应的函数
注意:此字段可能返回 null,表示取不到有效值。
示例值:""
CreateTime String 创建时间
注意:此字段可能返回 null,表示取不到有效值。
示例值:2022-09-01 12:00:00
UpdateTime String 更新时间
注意:此字段可能返回 null,表示取不到有效值。
示例值:2022-09-01 12:00:00
TriggerType Array of String 触发类型
注意:此字段可能返回 null,表示取不到有效值。
示例值:[ "ScheduledNotification" ]
Description String 描述
注意:此字段可能返回 null,表示取不到有效值。
示例值:帐号访问管理中用户至少关联一个用户组,则符合规则。
ReferenceCount Integer 使用次数
注意:此字段可能返回 null,表示取不到有效值。
示例值:2
IdentifierType String 规则类型
示例值:SYSTEM

Tag

标签

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

名称 类型 必选 描述
TagKey String 标签key
示例值:产品部
TagValue String 标签value
示例值:运营部成员

TriggerType

规则支持触发类型

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

名称 类型 必选 描述
MessageType String 触发类型
示例值:ScheduledNotification、ConfigurationItemChangeNotification
MaximumExecutionFrequency String 触发时间周期
示例值:TwentyFour_Hours

UserConfigResource

资源类型

被如下接口引用:DescribeConfigRecorder。

名称 类型 描述
Product String 产品
注意:此字段可能返回 null,表示取不到有效值。
示例值:CAM
ProductName String 产品名
注意:此字段可能返回 null,表示取不到有效值。
示例值:云服务器
ResourceType String 资源类型
注意:此字段可能返回 null,表示取不到有效值。
示例值:QCS::CAM::Group
ResourceTypeName String 资源类型名
注意:此字段可能返回 null,表示取不到有效值。
示例值:云服务器-实例
UpdateTime String 更新时间
注意:此字段可能返回 null,表示取不到有效值。
示例值:2022-10-10 12:56:37