Administra tus informes de la API de App Optimize de manera eficaz enumerando todas las configuraciones de informes dentro de tu proyecto. Google Cloud Esto te ayuda a identificar un informe específico para leer sus datos o borrarlo antes de su fecha de vencimiento si ya no es necesario.
La operación de lista muestra los metadatos del informe, incluidos el nombre del recurso, el alcance, las dimensiones, las métricas y el tiempo de vencimiento de cada informe. Para descargar la información de costos y uso solicitada, debes leer los datos del informe.
Antes de comenzar
-
Verify that you have the permissions required to complete this guide.
Selecciona la pestaña según cómo planeas usar las muestras de este documento:
gcloud
Instala Google Cloud CLI.
Configura gcloud CLI para usar tu identidad federada.
Para obtener más información, consulta Accede a la gcloud CLI con tu identidad federada.
Para inicializar gcloud CLI, ejecuta el siguiente comando:
gcloud initDespués de inicializar gcloud CLI, actualízala y, luego, instala los componentes necesarios:
gcloud components update gcloud components install beta
Para obtener información sobre cómo configurar la autenticación de un entorno de producción, consulta Configura las credenciales predeterminadas de la aplicación para el código que se ejecuta en Google Cloud en la Google Cloud documentación de autenticación de.
Python
- Instala la biblioteca cliente de Python para la API de App Optimize.
-
Para usar las muestras de Python incluidas en esta página en un entorno de desarrollo local, instala e inicializa la gcloud CLI y, luego, configura las credenciales predeterminadas de la aplicación con tus credenciales de usuario.
-
Instala Google Cloud CLI.
-
Configura gcloud CLI para usar tu identidad federada.
Para obtener más información, consulta Accede a la gcloud CLI con tu identidad federada.
-
Crea credenciales de autenticación locales para tu cuenta de usuario:
gcloud auth application-default login
Si se muestra un error de autenticación y usas un proveedor de identidad (IdP) externo, confirma que accediste a la gcloud CLI con tu identidad federada.
Para obtener más información, consulta Configura ADC para un entorno de desarrollo local en la Google Cloud documentación de autenticación de.
Para obtener información sobre cómo configurar la autenticación de un entorno de producción, consulta Configura las credenciales predeterminadas de la aplicación para el código que se ejecuta en Google Cloud en la Google Cloud documentación de autenticación de.
-
REST
Para usar las muestras de la API de REST incluidas en esta página en un entorno de desarrollo local, debes usar las credenciales que proporciones a la gcloud CLI.
Instala Google Cloud CLI y, luego, accede a gcloud CLI con tu identidad federada.
Para obtener más información, consulta Autentícate para usar REST en la documentación de autenticación de. Google Cloud
Para obtener información sobre cómo configurar la autenticación de un entorno de producción, consulta Configura las credenciales predeterminadas de la aplicación para el código que se ejecuta en Google Cloud en la Google Cloud documentación de autenticación de.
Roles obligatorios
Para obtener los permisos que necesitas para enumerar los recursos de informes de un proyecto, pídele a tu administrador que te otorgue el rol de IAM de visualizador de App Optimize (roles/appoptimize.viewer) en el proyecto.
Para obtener más información sobre cómo otorgar roles, consulta Administra el acceso a proyectos, carpetas y organizaciones.
También puedes obtener los permisos necesarios a través de roles personalizados o cualquier otro rol predefinido.
Enumera informes
Para enumerar informes en un proyecto, sigue las instrucciones del método preferido:
gcloud
Usa el comando gcloud beta app-optimize reports list para enumerar los informes de un proyecto.
gcloud beta app-optimize reports list \
--project=PROJECT_ID \
--location=global
Reemplaza PROJECT_ID por el ID del Google Cloud
proyecto que posee los recursos de informes que deseas enumerar.
El comando gcloud controla la paginación de forma automática y muestra todos los recursos solicitados.
Python
En el siguiente código de Python, se usa AppOptimizeClient.list_reports() para mostrar una lista de informes en un proyecto.
from google.cloud import appoptimize_v1beta
project_id = "PROJECT_ID"
# Create the App Optimize client and request the project's reports
client = appoptimize_v1beta.AppOptimizeClient()
request = appoptimize_v1beta.ListReportsRequest(
parent=f"projects/{project_id}/locations/global"
)
page_result = client.list_reports(request=request)
# Iterate over the list of reports and display each one
for response in page_result:
print(response)
Reemplaza PROJECT_ID por el ID del Google Cloud
proyecto que posee los recursos de informes que deseas enumerar.
La biblioteca cliente controla la paginación de forma automática y genera resultados del iterador.
REST
Usa el siguiente curl comando para enumerar los informes
de un proyecto:
curl -H "Authorization: Bearer $(gcloud auth print-access-token)" \
"https://appoptimize.googleapis.com/v1beta/projects/PROJECT_ID/locations/global/reports?pageSize=PAGE_SIZE"
Reemplaza lo siguiente:
PROJECT_ID: Es el ID del Google Cloud proyecto que posee los recursos de informes que deseas enumerar.PAGE_SIZE: Es la cantidad máxima de informes que se mostrarán por página. Si se omite, la API usa un valor predeterminado. Es posible que el servidor muestre menos informes de los que se solicitaron.
Si la solicitud se realiza correctamente, la API muestra una respuesta JSON que contiene una lista de recursos de informes. A continuación, se muestra un ejemplo de respuesta de llamada correcta:
{
"reports": [
{
"name": "projects/PROJECT_ID/locations/global/reports/my-first-report",
"dimensions": [
"location",
"product_display_name",
"project",
"sku"
],
"scopes": [
{
"project": "projects/PROJECT_ID"
}
],
"filter": "hour \u003e= now - duration(\"168h\")",
"expireTime": "2026-02-05T18:30:39.907639266Z",
"metrics": [
"cost"
]
},
{
"name": "projects/PROJECT_ID/locations/global/reports/my-second-report",
"dimensions": [
"location",
"product_display_name",
"project",
"resource",
"resource_type"
],
"scopes": [
{
"project": "projects/PROJECT_ID"
}
],
"filter": "hour \u003e= now - duration(\"168h\")",
"expireTime": "2026-02-05T18:50:25.273833857Z",
"metrics": [
"cost",
"cpu_mean_utilization"
]
}
]
}
El array reports contiene los metadatos de cada informe. Si la solicitud no se realiza correctamente, revisa el mensaje de error que muestra la API.
Si la respuesta incluye una cadena nextPageToken, significa que hay más informes para recuperar.
Verifica si la respuesta tiene un campo nextPageToken. Si el token existe, ejecuta el siguiente comando curl para recuperar la página siguiente, incluido el parámetro de consulta pageToken. Puedes seguir usando el parámetro pageSize.
curl -H "Authorization: Bearer $(gcloud auth print-access-token)" \
"https://appoptimize.googleapis.com/v1beta/projects/PROJECT_ID/locations/global/reports?pageToken=NEXT_PAGE_TOKEN&pageSize=PAGE_SIZE"
Reemplaza lo siguiente:
NEXT_PAGE_TOKEN: Es el valor denextPageTokenque se recibió en la respuesta anterior.PAGE_SIZE: Es el tamaño de página que deseas para esta solicitud.
Repite este proceso hasta que la respuesta ya no contenga un nextPageToken, lo que indica que recuperaste todos los informes.