Penemuan Shadow API: API pengelolaan

Ringkasan

Halaman ini menyediakan sintaksis referensi untuk mengelola Penemuan API Bayangan Apigee dari API Pengelolaan Apigee (APIM). Dokumentasi untuk Management API yang terkait dengan 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 ringkasan Penemuan Shadow API dan petunjuk untuk mengelolanya menggunakan UI Apigee di Cloud Console, 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 pada informasi akun Apigee Anda (seperti project Anda) atau informasi yang digunakan saat membuat tugas pengamatan. Lihat Membuat tugas pengamatan untuk mengetahui informasi selengkapnya tentang setiap kolom ini.

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

Membuat tugas pengamatan

Membuat tugas pengamatan memerlukan beberapa langkah/permintaan API.

  1. Buat sumber pengamatan: Untuk membuat sumber pengamatan baru, bukan menggunakan sumber pengamatan yang sudah ada, buat permintaan POST ke endpoint observationSources dengan detail sumber pengamatan.
    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 pengamatan 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 pengamatan yang baru dibuat: 
    curl \
https://apim.googleapis.com/v1alpha/projects/PROJECT/locations/OBSERVATION_SOURCE_LOCATION/observationSources/OBSERVATION_SOURCE_NAME
  3. Buat tugas pengamatan: Buat tugas yang mencari API bayangan menggunakan sumber yang baru saja 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 pengamatan

Gunakan perintah berikut untuk mengaktifkan tugas pengamatan baru atau tugas yang ada yang 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 pengamatan 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 pengamatan

Untuk mencantumkan tag yang telah 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 pengamatan

Permintaan ini menonaktifkan tugas pengamatan 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 pengamatan

Permintaan ini akan menghapus tugas pengamatan.

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

Menghapus sumber pengamatan

Permintaan ini akan menghapus sumber pengamatan.

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