Method: organizations.assets.list

組織のアセットを一覧表示します。

HTTP リクエスト


この URL は gRPC Transcoding 構文を使用します。

パスパラメータ

パラメータ
parent

string

必須。アセットが属する組織の名前。形式は「organizations/[organization_id]」です。

クエリ パラメータ

パラメータ
filter

string

アセット全体に適用するフィルタを定義する式。式は、論理演算子 AND と OR で結合された 0 個以上の制限のリストです。かっこはサポートされていません。また、OR は AND よりも優先度が高くなります。

制限は <field> <operator> <value> の形式で、否定を示すために前に - 文字を付けることができます。フィールドは、Asset リソースで定義されたフィールドにマッピングされます。次に例を示します。

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

サポートされている演算子は次のとおりです。

  • すべての値型で =。
  • 整数値の場合は >、<、>=、<=。
  • :: 文字列の部分文字列照合。

サポートされている値の型は次のとおりです。

  • 文字列リテラルは引用符で囲みます。
  • 整数リテラル（引用符なし）。
  • ブール値リテラル true と false（引用符なし）。

たとえば、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 の間の時間です。

状態の値は、2 つの時点でのアセットの存在に基づいて導出されます。2 回目の測定までの間の中間状態の変化は結果に影響しません。たとえば、アセットを削除して再作成しても、結果は影響を受けません。

compareDuration が指定されている場合の「state」の値:

  • 「ADDED」: アセットが compareDuration より前に存在しなかったが、readTime には存在したことを示します。
  • 「REMOVED」: アセットは compareDuration の開始時に存在していましたが、readTime の時点では存在しません。
  • 「ACTIVE」: アセットは、compareDuration と readTime で定義された期間の開始時間と終了時間のどちらでも存在していました。

compareDuration が指定されていない場合、可能な状態は「UNUSED」のみです。これは、アセットが readTime に存在することを示します。

s で終わる小数 9 桁までの秒単位の期間。例: "3.5s"。
fieldMask

string (FieldMask format)

省略可。レスポンスに表示する ListAssetsResult フィールドを指定する項目マスク。フィールド マスクが空の場合は、すべてのフィールドが一覧表示されます。
pageToken

string

最後の ListAssetsResponse で返された値は、これが前の assets.list 呼び出しの続きであり、システムからその次のページのデータが返される必要があることを示しています。
pageSize

integer

1 回のレスポンスで返される結果の最大件数。デフォルトは 10 で、最小値は 1、最大値は 1,000 です。

リクエストの本文

リクエストの本文は空にする必要があります。

レスポンスの本文

アセットの一覧表示に対するレスポンス メッセージ。

成功した場合、レスポンスの本文には次の構造のデータが含まれます。

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)

アセットの状態。

アセット

Google Cloud リソースの Security Command Center での表現。

アセットは、単一の Google Cloud リソースに関する情報をキャプチャする Security Command Center リソースです。アセットに対するすべての変更は 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 リソースのオーナー。

州

アセットの状態。

2 つの時点をまたいでクエリを実行すると、2 つの時点間の変更（追加、削除、アクティブ）が示されます。リクエストで compareDuration が指定されていない場合、状態は UNUSED になります。

列挙型
STATE_UNSPECIFIED 未指定の状態
UNUSED リクエストで、結果でこのフィールドを使用するように指定されていません。
ADDED 期間中にアセットが追加された。
REMOVED 期間中にアセットが削除された。
ACTIVE アセットが両方の時点でアクティブだった。