租户端云资源管理云顾问（CloudAdvisor）数据结构

数据结构

最近更新时间: 2025-03-12 16:34:37

Groups

Groups类型

被如下接口引用：DescribeProductConfigList

名称	必选	允许NULL	类型	描述
Id	是	否	Uint64	类型Id 示例值： 1
GroupName	是	否	String	类型名称示例值：安全

Progress

进度

被如下接口引用：DescribeTaskProgress

名称	必选	允许NULL	类型	描述
ScannedCount	是	否	Int64	已扫描实例数量。示例值： 10
TotalCount	是	否	Int64	总实例数量示例值： 20

RiskFieldsDescDetail

风险实例字段配置

被如下接口引用：DescribeRiskDisplay

名称	必选	允许NULL	类型	描述
StrategyId	是	是	Uint64	巡检项ID 示例值： 1
Url	是	是	String	巡检项实例对应的URL 示例值： http://xxx
RiskFieldsDesc	是	是	Array of RiskFieldsDesc	巡检项对应配置示例值：查看
LinkId	是	是	String	链接渲染字段ID 示例值： insId
PriId	是	是	String	设置忽略字段ID 示例值： insId

TplSets

template sets

被如下接口引用：DescribeSubscriptionTemplates

名称	必选	允许NULL	类型	描述
GroupIds	是	是	Array of Uint64	group ids 示例值： 1
Id	是	是	Uint64	template id 示例值： 1
Products	是	是	Array of String	template products 示例值： cvm
Name	是	是	String	template name 示例值： tpl
Tags	是	是	Array of Tags	template tag 示例值：查看

ProductProgress

产品扫描进度

被如下接口引用：DescribeTaskProgress

名称	必选	允许NULL	类型	描述
Name	是	否	String	产品名称。示例值： cvm
Progress	是	否	Progress	产品扫描进度。示例值：查看

DescribeStrategiesCondition

评估项警告条件

被如下接口引用：DescribeStrategies

名称	必选	允许NULL	类型	描述
ConditionId	是	是	Uint64	警告条件ID 示例值： 1
Level	是	是	Uint64	警告级别，2:中风险，3:高风险示例值： 3
LevelDesc	是	是	String	警告级别描述示例值：高风险
Desc	是	否	String	警告条件描述示例值： MySQL 实例只设置了 root 账号

Instance

扫描的实例的基础信息

被如下接口引用：DescribeTaskResult、DescribeTaskStrategyIgnoredDetail、DescribeTaskStrategyUnsafeDetail

名称	必选	允许NULL	类型	描述
Id	是	否	String	实例的ID,例如:ins-e4frg13 示例值： ins_id
Region	是	是	String	实例的地区,例如:ap-guangzhou 示例值： ap-guangzhou
Extra	是	是	String	实例的附属信息,例如:cvm的名字示例值： insName

RiskFieldsDesc

风险实例字段描述

被如下接口引用：DescribeRiskDisplay、DescribeTaskStrategyIgnores、DescribeTaskStrategyRisks

名称	必选	允许NULL	类型	描述
Field	是	否	String	字段ID 示例值： InstanceState
FieldName	是	否	String	字段名称示例值：状态
FieldType	是	否	String	字段类型, string: 字符串类型，例如"aa" int: 整形，例如 111 stringSlice : 字符串数组类型，例如["a", "b"] tags: 标签类型, 例如: [{"Key":"kkk","Value":"vvv"},{"Key":"kkk2","Value":"vvv2"}] 示例值： string
FieldDict	是	是	Array of KeyValue	字段值对应字典示例值：查看

UnsafeDetail

有风险实例详情

被如下接口引用：DescribeTaskStrategyUnsafeDetail

名称	必选	允许NULL	类型	描述
ConditionId	是	否	Int64	该实例命中的条件ID。示例值： 1
IgnoredStatus	是	否	Bool	实例的忽略状态，true表示被忽略。示例值： true
Instance	是	否	Instance	实例信息。示例值：查看

名称	必选	允许NULL	类型	描述
TagKey	是	是	String	Tag对应的key 示例值： ["key"]
TagValues	是	是	Array of String	tag对应的values 示例值： ["val"]

IgnoredDetail

忽略实例详情

被如下接口引用：DescribeTaskStrategyIgnoredDetail

名称	必选	允许NULL	类型	描述
IgnoredStatus	是	否	Bool	实例的忽略状态，true表示被忽略。示例值： false
Instance	是	否	Instance	实例信息。示例值：查看

ConfigGroup

策略组成的大组的信息

被如下接口引用：DescribeConfig

名称	必选	允许NULL	类型	描述
GroupId	是	否	Int64	策略组的ID 示例值： 1
Name	是	否	String	策略组的名字,例如:安全示例值：安全
Strategies	是	否	Array of ConfigStrategy	策略组包含的策略组列表示例值：查看

IgnoreInstance

忽略扫描的实例的信息

被如下接口引用：ListIgnoreInstances、ModifyIgnoreInstance、ModifyIgnoreInstances

名称	必选	允许NULL	类型	描述
Id	是	否	String	实例的ID 示例值： ins_id
Region	否	否	String	实例的地区示例值： ap-guangzhou

SubscriptionInfo

订阅信息

被如下接口引用：DescribeSubscriptions、UpdateSubscription

名称	必选	允许NULL	类型	描述
Id	是	否	Int64	订阅消息ID，-1表示新建，其余非负值表示将对应消息更新示例值： 1
IsSubscribed	是	否	Bool	消息订阅状态，false表示取消订阅，true表示订阅示例值： true
TimeInfo	是	否	SubscriptionTimeInfo	订阅时间信息示例值：查看
EmailInfo	是	否	SubscriptionEmailInfo	订阅邮箱信息示例值：查看
Language	否	否	String	订阅信息使用的语言。目前支持 zh-CN : 中文简体，en-US : 英文。默认值为 zh-CN 示例值： en-US
Name	否	是	String	订阅名称示例值：报告订阅
TplId	否	是	Uint64	对应的订阅模版ID 示例值： 1
TplName	否	是	String	对应的订阅模版名称示例值：报告模板

GroupSummary

分组的扫描结果概览。

被如下接口引用：DescribeOverview、DescribeTaskSummary

名称	必选	允许NULL	类型	描述
GroupId	是	否	Int64	分组Id，-1：总览，1：安全，2：可靠，3：服务限制，4：成本，5：性能。示例值： 1
HighRiskCount	是	否	Int64	该分组下高风险的策略数量(不包括忽略策略数量)。示例值： 1
MediumRiskCount	是	否	Int64	该分组下中风险的策略数量(不包括忽略策略数量)。示例值： 1
LowRiskCount	是	否	Int64	该分组下低风险的策略数量(不包括忽略策略数量)。示例值： 0
NoRiskCount	是	否	Int64	该分组下无风险的策略数量(不包括忽略策略数量)。示例值： 1

RiskDay

趋势数据

被如下接口引用：DescribeOverview

名称	必选	允许NULL	类型	描述
Date	是	否	String	日期示例值： 2021-07-16
Count	是	否	Uint64	数量示例值： 1

DescribeStrategie

评估项信息

被如下接口引用：DescribeStrategies

名称	必选	允许NULL	类型	描述
StrategyId	是	是	Uint64	评估项ID 示例值： 1
Name	是	是	String	评估项名称示例值：云数据库（MySQL）root 账号安全风险
Desc	是	是	String	评估项描述示例值：检查 MySQL 账号配置，若只存在 root 账号，没有其他应用账号，说明权限过大，存在误操作或恶意操作影响数据安全的风险
Ignore	是	是	String	忽略模版示例值： 2 个实例被忽略。
Notice	是	是	String	警告模版示例值： 2 个 MySQL 实例只设置了 root 账号。
Product	是	是	String	评估项对应产品ID 示例值： mysql
ProductDesc	是	是	String	评估项对应产品名称示例值：云数据库（MySQL）
Repair	是	是	String	评估项优化建议示例值：建议依据最小化权限原则，根据不同的业务需求创建不同的账号，并分配适当的权限，提升数据隔离性和安全性，也便于管理。请查看最佳实践
GroupId	是	是	Uint64	评估项类别ID 示例值： 1
GroupName	是	是	String	评估项类别名称示例值：安全
Conditions	是	是	Array of DescribeStrategiesCondition	评估项风险列表示例值：查看

ConfigCondition

策略的判断条件

被如下接口引用：DescribeConfig

名称	必选	允许NULL	类型	描述
ConditionId	是	否	Int64	条件ID 示例值： 1
Level	是	否	Int64	此条件的安全等级,1低风险 2中风险 3高风险示例值： 3
Desc	是	否	String	此条件的描述 eg:对所有人允许上传和删除访问权限示例值： MySQL 实例只设置了 root 账号

SubscriptionTimeInfo

订阅的时间信息

被如下接口引用：DescribeSubscriptions、UpdateSubscription

名称	必选	允许NULL	类型	描述
Period	是	否	String	订阅周期，可为Daily（每天）或Weekly（每周）示例值： weekly
DayOfWeek	否	是	Int64	仅在Period为Weekly时可用，取值为1-7，对应周一至周日示例值： 1
Time	是	否	String	订阅时间（24小时制），格式为“00:00"，只能选择小时整点时间示例值： 17:00

IgnoreStrategyInstance

忽略的实例的详细信息

被如下接口引用：ListAllIgnoreInstances

名称	必选	允许NULL	类型	描述
Id	是	否	String	实例的ID 示例值： ins_id
Region	是	否	String	实例的地区编号 eg:ap-guangzhou 示例值： ap-guangzhou
StrategyId	是	否	Int64	忽略的策略的ID 示例值： 3

SubscriptionEmailInfo

订阅的邮箱信息

被如下接口引用：DescribeSubscriptions、UpdateSubscription

名称	必选	允许NULL	类型	描述
EmailAddrs	是	否	Array of String	订阅邮箱示例值： ["abc@email.com"]

Filters

过滤条件

被如下接口引用：DescribeGlobalIgnoreTags、DescribeSubscriptionTemplates、DescribeSubscriptions、DescribeTaskStrategyIgnores、DescribeTaskStrategyRisks、DescribeTaskSummary

名称	必选	允许NULL	类型	描述
Name	是	是	String	过滤名称示例值： key
Values	是	是	Array of String	过滤值示例值： ["val"]

KeyValue

键值对

被如下接口引用：DescribeRiskDisplay、DescribeTaskStrategyIgnores、DescribeTaskStrategyRisks

名称	必选	允许NULL	类型	描述
Key	否	否	String	键名示例值： key
Value	否	否	String	键名对应值示例值： val

RegionCode

地区编码

被如下接口引用：ListRegionCodes

名称	必选	允许NULL	类型	描述
Region	是	否	String	地区 , 如: ap-guangzhou 示例值： ap-guangzhou
Code	是	否	Int64	地区的编码, 如:1 示例值： 1

ResultCondition

扫描出来满足条件的实例的信息

被如下接口引用：DescribeTaskResult

名称	必选	允许NULL	类型	描述
ConditionId	是	否	Int64	命中的条件的ID 示例值： 1
UnsafeInstances	是	是	Array of Instance	命中此条件的实例的列表示例值：查看

ConfigStrategy

策略的信息

被如下接口引用：DescribeConfig

名称	必选	允许NULL	类型	描述
StrategyId	是	否	Int64	策略的ID 示例值： 3
Product	是	否	String	所属于那个产品,例如:cvm,cos 示例值：云数据库（MySQL）
Name	是	否	String	策略的名字,例如:COS存储桶权限示例值：云数据库（MySQL）root 账号安全风险
Desc	是	否	String	策略的描述,例如:检查COS中具有开放访问权限或者任何已通过身份认证的CAM用户访问的存储桶示例值：检查 MySQL 账号配置，若只存在 root 账号，没有其他应用账号，说明权限过大，存在误操作或恶意操作影响数据安全的风险
Repair	是	否	String	策略的修复方式,例如:使用"COS阻止公共访问"来控制示例值：建议依据最小化权限原则，根据不同的业务需求创建不同的账号，并分配适当的权限，提升数据隔离性和安全性，也便于管理。请查看最佳实践
Notice	是	否	String	策略出现问题时候的综述,例如:%d个存储桶授予全局访问权限示例值： 2 个 MySQL 实例只设置了 root 账号。
Ignore	是	否	String	策略被忽略时候的描述,例如:%d个存储桶被忽略示例值： 2 个实例被忽略。
Conditions	是	否	Array of ConfigCondition	策略包含的条件列表示例值：查看

ProductSummary

产品维度概览数据

被如下接口引用：DescribeOverview

名称	必选	允许NULL	类型	描述
HighRiskCount	是	否	Uint64	该分组下高风险的策略数量(不包括忽略策略数量)。示例值： 1
MediumRiskCount	是	否	Uint64	该分组下中风险的策略数量(不包括忽略策略数量)。示例值： 1
NoRiskCount	是	否	Uint64	该分组下无风险的策略数量(不包括忽略策略数量)。示例值： 2
Count	是	否	Uint64	该分组下（高风险+中风险+无风险）的策略数量(不包括忽略策略数量)。示例值： 4
RiskRate	是	否	Float	风险率=当前风险数/(资源数*已开启资源型巡检项) 示例值： 0.5
StrategyCount	是	否	Uint64	巡检项数量示例值： 4
RiskCount	是	否	Uint64	该分组下（高风险+中风险）的策略数量(不包括忽略策略数量)。示例值： 3
Product	是	否	String	产品简称示例值： cvm

ResultStrategy

策略扫描的结果

被如下接口引用：DescribeTaskResult

名称	必选	允许NULL	类型	描述
Conditions	是	是	Array of ResultCondition	策略包含的条件列表示例值：查看
AllInstances	是	是	Array of Instance	策略扫描的实例的列表示例值：查看
StrategyId	是	否	Int64	策略的ID 示例值： 3
Code	是	否	String	策略执行情况: init 初始化 running 进行中 success 成功 fail失败示例值： code
Message	是	是	String	如果策略执行失败,此字段为测试的失败详情示例值： code

StrategySummary

策略下实例的扫描结果概览。

被如下接口引用：DescribeOverview、DescribeTaskSummary

名称	必选	允许NULL	类型	描述
StrategyId	是	否	Int64	策略Id 示例值： 1
Code	是	否	String	策略的扫描状态。策略执行情况: init 初始化 running 进行中 success 成功 fail失败。示例值： success
GroupId	是	否	Int64	策略对应的分类Id。示例值： 1
HighRiskCount	是	否	Int64	该策略下高风险的实例数量(不包括忽略实例数量)。示例值： 1
MediumRiskCount	是	否	Int64	该策略下中风险的实例数量(不包括忽略实例数量) 示例值： 1
LowRiskCount	是	否	Int64	该策略下低风险的实例数量(不包括忽略实例数量)。示例值： 0
NoRiskCount	是	否	Int64	该策略下无风险的实例数量(不包括忽略实例数量)。示例值： 2
IgnoredInstanceCount	是	否	Int64	该策略下被忽略的实例数量。示例值： 0
StrategyName	是	是	String	策略名称示例值：云数据库（MySQL）root 账号安全风险
Count	是	是	Uint64	高风险+中风险+无风险示例值： 4