Manage API observations in API hub

Console

To view discovered API observations, do the following:

1. In the Google Cloud console, go to the API hub page.

   Go to API hub

2. Click API observations from the left navigation menu to open the API observations page.

The API observations page displays all the discovered API observations in your API ecosystem.

REST

To list all the discovered API observations using the DiscoveredApiObservations API, use the following API call:

curl -X GET \
  -H "Authorization: Bearer $(gcloud auth print-access-token)" \
"https://apihub.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/discoveredApiObservations"

Replace the following:

• PROJECT_ID: The name of your API hub host project. The host project was selected when API hub was provisioned.
• LOCATION: The location of the host project. The location was chosen when API hub was provisioned.

Console

To analyze a specific discovered API observation, do the following:

1. In the Google Cloud console, go to the API hub page.

   Go to API hub

2. Click API observations from the left navigation menu to open the API observations page.
3. Click the Host name of the discovered API observation that you want to analyze.

   The observation details page appears displaying the associated API metadata and API operations collected by API hub.

API operation details

The API operation details section displays the following information:

• Path: the HTTP request path for the API operation.
• Method: the HTTP request method string.
• Count: the total number of times API observations in API hub observed this operation.
• Observation: indicates if the API is Known or Unknown. You can click the observation to view its complete resource definition in API hub.
• Transaction Request: lists the key value pairs of the request headers and their count.
• Transaction Response Headers: lists the key value pairs of response headers and their count.
• Transaction Response Codes: lists the key value pairs of response codes and their count.
• First Seen: the timestamp when the API operation was first observed.
• Last Seen: The timestamp when this API operation was last .

REST

To analyze a specific discovered API observation, do the following:

• To retrieve detailed information for a specific discovered API observation, use the following API call:

      curl -X GET \
        -H "Authorization: Bearer $(gcloud auth print-access-token)" \
      "https://apihub.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/discoveredApiObservations/OBSERVATION_ID
      

  Replace the following:

  • PROJECT_ID: The name of your API hub host project. The host project was selected when API hub was provisioned.
  • LOCATION: The location of the host project. The location was chosen when API hub was provisioned.
  • OBSERVATION_ID: The ID of the discovered API observation.
• To retrieve a list of all the API operations in a specific discovered API observation, use the following API call:

        curl -X GET \
          -H "Authorization: Bearer $(gcloud auth print-access-token)" \
        "https://apihub.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/discoveredApiObservations/OBSERVATION_ID/discoveredApiOperations"
        

  Replace the following:

  • PROJECT_ID: The name of your API hub host project. The host project was selected when API hub was provisioned.
  • LOCATION: The location of the host project. The location was chosen when API hub was provisioned.
  • OBSERVATION_ID: The ID of the discovered API observation.
• To retrieve detailed information for a specific API operation, use the following API call:

        curl -X GET \
          -H "Authorization: Bearer $(gcloud auth print-access-token)" \
        "https://apihub.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/discoveredApiObservations/OBSERVATION_ID/discoveredApiOperations/OPERATION_ID"
        

  Replace the following:

  • PROJECT_ID: The name of your API hub host project. The host project was selected when API hub was provisioned.
  • LOCATION: The location of the host project. The location was chosen when API hub was provisioned.
  • OBSERVATION_ID: The ID of the discovered API observation.
  • OPERATION_ID: The ID of the API operation.