Method: organizations.assets.list

列出组织的资产。

HTTP 请求


网址使用 gRPC 转码语法。

路径参数

参数
parent

string

必需。资源应属于的组织的名称。其格式为“organizations/[organization_id]”。

查询参数

参数
filter

string

用于定义要应用于所有素材资源的过滤条件的表达式。该表达式是通过逻辑运算符 ANDOR 组合而成的零个或多个限制条件的列表。不支持圆括号,并且 OR 的优先级高于 AND

限制的形式为 <field> <operator> <value>,并且可能在前面带有 - 字符以表示否定。这些字段会映射到 Asset 资源中定义的字段。例如:

  • name
  • securityCenterProperties.resource_name
  • resourceProperties.a_property
  • securityMarks.marks.marka

支持的运算符包括:

  • =(适用于所有值类型)。
  • ><>=<=,表示整数值。
  • :,表示字符串的子字符串匹配。

支持的值类型包括:

  • 字符串字面量用引号括起来。
  • 不带引号的整数字面量。
  • 不带引号的布尔值字面量 truefalse

例如,resourceProperties.size = 100 是一个有效的过滤器字符串。

orderBy

string

用于定义要用于排序的字段和顺序的表达式。字符串值应遵循 SQL 语法:逗号分隔的字段列表。例如:“name,resourceProperties.a_property”。默认排序顺序为升序。如需将字段指定为降序,应将后缀“desc”附加到字段名称中。例如:“name desc,resourceProperties.a_property”。语法中的冗余空格字符是无关紧要的。“name desc,resourceProperties.a_property”和“name desc , resourceProperties.a_property”是等效的。

readTime

string (Timestamp format)

过滤素材资源时用作参考点的时间。此过滤条件仅限于在指定时间存在的资产,其值为该特定时间的值。如果未指定此字段,则默认使用 API 的 NOW 版本。

采用 RFC 3339 标准,生成的输出将始终在末尾带 Z,并使用 0、3、6 或 9 个小数位。不带“Z”的偏差时间也是可以接受的。示例:"2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z""2014-10-02T15:01:23+05:30"

compareDuration

string (Duration format)

设置 compareDuration 后,ListAssetResult 的“state”属性会更新,以指示相应资源在 readTime 之前的 compareDuration 时间段内是添加、移除还是保持存在。这是介于 (readTime - compareDuration) 和 readTime 之间的时间。

状态值是根据资产在这两个时间点的存在情况派生的。这两次时间点之间的中间状态变化不会影响结果。例如,如果移除资源并重新创建,结果不会受到影响。

指定 compareDuration 时可能的“state”值:

  • “ADDED”:表示相应资产在 compareDuration 之前不存在,但在 readTime 时存在。
  • “REMOVED”:表示相应资产在 compareDuration 的开始时存在,但在 readTime 时不存在。
  • “ACTIVE”:表示资源在 compareDuration 和 readTime 定义的时间段的开始和结束时都存在。

如果未指定 compareDuration,则唯一可能的状态为“UNUSED”,表示相应素材资源在 readTime 时存在。

该时长以秒为单位,最多包含九个小数位,以“s”结尾。示例:"3.5s"

fieldMask

string (FieldMask format)

可选。用于指定要在响应中列出的 ListAssetsResult 字段的字段掩码。空字段掩码将列出所有字段。

pageToken

string

最后一个 ListAssetsResponse 返回的值;该参数表示这是之前的 assets.list 调用的延续,并且系统应返回下一页的数据。

pageSize

integer

单个响应中返回的结果数上限。默认值为 10,最小值为 1,最大值为 1000。

请求正文

请求正文必须为空。

响应正文

用于列出素材资源的响应消息。

如果成功,响应正文将包含结构如下的数据:

JSON 表示法
{
  "listAssetsResults": [
    {
      object (ListAssetsResult)
    }
  ],
  "readTime": string,
  "nextPageToken": string,
  "totalSize": integer
}
字段
listAssetsResults[]

object (ListAssetsResult)

与列表请求匹配的素材资源。

readTime

string (Timestamp format)

执行列表请求所用的时间。

采用 RFC 3339 标准,生成的输出将始终在末尾带 Z,并使用 0、3、6 或 9 个小数位。不带“Z”的偏差时间也是可以接受的。示例:"2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z""2014-10-02T15:01:23+05:30"

nextPageToken

string

用于检索下一页结果的令牌。如果没有更多结果,则为空。

totalSize

integer

与查询匹配的资产总数。

授权范围

需要以下 OAuth 范围:

  • https://www.googleapis.com/auth/cloud-platform

如需了解详情,请参阅 Authentication Overview

ListAssetsResult

包含资产及其状态的结果。

JSON 表示法
{
  "asset": {
    object (Asset)
  },
  "state": enum (State)
}
字段
asset

object (Asset)

与搜索请求匹配的资产。

state

enum (State)

素材资源的状态。

素材资源

Security Command Center 中显示的 Google Cloud 资源。

资产是 Security Command Center 中的一种资源,用于捕获单个 Google Cloud 资源的相关信息。对资产的所有修改仅在 Security Command Center 上下文中进行,不会影响所引用的 Google Cloud 资源。

JSON 表示法
{
  "name": string,
  "securityCenterProperties": {
    object (SecurityCenterProperties)
  },
  "resourceProperties": {
    string: value,
    ...
  },
  "securityMarks": {
    object (SecurityMarks)
  },
  "createTime": string,
  "updateTime": string
}
字段
name

string

此资源的相对资源名称。请参阅:https://cloud.google.com/apis/design/resource_names#relative_resource_name。示例:“organizations/{organization_id}/assets/{asset_id}”。

securityCenterProperties

object (SecurityCenterProperties)

由 Security Command Center 管理的媒体资源。这些属性由 Security Command Center 管理,用户无法对其进行修改。

resourceProperties

map (key: string, value: value (Value format))

资源管理的媒体资源。这些属性由 Google Cloud 资源管理和定义,用户无法对其进行修改。

包含一系列 "key": value 对的对象。示例:{ "name": "wrench", "mass": "1.3kg", "count": "3" }

securityMarks

object (SecurityMarks)

用户指定的安全标记。这些标记完全由用户管理,来自于资产所属的 SecurityMarks 资源。

createTime

string (Timestamp format)

资产在 Security Command Center 中的创建时间。

采用 RFC 3339 标准,生成的输出将始终在末尾带 Z,并使用 0、3、6 或 9 个小数位。不带“Z”的偏差时间也是可以接受的。示例:"2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z""2014-10-02T15:01:23+05:30"

updateTime

string (Timestamp format)

资产在 Security Command Center 中上次更新、添加或删除的时间。

采用 RFC 3339 标准,生成的输出将始终在末尾带 Z,并使用 0、3、6 或 9 个小数位。不带“Z”的偏差时间也是可以接受的。示例:"2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z""2014-10-02T15:01:23+05:30"

SecurityCenterProperties

由 Security Command Center 管理的媒体资源。这些属性由 Security Command Center 管理,用户无法对其进行修改。

JSON 表示法
{
  "resourceName": string,
  "resourceType": string,
  "resourceParent": string,
  "resourceProject": string,
  "resourceOwners": [
    string
  ]
}
字段
resourceName

string

不可变。此资产所代表的 Google Cloud 资源的完整资源名称。此字段在创建时间之后不可更改。请参阅:https://cloud.google.com/apis/design/resource_names#full_resource_name

resourceType

string

Google Cloud 资源的类型。示例包括:APPLICATION、PROJECT 和 ORGANIZATION。这是 Security Command Center 和/或资源生产者定义的大小写不敏感字段,在创建后将不可变。

resourceParent

string

资源的直接父级的完整资源名称。请参阅:https://cloud.google.com/apis/design/resource_names#full_resource_name

resourceProject

string

资源所属项目的完整资源名称。请参阅:https://cloud.google.com/apis/design/resource_names#full_resource_name

resourceOwners[]

string

Google Cloud 资源的所有者。

素材资源的状态。

跨两个时间点进行查询时,此字段会描述这两个时间点之间的变化:ADDED、REMOVED 或 ACTIVE。如果请求中未提供 compareDuration,则状态应为:UNUSED

枚举
STATE_UNSPECIFIED 未指定状态。
UNUSED 请求未指定在结果中使用此字段。
ADDED 在时间点之间添加了素材资源。
REMOVED 素材资源在此时间段内被移除。
ACTIVE 资产在两个时间点都处于有效状态。