gcp-metadata
Get the metadata from a Google Cloud Platform environment.
$ npm install --save gcp-metadataconst gcpMetadata = require('gcp-metadata');Check to see if the metadata server is available
const isAvailable = await gcpMetadata.isAvailable();Access all metadata
const data = await gcpMetadata.instance();
console.log(data); // ... All metadata propertiesAccess specific properties
const data = await gcpMetadata.instance('hostname');
console.log(data); // ...Instance hostname
const projectId = await gcpMetadata.project('project-id');
console.log(projectId); // ...Project ID of the running instanceAccess nested properties with the relative path
const data = await gcpMetadata.instance('service-accounts/default/email');
console.log(data); // ...Email address of the Compute identity service accountAccess specific properties with query parameters
const data = await gcpMetadata.instance({
property: 'tags',
params: { alt: 'text' }
});
console.log(data) // ...Tags as newline-delimited listAccess with custom headers
await gcpMetadata.instance({
headers: { 'no-trace': '1' }
}); // ...Request is untracedTake care with large number valued properties
In some cases number valued properties returned by the Metadata Service may be
too large to be representable as JavaScript numbers. In such cases we return
those values as BigNumber objects (from the bignumber.js library). Numbers
that fit within the JavaScript number range will be returned as normal number
values.
const id = await gcpMetadata.instance('id');
console.log(id) // ... BigNumber { s: 1, e: 18, c: [ 45200, 31799277581759 ] }
console.log(id.toString()) // ... 4520031799277581759