Rilevamento API shadow: API di gestione

Panoramica

Questa pagina fornisce la sintassi di riferimento per la gestione del rilevamento delle API Shadow di Apigee dalle API di gestione di Apigee (APIM). La documentazione delle API di gestione relative al rilevamento delle API Shadow, incluse le informazioni su ogni campo di una richiesta, è disponibile 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 del rilevamento delle API Shadow e istruzioni per la gestione tramite l'interfaccia utente di Apigee in Cloud Console, vedi Rilevamento delle API Shadow. Le informazioni sui comportamenti e sulle limitazioni generali del rilevamento delle API Shadow sono disponibili in Comportamenti e limitazioni.

Parametri nelle chiamate API di riferimento

Le chiamate API in questa pagina possono utilizzare i seguenti parametri, che fanno riferimento alle informazioni del tuo account Apigee (ad esempio il tuo progetto) o alle informazioni utilizzate durante la creazione dei job di osservazione. Per ulteriori informazioni su ciascuno di questi campi, vedi 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 località di origine per il job di osservazione.
  • OBSERVATION_SOURCE_NAME è il nome di un'origine di osservazione.
  • PROJECT è il tuo progetto Apigee.

Creare 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 alla seguente: 
    {
"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 di 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 l'origine appena creata: 
    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

Abilitare un job di osservazione

Utilizza il seguente comando 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

Visualizzare 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

Gestire i tag nei risultati dell'osservazione

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

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

Eliminare 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

Eliminare 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