Penemuan API Bayangan: API pengelolaan

Ringkasan

Halaman ini menyediakan sintaksis referensi untuk mengelola Apigee Shadow API Discovery dari Apigee API Pengelolaan (APIM). Dokumentasi untuk Management API terkait Penemuan API Bayangan, termasuk informasi di setiap bidang 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 Cloud konsol, lihat Penemuan API Bayangan. Ada informasi tentang perilaku umum dan batasan Penemuan API Bayangan Perilaku dan batasan.

Parameter dalam panggilan API referensi

Panggilan API di halaman ini bisa menggunakan parameter berikut, yang merujuk pada Informasi akun Apigee (seperti project Anda) atau informasi yang digunakan saat membuat pengamatan pekerjaan. Lihat Membuat tugas observasi untuk mengetahui informasi selengkapnya tentang masing-masing kolom.

  • 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 daripada menggunakan yang sudah ada, buat permintaan POST ke endpoint pengamatanSources 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 pengamatan yang baru dibuat: 
    curl \
https://apim.googleapis.com/v1alpha/projects/PROJECT/locations/OBSERVATION_SOURCE_LOCATION/observationSources/OBSERVATION_SOURCE_NAME
  3. Buat tugas observasi: Membuat 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 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'
{}
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

Mengelola tag di hasil pengamatan

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