Penemuan Shadow API: API pengelolaan

Ringkasan

Halaman ini menyediakan sintaksis referensi untuk mengelola Penemuan Shadow API Apigee dari Apigee Management (APIM) API. Dokumentasi untuk Management API terkait Penemuan Shadow API, termasuk informasi tentang setiap kolom dalam permintaan, dapat ditemukan di https://cloud.google.com/apigee/docs/reference/apis/apim/rest dan https://cloud.google.com/apigee/docs/reference/apis/apim/rpc

Untuk mengetahui ringkasan Penemuan Shadow API dan petunjuk untuk mengelolanya menggunakan UI Apigee di Cloud konsol, lihat Penemuan Shadow API. Informasi tentang perilaku dan batasan umum Penemuan Shadow API ada di Perilaku dan batasan.

Parameter dalam panggilan API referensi

Panggilan API di halaman ini dapat menggunakan parameter berikut, yang merujuk ke informasi akun Apigee Anda (seperti project Anda) atau informasi yang digunakan saat membuat tugas observasi. Lihat Membuat tugas observasi untuk mengetahui informasi selengkapnya tentang setiap kolom ini.

  • OBSERVATION_JOB_LOCATION adalah lokasi untuk tugas observasi.
  • OBSERVATION_JOB_NAME adalah nama tugas observasi.
  • OBSERVATION_SOURCE_LOCATION adalah lokasi sumber untuk tugas observasi.
  • OBSERVATION_SOURCE_NAME adalah nama sumber observasi.
  • PROJECT adalah project Apigee Anda.

Membuat tugas observasi

Membuat tugas observasi memerlukan beberapa langkah/permintaan API.

  1. Membuat sumber observasi: Untuk membuat sumber observasi baru, bukan menggunakan sumber yang ada, buat permintaan POST ke endpoint observationSources dengan detail sumber observasi.
    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
     Pembuatan sumber observasi memerlukan waktu beberapa menit dan memulai LRO, dengan respons seperti ini: 
    {
"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. Untuk melihat sumber observasi yang baru dibuat: 
    curl \
https://apim.googleapis.com/v1alpha/projects/PROJECT/locations/OBSERVATION_SOURCE_LOCATION/observationSources/OBSERVATION_SOURCE_NAME
  3. Membuat tugas observasi: Buat tugas yang mencari shadow API menggunakan sumber yang baru Anda buat: 
    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

Mengaktifkan tugas observasi

Gunakan perintah berikut untuk mengaktifkan tugas observasi baru atau tugas yang ada dan dinonaktifkan.

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

Melihat API yang ditemukan

Untuk melihat API yang ditemukan oleh tugas observasi yang diaktifkan, kirimkan perintah ini:

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

Mengelola tag pada hasil observasi

Untuk mencantumkan tag yang sudah ditambahkan ke hasil:

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

Untuk mengelola 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

Menonaktifkan tugas observasi

Permintaan ini menonaktifkan tugas observasi tanpa menghapusnya.

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

Menghapus tugas observasi

Permintaan ini menghapus tugas observasi.

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

Menghapus sumber observasi

Permintaan ini menghapus sumber observasi.

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