Method: organizations.assets.list

Muestra una lista de los activos de una organización.

Solicitud HTTP


Las URL usan la sintaxis de transcodificación gRPC.

Parámetros de ruta de acceso

Parámetros
parent

string

Obligatorio. Es el nombre de la organización a la que deben pertenecer los recursos. Su formato es "organizations/[organization_id]".

Parámetros de consulta

Parámetros
filter

string

Es una expresión que define el filtro que se aplicará a todos los recursos. La expresión es una lista de cero o más restricciones combinadas a través de los operadores lógicos AND y OR. No se admiten paréntesis, y OR tiene una prioridad más alta que AND.

Las restricciones tienen el formato <field> <operator> <value> y pueden tener un carácter - delante para indicar la negación. Los campos se asignan a los definidos en el recurso Asset. Los ejemplos incluyen:

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

Los operadores admitidos son los siguientes:

  • = para todos los tipos de valores.
  • >, <, >=, <= para valores enteros
  • :, que significa coincidencia de substring, para cadenas.

Los tipos de valores admitidos son los siguientes:

  • literales de cadena entre comillas.
  • literales de número entero sin comillas.
  • Literales booleanos true y false sin comillas.

Por ejemplo, resourceProperties.size = 100 es una cadena de filtro válida.

orderBy

string

Es una expresión que define qué campos y orden usar para ordenar los datos. El valor de cadena debe seguir la sintaxis de SQL: lista de campos separados por comas. Por ejemplo: "name,resourceProperties.a_property". El orden de clasificación predeterminado es ascendente. Para especificar el orden descendente de un campo, se debe agregar un sufijo " desc" al nombre del campo. Por ejemplo: "name desc,resourceProperties.a_property". Los caracteres de espacio redundantes en la sintaxis son insignificantes. "name desc,resourceProperties.a_property" y " name desc , resourceProperties.a_property " son equivalentes.

readTime

string (Timestamp format)

Es la hora que se usa como punto de referencia cuando se filtran los recursos. El filtro se limita a los activos que existen en el momento proporcionado y sus valores son los de ese momento específico. Si no se incluye este campo, se usará la versión de NOW de la API de forma predeterminada.

Usa RFC 3339, en el que el resultado generado siempre se normalizará en Z y usará 0, 3, 6 o 9 dígitos fraccionarios. También se aceptan compensaciones distintas de "Z". Ejemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".

compareDuration

string (Duration format)

Cuando se establece compareDuration, se actualiza el atributo "state" de ListAssetResult para indicar si el recurso se agregó, quitó o permaneció presente durante el período de compareDuration que precede a readTime. Es el tiempo entre (readTime - compareDuration) y readTime.

El valor del estado se obtiene en función de la presencia del activo en los dos momentos. Los cambios de estado intermedios entre los dos momentos no afectan el resultado. Por ejemplo, los resultados no se ven afectados si se quita el recurso y se vuelve a crear.

Valores posibles de "state" cuando se especifica compareDuration:

  • "ADDED": Indica que el recurso no estaba presente antes de compareDuration, pero sí en readTime.
  • "REMOVED": Indica que el recurso estaba presente al comienzo de compareDuration, pero no en readTime.
  • "ACTIVE": Indica que el activo estaba presente al comienzo y al final del período definido por compareDuration y readTime.

Si no se especifica compareDuration, el único estado posible es "UNUSED", que indica que el recurso está presente en readTime.

Una duración en segundos con hasta nueve dígitos decimales, que terminan en “s”. Ejemplo: "3.5s".

fieldMask

string (FieldMask format)

Opcional. Es una máscara de campo para especificar los campos de ListAssetsResult que se mostrarán en la respuesta. Una máscara de campo vacía mostrará todos los campos.

pageToken

string

El valor que muestra el último ListAssetsResponse indica que esta es una continuación de una llamada assets.list anterior y que el sistema debe mostrar la siguiente página de datos.

pageSize

integer

Es la cantidad máxima de resultados que se mostrarán en una sola respuesta. El valor predeterminado es 10, el mínimo es 1 y el máximo es 1, 000.

Cuerpo de la solicitud

El cuerpo de la solicitud debe estar vacío.

Cuerpo de la respuesta

Mensaje de respuesta para enumerar los recursos.

Si se ejecuta correctamente, el cuerpo de la respuesta contiene datos con la siguiente estructura:

Representación JSON
{
  "listAssetsResults": [
    {
      object (ListAssetsResult)
    }
  ],
  "readTime": string,
  "nextPageToken": string,
  "totalSize": integer
}
Campos
listAssetsResults[]

object (ListAssetsResult)

Son los activos que coinciden con la solicitud de lista.

readTime

string (Timestamp format)

Es el tiempo que se usó para ejecutar la solicitud de lista.

Usa RFC 3339, en el que el resultado generado siempre se normalizará en Z y usará 0, 3, 6 o 9 dígitos fraccionarios. También se aceptan compensaciones distintas de "Z". Ejemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".

nextPageToken

string

Es un token para recuperar la página siguiente de resultados o dejarlo vacío si no hay más resultados.

totalSize

integer

Es la cantidad total de activos que coinciden con la consulta.

Permisos de autorización

Requiere el siguiente alcance de OAuth:

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

Para obtener más información, consulta Authentication Overview.

ListAssetsResult

Es el resultado que contiene el recurso y su estado.

Representación JSON
{
  "asset": {
    object (Asset)
  },
  "state": enum (State)
}
Campos
asset

object (Asset)

Es el activo que coincide con la solicitud de búsqueda.

state

enum (State)

Estado del recurso.

Recurso

Representación de un recurso de Google Cloud en Security Command Center.

El recurso es un recurso de Security Command Center que captura información sobre un solo recurso de Google Cloud. Todas las modificaciones de un activo solo se realizan en el contexto de Security Command Center y no afectan al recurso de Google Cloud al que se hace referencia.

Representación JSON
{
  "name": string,
  "securityCenterProperties": {
    object (SecurityCenterProperties)
  },
  "resourceProperties": {
    string: value,
    ...
  },
  "securityMarks": {
    object (SecurityMarks)
  },
  "createTime": string,
  "updateTime": string
}
Campos
name

string

Es el nombre de recurso relativo de este activo. Consulta: https://cloud.google.com/apis/design/resource_names#relative_resource_name Ejemplo: "organizations/{organization_id}/assets/{asset_id}".

securityCenterProperties

object (SecurityCenterProperties)

Propiedades administradas de Security Command Center Security Command Center administra estas propiedades, y el usuario no puede modificarlas.

resourceProperties

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

Propiedades administradas por recursos El recurso de Google Cloud administra y define estas propiedades, y el usuario no puede modificarlas.

Un objeto que contiene una lista de pares "key": value. Ejemplo: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

securityMarks

object (SecurityMarks)

Marcas de seguridad especificadas por el usuario El usuario administra estas marcas por completo y provienen del recurso SecurityMarks que pertenece al activo.

createTime

string (Timestamp format)

La hora en que se creó el activo en Security Command Center.

Usa RFC 3339, en el que el resultado generado siempre se normalizará en Z y usará 0, 3, 6 o 9 dígitos fraccionarios. También se aceptan compensaciones distintas de "Z". Ejemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".

updateTime

string (Timestamp format)

Es la hora en la que se actualizó, agregó o borró el activo por última vez en Security Command Center.

Usa RFC 3339, en el que el resultado generado siempre se normalizará en Z y usará 0, 3, 6 o 9 dígitos fraccionarios. También se aceptan compensaciones distintas de "Z". Ejemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".

SecurityCenterProperties

Propiedades administradas de Security Command Center Security Command Center administra estas propiedades, y el usuario no puede modificarlas.

Representación JSON
{
  "resourceName": string,
  "resourceType": string,
  "resourceParent": string,
  "resourceProject": string,
  "resourceOwners": [
    string
  ]
}
Campos
resourceName

string

Inmutable. Es el nombre completo del recurso de Google Cloud que representa este activo. Este campo es inmutable después de la creación. Consulta: https://cloud.google.com/apis/design/resource_names#full_resource_name

resourceType

string

El tipo de recurso de Google Cloud. Algunos ejemplos son: APPLICATION, PROJECT y ORGANIZATION. Este es un campo sin distinción de mayúsculas o minúsculas que define Security Command Center o el productor del recurso, y es inmutable después del tiempo de creación.

resourceParent

string

Es el nombre completo del recurso superior inmediato del recurso. Consulta: https://cloud.google.com/apis/design/resource_names#full_resource_name

resourceProject

string

Es el nombre completo del recurso del proyecto al que pertenece. Consulta: https://cloud.google.com/apis/design/resource_names#full_resource_name

resourceOwners[]

string

Propietarios del recurso de Google Cloud

Estado

Estado del recurso.

Cuando se consultan dos puntos en el tiempo, se describe el cambio entre los dos puntos: ADDED, REMOVED o ACTIVE. Si no se proporcionó compareDuration en la solicitud, el estado debe ser UNUSED.

Enums
STATE_UNSPECIFIED Estado sin especificar.
UNUSED La solicitud no especificó el uso de este campo en el resultado.
ADDED Se agregó un activo entre los puntos en el tiempo.
REMOVED El activo se quitó entre los puntos en el tiempo.
ACTIVE El activo estuvo activo en ambos momentos.