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

数据结构

最近更新时间: 2024-09-11 15:05:02

KeyValue

键值对

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

名称 必选 允许NULL 类型 描述
Key 否 否 String 键名
Value 否 否 String 键名对应值

ResultCondition

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

被如下接口引用：DescribeTaskResult

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

SubscriptionInfo

订阅信息

被如下接口引用：DescribeSubscriptions、UpdateSubscription

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

IgnoreInstance

忽略扫描的实例的信息

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

名称 必选 允许NULL 类型 描述
Id 是 否 String 实例的ID
Region 否 否 String 实例的地区

IgnoreStrategyInstance

忽略的实例的详细信息

被如下接口引用：ListAllIgnoreInstances

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

Instance

扫描的实例的基础信息

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

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

StrategySummary

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

被如下接口引用：DescribeOverview、DescribeTaskSummary

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

SubscriptionTimeInfo

订阅的时间信息

被如下接口引用：DescribeSubscriptions、UpdateSubscription

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

Progress

进度

被如下接口引用：DescribeTaskProgress

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

RiskFieldsDescDetail

风险实例字段配置

被如下接口引用：DescribeRiskDisplay

名称 必选 允许NULL 类型 描述
StrategyId 是 是 Uint64 巡检项ID
Url 是 是 String 巡检项实例对应的URL
RiskFieldsDesc 是 是 Array of RiskFieldsDesc 巡检项对应配置
LinkId 是 是 String 链接渲染字段ID
PriId 是 是 String 设置忽略字段ID

RiskDay

趋势数据

被如下接口引用：DescribeOverview

名称 必选 允许NULL 类型 描述
Date 是 否 String 日期
Count 是 否 Uint64 数量

Groups

Groups类型

被如下接口引用：DescribeProductConfigList

名称 必选 允许NULL 类型 描述
Id 是 否 Uint64 类型Id
GroupName 是 否 String 类型名称

UnsafeDetail

有风险实例详情

被如下接口引用：DescribeTaskStrategyUnsafeDetail

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

ProductSummary

产品维度概览数据

被如下接口引用：DescribeOverview

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

DescribeStrategiesCondition

评估项警告条件

被如下接口引用：DescribeStrategies

名称 必选 允许NULL 类型 描述
ConditionId 是 是 Uint64 警告条件ID
Level 是 是 Uint64 警告级别，2:中风险，3:高风险
LevelDesc 是 是 String 警告级别描述
Desc 是 否 String 警告条件描述

ProductProgress

产品扫描进度

被如下接口引用：DescribeTaskProgress

名称 必选 允许NULL 类型 描述
Name 是 否 String 产品名称。
Progress 是 否 Progress 产品扫描进度。

GroupSummary

分组的扫描结果概览。

被如下接口引用：DescribeOverview、DescribeTaskSummary

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

IgnoredDetail

忽略实例详情

被如下接口引用：DescribeTaskStrategyIgnoredDetail

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

RiskFieldsDesc

风险实例字段描述

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

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

Tags

查询tag对应的类型

被如下接口引用：CreateSubscriptionTemplate、DescribeGlobalIgnoreTags、DescribeSubscriptionTemplates、DescribeTags、DownloadReportFileAsync、ModifyGlobalIgnoreTags、ModifySubscriptionTemplate

名称 必选 允许NULL 类型 描述
TagKey 是 是 String Tag对应的key
TagValues 是 是 Array of String tag对应的values

ConfigGroup

策略组成的大组的信息

被如下接口引用：DescribeConfig

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

RegionCode

地区编码

被如下接口引用：ListRegionCodes

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

TplSets

template sets

被如下接口引用：DescribeSubscriptionTemplates

名称 必选 允许NULL 类型 描述
GroupIds 是 是 Array of Uint64 group ids
Id 是 是 Uint64 template id
Products 是 是 Array of String template products
Name 是 是 String template name
Tags 是 是 Array of Tags template tag

ConfigCondition

策略的判断条件

被如下接口引用：DescribeConfig

名称 必选 允许NULL 类型 描述
ConditionId 是 否 Int64 条件ID
Level 是 否 Int64 此条件的安全等级,1低风险 2中风险 3高风险
Desc 是 否 String 此条件的描述 eg:对所有人允许上传和删除访问权限

ResultStrategy

策略扫描的结果

被如下接口引用：DescribeTaskResult

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

ConfigStrategy

策略的信息

被如下接口引用：DescribeConfig

名称 必选 允许NULL 类型 描述
StrategyId 是 否 Int64 策略的ID
Product 是 否 String 所属于那个产品,例如:cvm,cos
Name 是 否 String 策略的名字,例如:COS存储桶权限
Desc 是 否 String 策略的描述,例如:检查COS中具有开放访问权限或者任何已通过身份认证的CAM用户访问的存储桶
Repair 是 否 String 策略的修复方式,例如:使用"COS阻止公共访问"来控制
Notice 是 否 String 策略出现问题时候的综述,例如:%d个存储桶授予全局访问权限
Ignore 是 否 String 策略被忽略时候的描述,例如:%d个存储桶被忽略
Conditions 是 否 Array of ConfigCondition 策略包含的条件列表

Filters

过滤条件

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

名称 必选 允许NULL 类型 描述
Name 是 是 String 过滤名称
Values 是 是 Array of String 过滤值

DescribeStrategie

评估项信息

被如下接口引用：DescribeStrategies

名称 必选 允许NULL 类型 描述
StrategyId 是 是 Uint64 评估项ID
Name 是 是 String 评估项名称
Desc 是 是 String 评估项描述
Ignore 是 是 String 忽略模版
Notice 是 是 String 警告模版
Product 是 是 String 评估项对应产品ID
ProductDesc 是 是 String 评估项对应产品名称
Repair 是 是 String 评估项优化建议
GroupId 是 是 Uint64 评估项类别ID
GroupName 是 是 String 评估项类别名称
Conditions 是 是 Array of DescribeStrategiesCondition 评估项风险列表

SubscriptionEmailInfo

订阅的邮箱信息

被如下接口引用：DescribeSubscriptions、UpdateSubscription

名称 必选 允许NULL 类型 描述
EmailAddrs 是 否 Array of String 订阅邮箱