Shadow API Discovery: management APIs

סקירה כללית

בדף הזה מפורט תחביר לדוגמה לניהול של Apigee Shadow API Discovery מתוך ממשקי Apigee Management (APIM). מסמכי התיעוד של ממשקי ה-API לניהול שקשורים לזיהוי של Shadow API, כולל מידע על כל שדה בבקשה, זמינים בכתובות https://cloud.google.com/apigee/docs/reference/apis/apim/rest ו-https://cloud.google.com/apigee/docs/reference/apis/apim/rpc.

סקירה כללית על Shadow API Discovery והוראות לניהול התכונה באמצעות ממשק המשתמש של Apigee במסוף Cloud זמינות במאמר בנושא Shadow API Discovery. מידע על ההתנהגויות והמגבלות הכלליות של Shadow API Discovery מופיע במאמר התנהגויות ומגבלות.

פרמטרים בקריאות ל-API של הפניה

קריאות ה-API בדף הזה יכולות להשתמש בפרמטרים הבאים, שמתייחסים לפרטי חשבון Apigee (כמו הפרויקט) או למידע שמשמש ליצירת משימות תצפית. מידע נוסף על כל אחד מהשדות האלה זמין במאמר בנושא יצירת משימות תצפית.

‫OBSERVATION_JOB_LOCATION הוא מיקום של משרה לבדיקה.
‫OBSERVATION_JOB_NAME הוא שם של משימת תצפית.
‫OBSERVATION_SOURCE_LOCATION הוא מיקום המקור של משימת התצפית.
‫OBSERVATION_SOURCE_NAME הוא שם של מקור תצפיות.
‫PROJECT הוא פרויקט Apigee.

יצירת משימת תצפית

יצירת משימת תצפית דורשת כמה שלבים או בקשות API.

יצירת מקור תצפיות: כדי ליצור מקור תצפיות חדש במקום להשתמש במקור קיים, שולחים בקשת POST לנקודת הקצה 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

יצירת מקור תצפית נמשכת כמה דקות ומתחילה LRO, עם תגובה כזו:

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

כדי לראות את מקור התצפיות החדש שנוצר:

curl \
https://apim.googleapis.com/v1alpha/projects/PROJECT/locations/OBSERVATION_SOURCE_LOCATION/observationSources/OBSERVATION_SOURCE_NAME

יצירת משימת תצפית: יוצרים משימה שמחפשת ממשקי API נסתרים באמצעות המקור שיצרתם זה עתה:

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

הפעלת משימת תצפית

כדי להפעיל משימת תצפית חדשה או משימה קיימת שהושבתה, משתמשים בפקודה הבאה.

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

צפייה בממשקי API שזוהו

כדי להציג ממשקי API שהתגלו על ידי משימות תצפית מופעלות, שולחים את הפקודה הבאה:

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

ניהול תגים בתוצאות של תצפיות

כדי להציג את התגים שכבר נוספו לתוצאות:

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

כדי לנהל תגים:

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

השבתת משימת תצפית

הבקשה הזו משביתה משימת תצפית בלי למחוק אותה.

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

מחיקת משימת תצפית

הבקשה הזו מוחקת משימת תצפית.

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

מחיקה של מקור תצפית

הבקשה הזו מוחקת מקור תצפיות.

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

Shadow API Discovery: management APIs קל לארגן דפים בעזרת אוספים אפשר לשמור ולסווג תוכן על סמך ההעדפות שלך.