数据结构

最近更新时间:2025-01-10 01:11:52

我的收藏

AggregateResourceInfo

资源列列表信息

被如下接口引用:ListAggregateDiscoveredResources。

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

Annotation

合规详情

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

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

ConfigRule

规则详情

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

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

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

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

Filter

资源列表筛选

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

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

InputParameter

参数值

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

名称 类型 必选 描述
ParameterKey String 参数名
示例值:days
Type String 参数类型。必填类型:Require,可选类型:Optional。
示例值:Require
Value String 参数值
注意:此字段可能返回 null,表示取不到有效值。
示例值:1

InputParameterForManage

规则入参

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

名称 类型 必选 描述
ValueType String 值类型。数值:Integer, 字符串:String
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
ParameterKey String 参数Key
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
Type String 参数类型。必填类型:Require,可选类型:Optional。
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
DefaultValue String 默认值
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
Description String 描述
注意:此字段可能返回 null,表示取不到有效值。
示例值:1

ResourceListInfo

资源列列表信息

被如下接口引用:ListDiscoveredResources。

名称 类型 描述
ResourceType String 资源类型
示例值:cvm
ResourceName String 资源名称
示例值:云服务器
ResourceId String 资源ID
示例值:ins-4ynwt8x5
ResourceRegion String 地域
注意:此字段可能返回 null,表示取不到有效值。
示例值:ap-hangzhou
ResourceStatus String 资源状态
注意:此字段可能返回 null,表示取不到有效值。
示例值:Running
ResourceDelete Integer 1 :已删除 2:未删除
注意:此字段可能返回 null,表示取不到有效值。
示例值:2
ResourceCreateTime String 资源创建时间
注意:此字段可能返回 null,表示取不到有效值。
示例值:2022-10-10 12:56:37
Tags Array of Tag 标签信息
注意:此字段可能返回 null,表示取不到有效值。
示例值:x
ResourceZone String 可用区
注意:此字段可能返回 null,表示取不到有效值。
示例值:ap-hangzhou-3
ComplianceResult String 合规状态
注意:此字段可能返回 null,表示取不到有效值。
示例值:COMPLIANT

SourceConditionForManage

管理端规则条件

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

名称 类型 必选 描述
EmptyAs String 条件为空,合规:COMPLIANT,不合规:NON_COMPLIANT,无法应用:NOT_APPLICABLE
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
SelectPath String 配置路径
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
Operator String 操作运算符
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
Required Boolean 是否必须
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
DesiredValue String 期望值
注意:此字段可能返回 null,表示取不到有效值。
示例值:1

Tag

标签

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

名称 类型 必选 描述
TagKey String 标签key
注意:此字段可能返回 null,表示取不到有效值。
示例值:产品部
TagValue String 标签value
注意:此字段可能返回 null,表示取不到有效值。
示例值:运营部成员

TriggerType

规则支持触发类型

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

名称 类型 必选 描述
MessageType String 触发类型
示例值:ScheduledNotification、ConfigurationItemChangeNotification
MaximumExecutionFrequency String 触发时间周期
注意:此字段可能返回 null,表示取不到有效值。
示例值:TwentyFour_Hours