Detección de APIs ocultas: APIs de gestión

Información general

En esta página se proporciona la sintaxis de referencia para gestionar Apigee Shadow API Discovery desde las APIs de gestión de Apigee (APIM). La documentación de las APIs de gestión relacionadas con la detección de APIs fantasma, incluida la información sobre cada campo de una solicitud, se puede consultar en https://cloud.google.com/apigee/docs/reference/apis/apim/rest y https://cloud.google.com/apigee/docs/reference/apis/apim/rpc.

Para obtener una descripción general de la detección de APIs ocultas e instrucciones para gestionarla mediante la interfaz de usuario de Apigee en la consola de Cloud, consulta Detección de APIs ocultas. Puedes consultar información sobre los comportamientos y las limitaciones generales de Detección de APIs fantasma en el artículo Comportamientos y limitaciones.

Parámetros en llamadas a la API de referencia

Las llamadas a la API de esta página pueden usar los siguientes parámetros, que hacen referencia a la información de su cuenta de Apigee (como su proyecto) o a la información que se usa al crear trabajos de observación. Para obtener más información sobre cada uno de estos campos, consulta Crear trabajos de observación.

  • OBSERVATION_JOB_LOCATION es la ubicación de una tarea de observación.
  • OBSERVATION_JOB_NAME es el nombre de una tarea de observación.
  • OBSERVATION_SOURCE_LOCATION es una ubicación de origen de la tarea de observación.
  • OBSERVATION_SOURCE_NAME es el nombre de una fuente de observación.
  • PROJECT es tu proyecto de Apigee.

Crear una tarea de observación

Para crear una tarea de observación, se necesitan varios pasos o solicitudes a la API.

  1. Crea una fuente de observaciones: para crear una fuente de observaciones en lugar de usar una que ya tengas, haz una solicitud POST al endpoint observationSources con los detalles de la fuente de observaciones.
    curl \ https://apim.googleapis.com/v1alpha/projects/PROJECT/locations/OBSERVATION_SOURCE_LOCATION/observationSources?observation_source_id=OBSERVATION_SOURCE_NAME \
-X POST \
-H 'Content-type: application/json' \
-d @- <<'EOF'
{
  "gclbObservationSource": {
    "pscNetworkConfigs": [
      {
        "network": "projects/PROJECT/global/networks/{network_name}",
        "subnetwork":"projects/PROJECT/regions/OBSERVATION_SOURCE_LOCATION/subnetworks/{subnet_name}"
      }
    ]
  }
}
EOF
     La creación de una fuente de observación requiere varios minutos e inicia un LRO, con una respuesta como esta: 
    {
"name": "projects/{project/locations/OBSERVATION_SOURCE_LOCATION/operations/operation-",
"metadata": {
  "@type": "type.googleapis.com/google.cloud.apim.vl.ApiDiscoveryOperationMetadata",
  "createTime": "",
  "target": "projects/PROJECT/locations/OBSERVATION_SOURCE_LOCATION/observationSources/OBSERVATION_SOURCE_NAME",
  "verb": "create",
  "requestedCancellation": false,
  "apiVersion": "vl"
},
"done": false
}
  2. Para ver la fuente de observación que acaba de crear, siga estos pasos: 
    curl \
https://apim.googleapis.com/v1alpha/projects/PROJECT/locations/OBSERVATION_SOURCE_LOCATION/observationSources/OBSERVATION_SOURCE_NAME
  3. Crea un trabajo de observación: crea un trabajo que busque APIs ocultas con la fuente que acabas de crear: 
    curl \
https://apim.googleapis.com/v1alpha/projects/PROJECT/locations/OBSERVATION_JOB_LOCATION/observationJobs?observation_job_id=OBSERVATION_JOB_NAME \
-X POST \
-H 'Content-type: application/json' \
-d @- <<'EOF'
{
  "sources": [
    "projects/PROJECT/locations/OBSERVATION_SOURCE_LOCATION/observationSources/OBSERVATION_SOURCE_NAME"
  ]
}
EOF

Habilitar una tarea de observación

Usa el siguiente comando para habilitar una tarea de observación nueva o una tarea inhabilitada.

curl https://apim.googleapis.com/v1alpha/projects/PROJECT/locations/OBSERVATION_JOB_LOCATION/observationJobs/OBSERVATION_JOB_NAME:enable \
-X POST \
-H 'Content-type: application/json' \
-d @- <<'EOF'
{}
EOF

Ver las APIs descubiertas

Para ver las APIs descubiertas por las tareas de observación habilitadas, envía este comando:

curl https://apim.googleapis.com/v1alpha/projects/PROJECT/locations/OBSERVATION_JOB_LOCATION/observationJobs/OBSERVATION_JOB_NAME/apiObservations \
-X GET

Gestionar etiquetas en los resultados de las observaciones

Para ver las etiquetas que ya se han añadido a los resultados, sigue estos pasos:

curl -H "https://apim.googleapis.com/v1alpha/projects/PROJECT/locations/OBSERVATION_JOB_LOCATION:listApiObservationTags"

Para gestionar las etiquetas, sigue estos pasos:

curl -H "Content-Type: appication/json" \
"https://apim.googleapis.com/v1alpha/projects/PROJECT/locations/OBSERVATION_JOB_LOCATION/observationJobs/OBSERVATION_JOB_NAME/apiObservations:batchEditTags" \
-X POST -d @- <<'EOF'
{
  "requests": [
    {
      "apiObservationId": "API_OBSERVATION_ID",
      "tagActions": [
      {
        "tag": "demo",
        "action": "REMOVE"
      },
      {
        "tag": "Needs Attentions",
        "action": "ADD"
      }]
    }
  ]
}
EOF

Inhabilitar una tarea de observación

Esta solicitud inhabilita una tarea de observación sin eliminarla.

curl https://apim.googleapis.com/v1alpha/projects/PROJECT/locations/OBSERVATION_JOB_LOCATION/observationsJobs/OBSERVATION_JOB_NAME:disable \
-X POST \
-H 'Content-type: application/json' \
-d @- <<'EOF'
{
}

Eliminar una tarea de observación

Esta solicitud elimina una tarea de observación.

curl -X DELETE https://apim.googleapis.com/v1alpha/projects/PROJECT/locations/OBSERVATION_JOB_LOCATION/observationJobs/OBSERVATION_JOB_NAME

Eliminar una fuente de observación

Esta solicitud elimina una fuente de observación.

curl -X DELETE https://apim.googleapis.com/v1alpha/projects/PROJECT/locations/OBSERVATION_SOURCE_LOCATION/observationSources/OBSERVATION_SOURCE_NAME