February 23, 2024

We’ve got an essential announcement to make – Utilization Meter and Utilization Report APIs are actually a part of the Cloud Supplier Navigator and might be accessed from the Cloud Provider part on developer.vmware.com. Moreover, there’s a new API for registering Utilization Meter with a contract within the VCPP Commerce Portal. Right here is how the Utilization API web page appears to be like like on developer.vmware.com.

On this weblog submit, we are going to exhibit the steps of registering a Utilization Meter occasion, getting data and downloading utilization stories.

Earlier than utilizing the aforementioned APIs, there are just a few stipulations that should be glad.

Stipulations

  1. A refresh token generated from Cloud Associate Navigator/Consumer Profile/API Tokens. Data might be discovered here or scroll to the Producing an Entry Token part on this weblog submit.
  2. An entry token generated from the Cloud Associate Navigator refresh token. Learn here or scroll to the Producing an Entry Token part on this weblog submit.

Observe: A generated entry token expires after half-hour so it’s worthwhile to regenerate it every now and then.

Producing an Entry Token for Authentication

To execute the API requests described on this weblog submit, you’ll need to generate a refresh token from Cloud Associate Navigator (CPN) after which execute a POST request to the Cloud Providers Portal gateway to get the entry token with which you’ll authenticate with the CPN service – Utilization Perception.

The Utilization Perception service is the service which is able to register your Utilization Meter with a contract within the Commerce Portal and generate stories for a Utilization Meter occasion.

Now let’s see how one can generate an entry token:

  1. Log in to Cloud Associate Navigator.
  2. Change to the group for which you want to register a Utilization Meter or obtain utilization stories.
  3. Below your username, click on My Account.
  4. Click on on the API Tokens tab.
  5. Within the API Tokens web page, click on GENERATE TOKEN.
  6. Copy the token and click on Proceed.

Observe: Save your refresh token someplace as you’ll need it repeatedly to generate an entry token in your utilization API calls.

  1. In your API shopper, make the next POST Request to the Cloud Associate Navigator Service Gateway to generate an entry token.

This entry token you’ll use to authenticate with Utilization Perception when sending the request for registering your Utilization Meter with a contract within the Commerce Portal.

See the pattern request and response:

Pattern cURL Code:

Observe: Exchange the refresh token with your personal generated from the CPN API Token web page.

  1. Copy the entry token from the response. Use it when executing the API requests described on this weblog submit.

Checking if a Utilization Meter occasion is registered

Earlier than registering a Utilization Meter, examine if it has already been registered with Utilization Perception.

Right here is how one can do it:

  1. Execute the next GET registration request:

  • Use the UUID of your Utilization Meter.
  • Use the generated entry token to authenticate to the service.
  1. In case your registration is profitable, you’re going to get the next response: Standing 200 OK, additionally a contract quantity, and a website identify. See the screenshot under:

Pattern cURL Code

Observe: Exchange the Utilization Meter UUID with your personal. Yow will discover it in your Utilization Meter internet software, underneath the About tab. Use the entry token you generated for the authorization.

Registering a Utilization Meter within the Commerce Portal

To register your Utilization Meter with a contract within the Commerce Portal utilizing the brand new REST API, you’ll need to authenticate with the Utilization Perception service to which to ship the registration request.

Listed here are the precise steps:

  1. Ship POST request to the Utilization Perception service, which is able to deal with the registration of the Utilization Meter occasion with a contract within the Commerce Portal.

  1. Within the physique of the request, you will need to specify the next:

  1. For the authorization with the Utilization Perception service, use the generated entry token.
  1. Execute the request. If the Utilization Meter registration is profitable, then you’re going to get code 202. See an instance under:

If this Utilization Meter has already been registered, you’re going to get code 201.

  1. Go to the VMware Commerce portal to confirm if Utilization Meter is registered with the required contract and org website.

Pattern cURL code

Observe: Use your Utilization Meter particulars an present the entry token you generated from the CPN refresh token.

Getting Data on All Utilization Experiences

Utilization report API is now dully documented and is able to be applied in your group. Listed here are the API requests that you need to use to automate your utilization report era:

  • Get data on all utilization stories for a particular month and 12 months for a corporation
  • Obtain a particular utilization report by specifying its reference quantity retrieved from the get data on all utilization stories API request
  • Lastly, get data on all stories related by a utilization meter UUID

Get Data on All Utilization Experiences for a Month

To get data on all utilization stories of all Utilization Meters in your CPN group for a specific month and 12 months, do the next:

  1. Execute GET https://ums.vmware.com/utilization/api/v1/stories/2023/1 request to the Utilization Perception service endpoint.
  2. Present the month and 12 months for which you want to get all utilization stories for all of your registered Utilization Meters.
  3. Authenticate to Utilization Perception with the generated entry token.
  4. In case your request is profitable, you’re going to get Standing 200 OK and an inventory of all utilization stories related to Utilization Meter UUID. Right here is an instance of the response.

Pattern cURL code

Observe: Specify a month and a 12 months for which to get data on all utilization stories of a CPN group.

Obtain a Particular Utilization Report

To obtain a particular Utilization Meter report, it’s worthwhile to present within the parameters of your API request the reference variety of that report. To seek out it, you want first to set off GET data on all utilization stories request. See the Getting Data on All Utilization Experiences for a Month part.

Right here is how one can obtain a particular Utilization Meter report:

1. Make a GET request to https://ums.vmware.com/utilization/api/v1/stories and specify the next:

  • Within the parameters of the request enter the reference variety of the report. This worth you will need to retrieve from the request defined within the Get Data on All Experiences for a Month part.
  • Within the header of the request, you will need to specify the Settle for parameter to be the content material kind of the report (once more get this data from the get data on all utilization stories API request)
  • Authenticate to the Utilization Perception service by utilizing the generated entry code.
  1. The response might be Standing 200 OK if the request is profitable, and also you additionally get the textual content of the zipped report. On this instance, the response just isn’t decoded as Postman does node decode the content material of zipped information.
  1. Save the response.  In Postman, the way in which to do it’s to click on Save Response. This fashion you’ll obtain the referenced report.

Pattern cURL code

Observe: Use the reference variety of the report you want to obtain the your generated entry token.

Get Data on all Experiences of a Utilization Meter Occasion

To get data on all utilization stories of a particular Utilization Meters, do the next:

  1. Execute a GET request to the Utilization Perception service, specifying the month and 12 months for which you want to get data and the uuid of the utilization meter with which the stories are related.
  1. Present the generated entry token with which to authenticate with the Utilization Perception service.
  1. You’re going to get the next response: Standing 200 OK and the small print of all stories associated to this Utilization Meter and their reference numbers.

Observe: Use the reference variety of the stories you want to obtain with the GET / https://ums.vmware.com/utilization/api/v1/stories API request.

Right here is an instance of the request and its response.

Pattern cURL Code

Observe: Specify a month and a 12 months for which to get data on all utilization stories related to the uuid of your utilization meter. Exchange the Utilization Meter UUID on this instance with your personal.

Conclusion

In a conclusion, you need to use these APIs as a part of your Utilization Meter reporting automation.  Now with the registration of the Utilization Meter occasion you possibly can totally automate the set up and configuration of your Utilization Meter cases.

We’ll preserve enhancing and increasing our Utilization Meter-related APIs and need to hear from you about what different APIs we are able to develop to enhance your reporting expertise.

The remainder of the Utilization Meter API requests might be discovered here. Cloud Associate Navigator and Commerce Portal APIs might be discovered here and here.

For extra questions or queries, depart a remark under or ship us an e-mail to [email protected]. There’s a Slack channel obtainable to cloud suppliers the place you may also ask your questions.