Shadow API Discovery: APIs de administración

Descripción general

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

Si deseas obtener una descripción general de Shadow API Discovery y las instrucciones para administrarlo con la IU de Apigee en la consola de Cloud, consulta Shadow API Discovery. La información sobre los comportamientos y limitaciones generales del descubrimiento de la API de Shadow se encuentra en Comportamientos y limitaciones.

Parámetros en llamadas a la API de referencia

Las llamadas a la API en esta página pueden usar los siguientes parámetros, que hacen referencia a la información de tu cuenta de Apigee (como tu proyecto) o a la información que se usa cuando creas trabajos de observación. Consulta Crea trabajos de observación para obtener más información sobre cada uno de estos campos.

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

Crea un trabajo de observación

La creación de un trabajo de observación requiere varios pasos/solicitudes a la API.

  1. Crea una fuente de observación: Para crear una fuente de observación nueva en lugar de usar una existente, realiza una solicitud POST al extremo observationSources con los detalles de la fuente de observación.
    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, y comienza una 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 recién creada, haz lo siguiente: 
    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 shadow 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

Habilita un trabajo de observación

Usa el siguiente comando para habilitar un trabajo de observación nuevo o uno existente inhabilitado.

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

Consulta las APIs descubiertas

Para ver las APIs que descubrieron los trabajos de observación habilitados, envía este comando:

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

Administra etiquetas en los resultados de observación

Para mostrar una lista de las etiquetas que ya se agregaron a los resultados, sigue estos pasos:

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

Para administrar etiquetas, haz lo siguiente:

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

Inhabilita un trabajo de observación

Esta solicitud inhabilita un trabajo de observación sin borrarlo.

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'
{
}

Borra un trabajo de observación

Esta solicitud borra un trabajo de observación.

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

Borra una fuente de observación

Esta solicitud borra una fuente de observación.

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