Shadow API Discovery: Verwaltungs-APIs

Übersicht

Auf dieser Seite finden Sie die Referenzsyntax für die Verwaltung von Apigee Shadow API Discovery über die Apigee Management APIs (APIM). Die Dokumentation zu den Management-APIs für Shadow API Discovery, einschließlich Informationen zu den einzelnen Feldern in einer Anfrage, finden Sie unter https://cloud.google.com/apigee/docs/reference/apis/apim/rest und https://cloud.google.com/apigee/docs/reference/apis/apim/rpc.

Eine Übersicht über Shadow API Discovery und eine Anleitung zur Verwaltung über die Apigee-UI in der Cloud Console finden Sie unter Shadow API Discovery. Informationen zum allgemeinen Verhalten und zu den Einschränkungen von Shadow API Discovery finden Sie unter Verhalten und Einschränkungen.

Parameter in Referenz-API-Aufrufen

Für die API-Aufrufe auf dieser Seite können die folgenden Parameter verwendet werden, die sich entweder auf Ihre Apigee-Kontoinformationen (z. B. Ihr Projekt) oder auf Informationen beziehen, die beim Erstellen von Beobachtungsjobs verwendet werden. Weitere Informationen zu den einzelnen Feldern finden Sie unter Beobachtungsjobs erstellen.

  • OBSERVATION_JOB_LOCATION ist ein Speicherort für einen Beobachtungsjob.
  • OBSERVATION_JOB_NAME ist der Name eines Beobachtungsjobs.
  • OBSERVATION_SOURCE_LOCATION ist ein Quellstandort für den Beobachtungsjob.
  • OBSERVATION_SOURCE_NAME ist der Name einer Beobachtungsquelle.
  • PROJECT ist Ihr Apigee-Projekt.

Beobachtungsjob erstellen

Das Erstellen eines Beobachtungsjobs erfordert mehrere Schritte/API-Anfragen.

  1. Beobachtungsquelle erstellen:Wenn Sie eine neue Beobachtungsquelle erstellen möchten, anstatt eine vorhandene zu verwenden, senden Sie eine POST-Anfrage mit den Details der Beobachtungsquelle an den Endpunkt „observationSources“.
    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
     Die Erstellung einer Beobachtungsquelle dauert einige Minuten und startet einen LRO mit einer Antwort wie dieser: 
    {
"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. So rufen Sie die neu erstellte Beobachtungsquelle auf: 
    curl \
https://apim.googleapis.com/v1alpha/projects/PROJECT/locations/OBSERVATION_SOURCE_LOCATION/observationSources/OBSERVATION_SOURCE_NAME
  3. Beobachtungsjob erstellen:Erstellen Sie einen Job, der mit der soeben erstellten Quelle nach Shadow APIs sucht: 
    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

Beobachtungsjob aktivieren

Mit dem folgenden Befehl können Sie einen neuen Beobachtungsjob oder einen deaktivierten vorhandenen Job aktivieren.

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

Erkannte APIs ansehen

Wenn Sie sich die von aktivierten Beobachtungsjobs entdeckten APIs ansehen möchten, geben Sie diesen Befehl ein:

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

Tags für Beobachtungsergebnisse verwalten

So rufen Sie eine Liste der Tags auf, die den Ergebnissen bereits hinzugefügt wurden:

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

So verwalten Sie Tags:

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

Beobachtungsjob deaktivieren

Mit dieser Anfrage wird ein Beobachtungsjob deaktiviert, ohne ihn zu löschen.

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

Beobachtungsjob löschen

Mit dieser Anfrage wird ein Beobachtungsjob gelöscht.

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

Beobachtungsquelle löschen

Mit dieser Anfrage wird eine Beobachtungsquelle gelöscht.

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