@maxim_mazurok/gapi.client.monitoring v3.0.20220806

TypeScript typings for Cloud Monitoring API v3

Manages your Cloud Monitoring data and configurations. For detailed description please check documentation.

Installing

Install typings for Cloud Monitoring API:

npm install @types/gapi.client.monitoring@v3 --save-dev

Usage

You need to initialize Google API client in your code:

gapi.load('client', () => {
  // now we can use gapi.client
  // ...
});

Then load api client wrapper:

gapi.client.load('monitoring', 'v3', () => {
  // now we can use gapi.client.monitoring
  // ...
});

Don't forget to authenticate your client before sending any request to resources:

// declare client_id registered in Google Developers Console
var client_id = '',
  scope = [ 
      // See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account.
      'https://www.googleapis.com/auth/cloud-platform',

      // View and write monitoring data for all of your Google and third-party Cloud and API projects
      'https://www.googleapis.com/auth/monitoring',

      // View monitoring data for all of your Google Cloud and third-party projects
      'https://www.googleapis.com/auth/monitoring.read',

      // Publish metric data to your Google Cloud projects
      'https://www.googleapis.com/auth/monitoring.write',
    ],
    immediate = true;
// ...

gapi.auth.authorize(
  { client_id: client_id, scope: scope, immediate: immediate },
  authResult => {
    if (authResult && !authResult.error) {
        /* handle successful authorization */
    } else {
        /* handle authorization error */
    }
});

After that you can use Cloud Monitoring API resources:

/*
Create a Service.
*/
await gapi.client.monitoring.services.create({ parent: "parent",  });

/*
Soft delete this Service.
*/
await gapi.client.monitoring.services.delete({ name: "name",  });

/*
Get the named Service.
*/
await gapi.client.monitoring.services.get({ name: "name",  });

/*
List Services for this Metrics Scope.
*/
await gapi.client.monitoring.services.list({ parent: "parent",  });

/*
Update this Service.
*/
await gapi.client.monitoring.services.patch({ name: "name",  });

/*
Returns the list of IP addresses that checkers run from
*/
await gapi.client.monitoring.uptimeCheckIps.list({  });