×

GET /v1/report/configurations

描述

参数

查询参数

名称 描述 必填 默认值 模式

query

-

null

pagination.limit

-

null

pagination.offset

-

null

pagination.sortOption.field

-

null

pagination.sortOption.reversed

-

null

pagination.sortOption.aggregateBy.aggrFunc

-

未设置

pagination.sortOption.aggregateBy.distinct

-

null

内容类型

  • application/json

响应

表1. HTTP响应代码
代码 消息 数据类型

200

成功的响应。

V1GetReportConfigurationsResponse

0

意外的错误响应。

GooglerpcStatus

示例

常用对象引用

GooglerpcStatus

字段名称 必填 可为空 类型 描述 格式

code

整数

int32

message

字符串

details

ProtobufAny 列表

ProtobufAny

Any包含任意序列化的protocol buffer消息以及描述序列化消息类型的URL。

Protobuf库提供支持以实用函数或Any类型的附加生成方法的形式打包/解包Any值。

示例1:在C++中打包和解包消息。

Foo foo = ...;
Any any;
any.PackFrom(foo);
...
if (any.UnpackTo(&foo)) {
  ...
}

示例2:在Java中打包和解包消息。

Foo foo = ...;
Any any = Any.pack(foo);
...
if (any.is(Foo.class)) {
  foo = any.unpack(Foo.class);
}
// or ...
if (any.isSameTypeAs(Foo.getDefaultInstance())) {
  foo = any.unpack(Foo.getDefaultInstance());
}
Example 3: Pack and unpack a message in Python.
foo = Foo(...)
any = Any()
any.Pack(foo)
...
if any.Is(Foo.DESCRIPTOR):
  any.Unpack(foo)
  ...
Example 4: Pack and unpack a message in Go
foo := &pb.Foo{...}
any, err := anypb.New(foo)
if err != nil {
  ...
}
...
foo := &pb.Foo{}
if err := any.UnmarshalTo(foo); err != nil {
  ...
}

Protobuf库提供的打包方法默认使用'type.googleapis.com/full.type.name'作为类型URL,解包方法仅使用类型URL中最后一个'/'之后的完全限定类型名称,例如"foo.bar.com/x/y.z"将产生类型名称"y.z"。

JSON表示

Any值的JSON表示使用反序列化的嵌入式消息的常规表示,并添加一个包含类型URL的附加字段@type。示例

package google.profile;
message Person {
  string first_name = 1;
  string last_name = 2;
}
{
  "@type": "type.googleapis.com/google.profile.Person",
  "firstName": <string>,
  "lastName": <string>
}

如果嵌入式消息类型是众所周知的并且具有自定义JSON表示,则该表示将被嵌入,并添加一个字段value,该字段除了@type字段外还包含自定义JSON。示例(对于消息[google.protobuf.Duration][])

{
  "@type": "type.googleapis.com/google.protobuf.Duration",
  "value": "1.212s"
}
字段名称 必填 可为空 类型 描述 格式

@type

字符串

一个 URL/资源名称,唯一标识序列化协议缓冲区消息的类型。此字符串必须包含至少一个“/”字符。URL 路径的最后一部分必须表示类型的完全限定名(例如,path/google.protobuf.Duration)。名称应采用规范形式(例如,不接受前导“.”)。实际上,团队通常会将其预期在 Any 上下文中使用的所有类型预编译到二进制文件中。但是,对于使用方案httphttps或无方案的 URL,可以选择设置一个类型服务器,将类型 URL 映射到消息定义,如下所示:* 如果未提供方案,则假定为https。* 对 URL 的 HTTP GET 必须产生二进制格式的[google.protobuf.Type][]值,否则会产生错误。* 应用程序可以根据 URL 缓存查找结果,或将其预编译到二进制文件中以避免任何查找。因此,需要在更改类型时保留二进制兼容性。(使用版本化的类型名称来管理重大更改。)注意:此功能当前在官方 protobuf 版本中不可用,并且不用于以 type.googleapis.com 开头的类型 URL。截至 2023 年 5 月,没有广泛使用的类型服务器实现,也没有计划实现一个。可能使用除httphttps(或空方案)以外的方案,并具有特定于实现的语义。

ReportConfigurationReportType

枚举值

VULNERABILITY

ReportLastRunStatusRunStatus

枚举值

SUCCESS

FAILURE

ScheduleDaysOfMonth

1 for 1st, 2 for 2nd .... 31 for 31st
字段名称 必填 可为空 类型 描述 格式

integer 列表

int32

ScheduleDaysOfWeek

Sunday = 0, Monday = 1, .... Saturday =  6
字段名称 必填 可为空 类型 描述 格式

integer 列表

int32

ScheduleIntervalType

枚举值

未设置

DAILY

WEEKLY

MONTHLY

ScheduleWeeklyInterval

字段名称 必填 可为空 类型 描述 格式

整数

int32

SimpleAccessScopeRules

任何重复字段的每个元素都是一个单独的规则。规则由逻辑 OR 连接:如果存在允许资源x的规则,则x位于访问范围内。

字段名称 必填 可为空 类型 描述 格式

includedClusters

string 列表

includedNamespaces

SimpleAccessScopeRulesNamespace 列表

clusterLabelSelectors

StorageSetBasedLabelSelector 列表

namespaceLabelSelectors

StorageSetBasedLabelSelector 列表

SimpleAccessScopeRulesNamespace

字段名称 必填 可为空 类型 描述 格式

clusterName

字符串

必须设置这两个字段。

namespaceName

字符串

StorageEmailNotifierConfiguration

字段名称 必填 可为空 类型 描述 格式

notifierId

字符串

mailingLists

string 列表

customSubject

字符串

customBody

字符串

StorageNotifierConfiguration

字段名称 必填 可为空 类型 描述 格式

emailConfig

StorageEmailNotifierConfiguration

id

字符串

StorageReportConfiguration

字段名称 必填 可为空 类型 描述 格式

id

字符串

name

字符串

description

字符串

type

ReportConfigurationReportType

VULNERABILITY,

vulnReportFilters

StorageVulnerabilityReportFilters

scopeId

字符串

emailConfig

StorageEmailNotifierConfiguration

schedule

StorageSchedule

lastRunStatus

StorageReportLastRunStatus

lastSuccessfulRunTime

日期

日期时间

resourceScope

StorageResourceScope

notifiers

StorageNotifierConfiguration 列表

creator

StorageSlimUser

version

整数

int32

StorageReportLastRunStatus

字段名称 必填 可为空 类型 描述 格式

reportStatus

ReportLastRunStatusRunStatus

SUCCESS, FAILURE,

lastRunTime

日期

日期时间

errorMsg

字符串

StorageResourceScope

字段名称 必填 可为空 类型 描述 格式

collectionId

字符串

StorageSchedule

字段名称 必填 可为空 类型 描述 格式

intervalType

ScheduleIntervalType

UNSET, DAILY, WEEKLY, MONTHLY,

小时

整数

int32

分钟

整数

int32

weekly

ScheduleWeeklyInterval

daysOfWeek

ScheduleDaysOfWeek

daysOfMonth

ScheduleDaysOfMonth

StorageSetBasedLabelSelector

基于集合的标签选择器仅允许基于集合的标签要求。

下一个可用标签:3

字段名称 必填 可为空 类型 描述 格式

requirements

StorageSetBasedLabelSelectorRequirement 列表

StorageSetBasedLabelSelectorOperator

枚举值

UNKNOWN

IN

NOT_IN

EXISTS

NOT_EXISTS

StorageSetBasedLabelSelectorRequirement

Next available tag: 4
字段名称 必填 可为空 类型 描述 格式

key

字符串

op

StorageSetBasedLabelSelectorOperator

UNKNOWN, IN, NOT_IN, EXISTS, NOT_EXISTS,

values

string 列表

StorageSlimUser

字段名称 必填 可为空 类型 描述 格式

id

字符串

name

字符串

StorageVulnerabilityReportFilters

字段名称 必填 可为空 类型 描述 格式

fixability

VulnerabilityReportFiltersFixability

BOTH, FIXABLE, NOT_FIXABLE,

sinceLastReport

布尔值

severities

StorageVulnerabilitySeverity 列表

imageTypes

VulnerabilityReportFiltersImageType 列表

allVuln

布尔值

sinceLastSentScheduledReport

布尔值

sinceStartDate

日期

日期时间

accessScopeRules

SimpleAccessScopeRules 列表

includeNvdCvss

布尔值

StorageVulnerabilitySeverity

枚举值

UNKNOWN_VULNERABILITY_SEVERITY

LOW_VULNERABILITY_SEVERITY

MODERATE_VULNERABILITY_SEVERITY

IMPORTANT_VULNERABILITY_SEVERITY

CRITICAL_VULNERABILITY_SEVERITY

V1GetReportConfigurationsResponse

字段名称 必填 可为空 类型 描述 格式

reportConfigs

StorageReportConfiguration 列表

VulnerabilityReportFiltersFixability

枚举值

BOTH

FIXABLE

NOT_FIXABLE

VulnerabilityReportFiltersImageType

枚举值

DEPLOYED

WATCHED