Rilevamento API Shadow: API di gestione

Panoramica

Questa pagina fornisce la sintassi di riferimento per la gestione del rilevamento dell'API Shadow di Apigee da Apigee le API di gestione dei dati (APIM). Documentazione per le API di gestione relative a Shadow API Discovery, incluse informazioni su ogni campo di una richiesta, sono disponibili all'indirizzo https://cloud.google.com/apigee/docs/reference/apis/apim/rest e https://cloud.google.com/apigee/docs/reference/apis/apim/rpc

Per una panoramica della funzionalità Rilevamento API ombra e le istruzioni per gestirla utilizzando l'interfaccia utente di Apigee nella console Cloud, consulta Rilevamento API ombra. Informazioni sui comportamenti e sulle limitazioni generali del rilevamento dell'API Shadow sono disponibili Comportamenti e limitazioni.

Parametri nelle chiamate API di riferimento

Le chiamate API in questa pagina possono utilizzare i seguenti parametri, che fanno riferimento ai dati del tuo account Apigee (ad esempio il progetto) o alle informazioni utilizzate per creare i job di osservazione. Per ulteriori informazioni su ciascuno di questi campi, consulta la sezione Creare job di osservazione.

  • OBSERVATION_JOB_LOCATION è una località per un job di osservazione.
  • OBSERVATION_JOB_NAME è il nome di un job di osservazione.
  • OBSERVATION_SOURCE_LOCATION è una posizione di origine per il job di osservazione.
  • OBSERVATION_SOURCE_NAME è il nome di un'origine di osservazione.
  • PROJECT è il tuo progetto Apigee.

Crea un job di osservazione

La creazione di un job di osservazione richiede più passaggi/richieste API.

  1. Crea un'origine di osservazione: per creare una nuova origine di osservazione anziché utilizzarne una esistente, invia una richiesta POST all'endpoint observationSources con i dettagli dell'origine di osservazione.
    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 creazione di un'origine di osservazione richiede diversi minuti e avvia un'LRO, con una risposta simile a questa: 
    {
"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. Per visualizzare l'origine dell'osservazione appena creata: 
    curl \
https://apim.googleapis.com/v1alpha/projects/PROJECT/locations/OBSERVATION_SOURCE_LOCATION/observationSources/OBSERVATION_SOURCE_NAME
  3. Crea un job di osservazione: crea un job che cerchi le API shadow utilizzando la fonte che hai appena creato: 
    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

Abilita un job di osservazione

Utilizza il comando seguente per abilitare un nuovo job di osservazione o un job esistente disabilitato.

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

Visualizza le API rilevate

Per visualizzare le API rilevate dai job di osservazione abilitati, invia questo comando:

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

Gestisci i tag sui risultati delle osservazioni

Per elencare i tag già aggiunti ai risultati:

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

Per gestire i tag:

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

Disabilita un job di osservazione

Questa richiesta disabilita un job di osservazione senza eliminarlo.

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

Elimina un job di osservazione

Questa richiesta elimina un job di osservazione.

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

Elimina un'origine di osservazione

Questa richiesta elimina un'origine di osservazione.

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