Penemuan API Bayangan: API pengelolaan

Ringkasan

Halaman ini menyediakan sintaksis referensi untuk mengelola Apigee Shadow API Discovery dari Apigee Management API (APIM). Dokumentasi untuk Management API yang terkait dengan Shadow API Discovery, termasuk informasi di 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 tentang Shadow API Discovery dan petunjuk untuk mengelolanya menggunakan UI Apigee di Konsol Cloud, lihat Penemuan Shadow API. Informasi tentang perilaku umum dan batasan Penemuan Shadow API dapat ditemukan 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 observasi untuk informasi selengkapnya tentang masing-masing 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 observasi

Membuat tugas observasi memerlukan beberapa langkah/permintaan API.

  1. Buat sumber observasi: Untuk membuat sumber observasi baru, bukan menggunakan sumber yang sudah ada, buat permintaan POST ke endpoint observasiSources 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}"
      }
    ]
  }
}
    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. Buat tugas observasi: 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"
  ]
}

Mengaktifkan tugas observasi

Gunakan perintah berikut untuk mengaktifkan tugas pengamatan baru atau tugas lama 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'
{
}

Lihat 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

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 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 akan menghapus sumber observasi.

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