1 of 13

OpsNow Developer Guide

About

This document introduces the official API of opsnow.io

At opsnow.io, we're committed to simplifying the complexities of modern cloud infrastructure. Our CMP(Cloud Management Platform) stands at the forefront of this mission, providing unparalleled tools and insights for businesses.

Why opsnow.io?

Cost Savings: Explore complex cloud costs and find cost-saving opportunities.
Resource Management: Ensure visibility and control over cloud resources. Monitor and manage resources to optimize your cloud environment.
Intuitive API: This document guides developers through powerful APIs to provide integrations and automations for cloud management. With clear instructions and examples, developers can easily and quickly leverage all the features of the opsnow.io platform.

We're delighted to have you here, and we're confident that our platform will drive efficiency, clarity, and scalability for your cloud operations.

Endpoint

Endpoints Overview

Domain

api.opsnow.io

Each service URL is composed with the hostname to form the endpoint of each API.

Service Endpoint

Platform

/platform

Purpose

The Platform endpoint focuses on the overall management of the opsnow.io service.

It encompasses a wide range of configuration tasks for the site, from user management to adjustments for various services.

Key Features

User Management: Add, modify, or remove users and assign roles and permissions.
Service Settings:Configure and adjust settings related to the opsnow.io service.
Insights with Platform Analytics: Understand user interactions, platform usage, and other essential metrics.

Resources

/asset

Purpose

The Resources endpoint is designed for the overall management of cloud resources. It provides services to users who want to track, update, or configure cloud resources.

Key Features

Resource List: Provides a list of in-use resources within the cloud.
Resource Details: Offers detailed information about a specific resource.
Resource Optimization: Allows the removal of unnecessary resources and optimization of the cloud environment..

Authentication

This article describes the authentication method of opsnow.io's API.

All requests to the API require authentication.

opsnow.io uses a Bearer token for this purpose. Include the token in the request header as follows:

For security reasons, keep the access token confidential.

Avoid hardcoding it directly into the application or exposing it in client-side scripts.

User Authentication Method

opsnow.io issues an API key after the user authentication process during the login. Subsequently, you can obtain an access token to make API calls.

Step 1. Request for API Key Issuance

Access the service and request the issuance of an API Key.
The requested user information is verified, and an API Key will be issued.

Step 2. Request for Access Token Issuance

Using the API Key obtained in Step 1, request for access token issuance.
If the request for access token issuance is processed successfully, the access token and its expiration time (3600s) are returned.

Step 3. API Call

With the access token obtained in Step 2, you can use opsnow.io's actual API.
The issued access token follows the Bearer token method, explicitly stating the Bearer string and transmitting the access token.
If the access token's validity period expires, access token reissuance is necessary.

Errors

opsnow.io uses standard HTTP response codes to indicate the success or failure of API requests. Typically, they are as follows:

1. 2xx: Success

2. 4xx: Client Error

Indicates inaccurate or incomplete parameters.

code

description

400

Bad Request: Used when the client's request is malformed or invalid.

401

Unauthorized: Used when the client is not authenticated or when the authentication token has expired.

404

Not Found: Used when the requested resource is not present on the server.

405

Method Not Allowed: Used when attempting to access a resource with an unsupported HTTP method.

429

Too Many Requests: Used when the client has sent too many requests within a given time frame, typically indicating exceeding request limits.

3. 5xx: Server Error

Indicates that there is an error on the opsnow.io server.

code

description

500

Internal Server Error: Used when an internal server error occurs. Specific details about the cause should be checked in the server logs.

503

Service Unavailable: Used when the server is temporarily unable to handle the request. This could occur, for example, when the server is overloaded or undergoing maintenance.

504

Gateway Timeout: Used when the server, acting as a gateway or proxy, did not receive a timely response from the upstream server.

opsnow.io also outputs error messages and error codes in JSON format.

{
    "status": "fail",
    "error": {
        "code": 401,
        "message": "Unauthorized"
    }
}

Rate Limiting

To ensure optimal performance and fairness, we provide rate limits.

Standard users can make a maximum of 1000 requests per hour.

If more access is required, please contact us at contact@opsnow.io to upgrade your limits.

API reference

API Reference

Welcome to api.opsnow.io API Reference. Our API is built with the purpose of streamlining cloud operations and is categorized into three main sections: asset, cost, and platform. Each of these endpoints is designed to offer developers a robust set of tools for seamless cloud management.

Platform

Company APIs

Cloud Account - AWS APIs

Cloud Account - Azure APIs

Cloud Account - GCP APIs

Cost

Anomaly History APIs

Anomaly Overview APIs

Anomaly Rules APIs

Cost Analytics APIs

Cost Analytics Filters APIs

Overview APIs

Resources

Common APIs

Elastic Search Filter APIs

Optimization Detail V3 APIs

Optimization Setting V3 APIs

Resource Optimization APIs

Resource Usage APIs

AutoSavings

AutoSavings Account APIs

Integrated(User & AutoSavings) Coverage APIs

Integrated(User & AutoSavings) Inventory APIs

Integrated(User & AutoSavings) Utilization APIs

Commitment

AWS Recommendation APIs

AWS Reserved Instance Inventory APIs

AWS Reserved Instance utilization APIs

AWS Savings Plans Inventory APIs

AWS Savings Plans utilization APIs

AWS commitment utilization APIs

Azure Recommendation APIs

GCP CUD(Committed Use Discount) Inventory APIs

GCP CUD(Committed Use Discount) utilization APIs

GCP Coverage APIs

GCP Recommendation APIs

Cost

Anomaly History APIs

Anomaly detection history

View abnormal cost detection history list

POSThttps://api.opsnow.io/cost/v3/billing/anomaly/history/list

Authorization

Body

siteCode*site code

site code

Example: "BESPIN"

companyId*company id

company id

Example: "1"

userIduser id

user id

Example: "abcd"

analyzeBy*analyze by

Abnormal Cost Analysis Type

Example: "account"

analyzeType*analyze type

Abnormal Cost AI/Manual Type

Example: "manual"

Response

Body

statusAPI Response Status

API Response Status

Example: "success"

errorAPI Response of Error

API Response of Error

codeError Code

Error Code

OKVENDOR_UNSUPPORTEDMISSING_DATE_TYPE_PARAMTIMEFRAME_UNSUPPORTEDTIMEFRAME_MISMATCHEDMISSING_REQUIRED_PARAMETERINCORRECT_FORMATTED_DATE_PARAMETERWIDGET_OF_VENDOR_UNSUPPORTEDVIEW_BY_UNSUPPORTEDPATH_VARIABLE_UNSUPPORTEDUNAUTHORIZED_AS_NO_ACCOUNT_AUTHNOT_SUPPORT_ALERT_TYPENO_DATA_COLLECTEDCA_FILTER_NAME_ALREADY_EXISTCA_FILTER_PARSE_FAILCA_DETAIL_FILTER_PARSE_FAILCA_CHECK_FILTER_FAILCA_GET_SUB_FILTER_INFO_FAILCA_FILTER_DATA_PROCESS_FAILCA_DATA_PROCESS_FAILNO_QUERY_ID_MATCHEDNO_CA_FILTER_NAME_EXISTOVERVIEW_DATA_PROCESS_FAILRECIPIENT_INQUIRY_AND_PROCESSING_FAILTEMPLATE_NOT_FOUNDENCRYPT_DECRYPT_FAILNO_BEAN_PRESENTAUTO_SPOT_API_USER_C_ERRORACC_NOT_EXISTACC_ALREADY_EXISTORG_ID_DIFFERENTERROR_SPOT_API_ACCERROR_SPOT_API_ASSIGNCREATE_EXTERNAL_ID_FAILGCP_CREDENTIALS_NOT_SUFFICIENTGET_PORTAL_ACCOUNT_FAILMISSING_ACC_SEQ_OR_IDMISSING_SBSC_SEQ_OR_IDMISSING_COMPANY_IDUN_HANDLED_ERROR

messageError Message

Error Message

Example: "Error Message"

Request

Response

Anomaly detection history detailed total daily grid list

View ai/manual abnormal cost detection daily grid data

POSThttps://api.opsnow.io/cost/v3/billing/anomaly/history/detail/{analyzeType}/grid

Authorization

Path parameters

analyzeType*string

Analyze Type

Example: "ai"

Body

siteCode*site code

site code

Example: "BESPIN"

companyId*company id

company id

Example: "1"

userIduser id

user id

Example: "abcd"

histSeq*History Seq

History Seq

Example: 0

ruleSeq*Anomaly Rule Seq

Anomaly Rule Seq

Example: 0

Response

Body

statusAPI Response Status

API Response Status

Example: "success"

errorAPI Response of Error

API Response of Error

codeError Code

Error Code

messageError Message

Error Message

Example: "Error Message"

Request

Response

Anomaly detection history detailed notification result

View abnormal cost detection notification sent history

POSThttps://api.opsnow.io/cost/v3/billing/anomaly/history/detail/sent

Authorization

Body

siteCode*site code

site code

Example: "BESPIN"

companyId*company id

company id

Example: "1"

userIduser id

user id

Example: "abcd"

histSeq*History Seq

History Seq

Example: 0

ruleSeq*Anomaly Rule Seq

Anomaly Rule Seq

Example: 0

Response

Body

statusAPI Response Status

API Response Status

Example: "success"

errorAPI Response of Error

API Response of Error

codeError Code

Error Code

messageError Message

Error Message

Example: "Error Message"

Request

Response

Anomaly detection history detail result and period chart

View abnormal cost detection history details and pie chart data

POSThttps://api.opsnow.io/cost/v3/billing/anomaly/history/detail/result

Authorization

Body

siteCode*site code

site code

Example: "BESPIN"

companyId*company id

company id

Example: "1"

userIduser id

user id

Example: "abcd"

histSeq*History Seq

History Seq

Example: 0

ruleSeq*Anomaly Rule Seq

Anomaly Rule Seq

Example: 0

Response

Body

statusAPI Response Status

API Response Status

Example: "success"

errorAPI Response of Error

API Response of Error

codeError Code

Error Code

messageError Message

Error Message

Example: "Error Message"

Request

Response

Manual anomaly detection history detail result and period chart

View manual abnormal cost detection history details and pie chart data inquiry

POSThttps://api.opsnow.io/cost/v3/billing/anomaly/history/detail/manual/period-chart

Authorization

Body

siteCode*site code

site code

Example: "BESPIN"

companyId*company id

company id

Example: "1"

userIduser id

user id

Example: "abcd"

histSeq*History Seq

History Seq

Example: 0

ruleSeq*Anomaly Rule Seq

Anomaly Rule Seq

Example: 0

Response

Body

statusAPI Response Status

API Response Status

Example: "success"

errorAPI Response of Error

API Response of Error

codeError Code

Error Code

messageError Message

Error Message

Example: "Error Message"

Request

Response

Anomaly Overview APIs

Trend of anomaly detection by AI

View the trend of cost anomalies detected by AI.

POSThttps://api.opsnow.io/cost/v3/billing/anomaly/vendors/{vendor}/detections/ai/trend

Authorization

Path parameters

vendor*string

Vendor

Example: "AWS"

Body

siteCode*site code

site code

Example: "BESPIN"

companyId*company id

company id

Example: "1"

companyNamecompany name

company name

Example: "1"

defaultVendor*default vendor

default vendor

Example: "AWS"

userEmailuser email

user email

Example: "abcd@bespingloba.com"

userIduser id

user id

Example: "abcd"

userNameuser name

user name

Example: "abcd"

vendor*vendor

vendor

Example: "AWS"

sensitivity*Sensitivity

Sensitivity

Example: "M"

forecastDtForecast Date

Forecast Date

Example: "2024-06-02"

Response

Body

statusAPI Response Status

API Response Status

Example: "success"

errorAPI Response of Error

API Response of Error

codeError Code

Error Code

messageError Message

Error Message

Example: "Error Message"

Request

Response

Cost trend of cloud usage

View the cost trend of cloud usage.

POSThttps://api.opsnow.io/cost/v3/billing/anomaly/vendors/{vendor}/dashboard/trend

Authorization

Path parameters

vendor*string

Vendor

Example: "AWS"

Body

siteCode*site code

site code

Example: "BESPIN"

companyId*company id

company id

Example: "1"

companyNamecompany name

company name

Example: "1"

defaultVendor*default vendor

default vendor

Example: "AWS"

userEmailuser email

user email

Example: "abcd@bespingloba.com"

userIduser id

user id

Example: "abcd"

userNameuser name

user name

Example: "abcd"

vendorvendor

vendor

Example: "AWS"

vendorsList of vendors

List of vendors

itemsList of vendors

List of vendors

selectedVendorsByWidget*Selected Vendors by Widget

Selected Vendors by Widget

itemsSelected Vendors by Widget

Selected Vendors by Widget

Example: "[\"AWS\"]"

viewType*View Type

View Type

Example: "account"

widgetType*Component Type

Component Type

Example: "dashboard_compare_cost_trend_widget"

dateTypeWidget Date Type

Widget Date Type

Example: "monthly"

dataTypeWidget Date Type ( Opsnow Console > Cost widget > dataType key value)

Widget Date Type (etc. monthly, weekly, daily)

Example: "monthly, weekly, daily"

timeFrame*Time Frame

Time Frame

Example: "last_3_months"

viewBy*View By

View By(account,product,region)

Example: "account"

filterFilter Type

Filter Type(top_10_by_cost / custom)

Example: "top_10_by_cost"

customFilterCustom Filter

Custom Filter

vendorstring

itemstring

selectedAccountSelected Account Filter

Selected Account Filter

Example: "000000000000"

selectedAccountsSelected Accounts Filter

Selected Accounts Filter

itemsSelected Accounts Filter

Selected Accounts Filter

itemSelected Items Filter

Selected Items Filter

itemsSelected Items Filter

Selected Items Filter

selectedTagKeySelected Tag Key Filter

Selected Tag Key Filter

Example: "Name"

selectedServiceGroupSetSelected Service Group Set Filter

Selected Service Group Set Filter

Example: "00000000-0000-0000-0000-000000000000"

widgetCurrencyWidget Selected Currency

Widget Selected Currency

sensitivitySensitivity value for a specific widget

Sensitivity value for a specific widget

Example: "M"

analyzedDtAnalysis date

Analysis date

Example: "2024-06-02"

Response

Body

statusAPI Response Status

API Response Status

Example: "success"

errorAPI Response of Error

API Response of Error

codeError Code

Error Code

messageError Message

Error Message

Example: "Error Message"

Request

Response

Potential anomalous usage data detected by AI

View the usage data that may lead to ai-predicted anomalous costs

POSThttps://api.opsnow.io/cost/v3/billing/anomaly/vendors/{vendor}/anomaly/aiPossibleCause

Authorization

Path parameters

vendor*string

Vendor

Example: "AWS"

Body

siteCode*site code

site code

Example: "BESPIN"

companyId*company id

company id

Example: "1"

companyNamecompany name

company name

Example: "1"

defaultVendor*default vendor

default vendor

Example: "AWS"

userEmailuser email

user email

Example: "abcd@bespingloba.com"

userIduser id

user id

Example: "abcd"

userNameuser name

user name

Example: "abcd"

vendorvendor

vendor

Example: "AWS"

selectedVendorsByWidget*Selected Vendors by Widget

Selected Vendors by Widget

itemsSelected Vendors by Widget

Selected Vendors by Widget

Example: "[\"AWS\",\"GCP\"]"

sensitivity*Sensitivity

Sensitivity

Example: "M"

forecastDate*Forecast Date

Forecast Date

Example: "2024-09-23"

Response

Body

statusAPI Response Status

API Response Status

Example: "success"

errorAPI Response of Error

API Response of Error

codeError Code

Error Code

messageError Message

Error Message

Example: "Error Message"

Request

Response

Summary of detected anomalies

View the number of triggered alerts and abnormal cost information by cloud vendor and type.

POSThttps://api.opsnow.io/cost/v3/billing/anomaly/vendors/aggregate

Authorization

Body

siteCode*site code

site code

Example: "BESPIN"

companyId*company id

company id

Example: "1"

userIduser id

user id

Example: "abcd"

vendors*List of vendors

List of vendors

itemsList of vendors

List of vendors

Example: "[\"AWS\"]"

Response

Body

statusAPI Response Status

API Response Status

Example: "success"

errorAPI Response of Error

API Response of Error

codeError Code

Error Code

messageError Message

Error Message

Example: "Error Message"

Request

Response

Summary of detected anomalies

View the number of triggered alerts and abnormal cost information by cloud vendor and type.

POSThttps://api.opsnow.io/cost/v3/billing/anomaly/vendors/{vendor}/aggregate

Authorization

Path parameters

vendor*string

Vendor

Example: "AWS"

Body

siteCode*site code

site code

Example: "BESPIN"

companyId*company id

company id

Example: "1"

userIduser id

user id

Example: "abcd"

vendors*List of vendors

List of vendors

itemsList of vendors

List of vendors

Example: "[\"AWS\"]"

Response

Body

statusAPI Response Status

API Response Status

Example: "success"

errorAPI Response of Error

API Response of Error

codeError Code

Error Code

messageError Message

Error Message

Example: "Error Message"

Request

Response

Anomaly Rules APIs

Create/Update an anomaly detection rule setting

Create or update the setting of anomaly detection rule.

PUThttps://api.opsnow.io/cost/v3/billing/anomaly/vendors/detections/alerts/rule/setting

Authorization

Body

siteCode*site code

site code

Example: "BESPIN"

companyId*company id

company id

Example: "1"

companyNamecompany name

company name

Example: "1"

defaultVendor*default vendor

default vendor

Example: "AWS"

userEmailuser email

user email

Example: "abcd@bespingloba.com"

userIduser id

user id

Example: "abcd"

userNameuser name

user name

Example: "abcd"

vendorvendor

vendor

Example: "AWS"

seqAnomaly Rule Seq

Anomaly Rule Seq

Example: 0

nameAnomaly Rule Name

Anomaly Rule Name

Example: "Name"

analyzeType*Analyze Type

Abnormal Cost AI/Manual Type

Example: "manual"

analyzeBy*Analyze By

Abnormal Cost Analysis Type

Example: "account"

sensitivity*Sensitivity

Sensitivity

Example: "M"

thValThreshold value

Threshold value

Example: 1

thOptThreshold detection options

Threshold detection options(percentage/amount)

Example: "percentage"

alertStatusAlarm Setting Status

Alarm Setting Status(active/inactive)

Example: "inactive"

alertFreqAlarm Frequency

Alarm Frequency(daily, weekly)

Example: "daily"

alertOptAlarm Option

Alarm Option(only, all)

Example: "only"

receiversAlarm recipients

Alarm recipients

useYnAlarm Enabled

Alarm Enabled

Example: "Y"

forecastDtForecast Date

Forecast Date

Example: "2024-06-02"

analyzedDtAnalysis date

Analysis date

Example: "2024-06-02"

viewByView By

View By

Example: "account"

Response

Body

statusAPI Response Status

API Response Status

Example: "success"

errorAPI Response of Error

API Response of Error

codeError Code

Error Code

messageError Message

Error Message

Example: "Error Message"

Request

Response

Anomaly detection rules

View the rules for detecting anomalies and sending alerts.

POSThttps://api.opsnow.io/cost/v3/billing/anomaly/vendors/detections/alerts/rule

Authorization

Body

siteCode*site code

site code

Example: "BESPIN"

companyId*company id

company id

Example: "1"

companyNamecompany name

company name

Example: "1"

defaultVendor*default vendor

default vendor

Example: "AWS"

userEmailuser email

user email

Example: "abcd@bespingloba.com"

userIduser id

user id

Example: "abcd"

userNameuser name

user name

Example: "abcd"

vendorvendor

vendor

Example: "AWS"

Response

Body

statusAPI Response Status

API Response Status

Example: "success"

errorAPI Response of Error

API Response of Error

codeError Code

Error Code

messageError Message

Error Message

Example: "Error Message"

Request

Response

Specific anomaly detection rule

View the specific rule for detecting anomalies and sending alerts.

POSThttps://api.opsnow.io/cost/v3/billing/anomaly/vendors/detections/alerts/rule/{seq}

Authorization

Path parameters

seq*integer (int32)

Rule Seq

Example: 0

Body

siteCode*site code

site code

Example: "BESPIN"

companyId*company id

company id

Example: "1"

companyNamecompany name

company name

Example: "1"

defaultVendor*default vendor

default vendor

Example: "AWS"

userEmailuser email

user email

Example: "abcd@bespingloba.com"

userIduser id

user id

Example: "abcd"

userNameuser name

user name

Example: "abcd"

vendorvendor

vendor

Example: "AWS"

seqAnomaly Rule Seq

Anomaly Rule Seq

Example: 0

Response

Body

statusAPI Response Status

API Response Status

Example: "success"

errorAPI Response of Error

API Response of Error

codeError Code

Error Code

messageError Message

Error Message

Example: "Error Message"

Request

Response

Cost Analytics APIs

Detail of cost analytics

View detailed portion chart data of cost analytics

POSThttps://api.opsnow.io/cost/v3/billing/analytics/daily-portion

Authorization

Body

siteCode*site code

site code

Example: "BESPIN"

companyId*company id

company id

Example: "1"

userIduser id

user id

Example: "abcd"

selectedVendor*selected vendor

Example: "AWS"

costDate*cost date

Example: "2019-08-12"

startDate*start date

Example: "2023-02-01"

endDate*end date

Example: "2024-02-12"

viewBy*view by

Example: "account"

viewByIdviewById

viewByItem*viewByItem

Example: "216093335544"

itemViewId*itemViewId

Example: "216093335544"

filters*Cost Analytics Filters

Cost Analytics Filters

awsAwsCostAnalyticsFilter (object)

linkedAccountIdarray of string

itemsstring

productCodearray of string

itemsstring

regionarray of string

itemsstring

productFamilyarray of string

itemsstring

tagsarray of Tag (object)

tagKeystring

tagValuestring

serviceGrouparray of ServiceGroup (object)

serviceGroupKeystring

serviceGroupValuestring

serviceGroupSetNmstring

serviceGroupSetIdstring

serviceGroupNmstring

serviceGroupIdstring

dfltYnstring

instanceTypearray of string

itemsstring

instanceTypeFamilyarray of string

itemsstring

chargeTypearray of string

itemsstring

osarray of string

itemsstring

databasearray of string

itemsstring

transferTypearray of string

itemsstring

purchaseOptionarray of string

itemsstring

apiOperationarray of string

itemsstring

resourceIdarray of string

itemsstring

usageTypearray of string

itemsstring

invoiceIdarray of string

itemsstring

itemDescriptionarray of string

itemsstring

cacheEnginearray of string

itemsstring

availabilityZonearray of string

itemsstring

platformarray of string

itemsstring

azureAzureCostAnalyticsFilter (object)

linkedAccountIdarray of string

itemsstring

productCodearray of string

itemsstring

regionarray of string

itemsstring

productFamilyarray of string

itemsstring

tagsarray of Tag (object)

tagKeystring

tagValuestring

serviceGrouparray of ServiceGroup (object)

serviceGroupKeystring

serviceGroupValuestring

serviceGroupSetNmstring

serviceGroupSetIdstring

serviceGroupNmstring

serviceGroupIdstring

dfltYnstring

subscriptionNmarray of string

itemsstring

subscriptionIdarray of string

itemsstring

infraTypearray of string

itemsstring

mtCategoryarray of string

itemsstring

mtNamearray of string

itemsstring

usagearray of string

itemsstring

unitPricearray of string

itemsstring

totalCostarray of string

itemsstring

gcpGcpCostAnalyticsFilter (object)

linkedAccountIdarray of string

itemsstring

productCodearray of string

itemsstring

regionarray of string

itemsstring

productFamilyarray of string

itemsstring

tagsarray of Tag (object)

tagKeystring

tagValuestring

serviceGrouparray of ServiceGroup (object)

serviceGroupKeystring

serviceGroupValuestring

serviceGroupSetNmstring

serviceGroupSetIdstring

serviceGroupNmstring

serviceGroupIdstring

dfltYnstring

detailFilters*Detail Filters

Detail Filters

linkedAccountIdarray of string

itemsstring

productCodearray of string

itemsstring

regionarray of string

itemsstring

usageTypearray of string

itemsstring

visibleFields*VisibleFields of detail grid

VisibleFields of detail grid

itemsVisibleFields of detail grid

VisibleFields of detail grid

Example: "[\"vendor\",\"linkedAccountId\",\"productName\",\"region\",\"usage\",\"cost\",\"usageType\"]"

tagsTags Filter

Tags Filter

tagKeystring

tagValuestring

isMonthly*monthly

Example: false

Response

Body

statusAPI Response Status

API Response Status

Example: "success"

errorAPI Response of Error

API Response of Error

codeError Code

Error Code

messageError Message

Error Message

Example: "Error Message"

Request

Response

Detail of cost analytics

View detailed grid of cost analytics

POSThttps://api.opsnow.io/cost/v3/billing/analytics/daily-cost

Authorization

Body

siteCode*site code

site code

Example: "BESPIN"

companyId*company id

company id

Example: "1"

userIduser id

user id

Example: "abcd"

selectedVendor*selected vendor

Example: "AWS"

costDate*cost date

Example: "2019-08-12"

startDate*start date

Example: "2023-02-01"

endDate*end date

Example: "2024-02-12"

viewBy*view by

Example: "account"

viewByIdviewById

viewByItem*viewByItem

Example: "216093335544"

itemViewId*itemViewId

Example: "216093335544"

filters*Cost Analytics Filters

Cost Analytics Filters

awsAwsCostAnalyticsFilter (object)

linkedAccountIdarray of string

itemsstring

productCodearray of string

itemsstring

regionarray of string

itemsstring

productFamilyarray of string

itemsstring

tagsarray of Tag (object)

tagKeystring

tagValuestring

serviceGrouparray of ServiceGroup (object)

serviceGroupKeystring

serviceGroupValuestring

serviceGroupSetNmstring

serviceGroupSetIdstring

serviceGroupNmstring

serviceGroupIdstring

dfltYnstring

instanceTypearray of string

itemsstring

instanceTypeFamilyarray of string

itemsstring

chargeTypearray of string

itemsstring

osarray of string

itemsstring

databasearray of string

itemsstring

transferTypearray of string

itemsstring

purchaseOptionarray of string

itemsstring

apiOperationarray of string

itemsstring

resourceIdarray of string

itemsstring

usageTypearray of string

itemsstring

invoiceIdarray of string

itemsstring

itemDescriptionarray of string

itemsstring

cacheEnginearray of string

itemsstring

availabilityZonearray of string

itemsstring

platformarray of string

itemsstring

azureAzureCostAnalyticsFilter (object)

linkedAccountIdarray of string

itemsstring

productCodearray of string

itemsstring

regionarray of string

itemsstring

productFamilyarray of string

itemsstring

tagsarray of Tag (object)

tagKeystring

tagValuestring

serviceGrouparray of ServiceGroup (object)

serviceGroupKeystring

serviceGroupValuestring

serviceGroupSetNmstring

serviceGroupSetIdstring

serviceGroupNmstring

serviceGroupIdstring

dfltYnstring

subscriptionNmarray of string

itemsstring

subscriptionIdarray of string

itemsstring

infraTypearray of string

itemsstring

mtCategoryarray of string

itemsstring

mtNamearray of string

itemsstring

usagearray of string

itemsstring

unitPricearray of string

itemsstring

totalCostarray of string

itemsstring

gcpGcpCostAnalyticsFilter (object)

linkedAccountIdarray of string

itemsstring

productCodearray of string

itemsstring

regionarray of string

itemsstring

productFamilyarray of string

itemsstring

tagsarray of Tag (object)

tagKeystring

tagValuestring

serviceGrouparray of ServiceGroup (object)

serviceGroupKeystring

serviceGroupValuestring

serviceGroupSetNmstring

serviceGroupSetIdstring

serviceGroupNmstring

serviceGroupIdstring

dfltYnstring

detailFilters*Detail Filters

Detail Filters

linkedAccountIdarray of string

itemsstring

productCodearray of string

itemsstring

regionarray of string

itemsstring

usageTypearray of string

itemsstring

visibleFields*VisibleFields of detail grid

VisibleFields of detail grid

itemsVisibleFields of detail grid

VisibleFields of detail grid

Example: "[\"vendor\",\"linkedAccountId\",\"productName\",\"region\",\"usage\",\"cost\",\"usageType\"]"

tagsTags Filter

Tags Filter

tagKeystring

tagValuestring

isMonthly*monthly

Example: false

Response

Body

statusAPI Response Status

API Response Status

Example: "success"

errorAPI Response of Error

API Response of Error

codeError Code

Error Code

messageError Message

Error Message

Example: "Error Message"

Request

Response

Summary of cost analytics

View summary of cost analytics

POSThttps://api.opsnow.io/cost/v3/billing/analytics/cost

Authorization

Body

siteCode*site code

site code

Example: "BESPIN"

companyId*company id

company id

Example: "1"

userIduser id

user id

Example: "abcd"

startDate*start date

start date

Example: "2023-02-01"

endDate*end date

end date

Example: "2024-02-12"

itemsPerPage*items per page

items per page

Example: 30

page*page number

page number

Example: 1

userNameuser name

user name

Example: "abcd"

viewBy*view by

view by

Example: "account"

selectedVendors*selected vendors

selected vendors

itemsselected vendors

selected vendors

Example: "[\"AWS\"]"

filters*Cost Analytics Filters

Cost Analytics Filters

awsAwsCostAnalyticsFilter (object)

linkedAccountIdarray of string

itemsstring

productCodearray of string

itemsstring

regionarray of string

itemsstring

productFamilyarray of string

itemsstring

tagsarray of Tag (object)

tagKeystring

tagValuestring

serviceGrouparray of ServiceGroup (object)

serviceGroupKeystring

serviceGroupValuestring

serviceGroupSetNmstring

serviceGroupSetIdstring

serviceGroupNmstring

serviceGroupIdstring

dfltYnstring

instanceTypearray of string

itemsstring

instanceTypeFamilyarray of string

itemsstring

chargeTypearray of string

itemsstring

osarray of string

itemsstring

databasearray of string

itemsstring

transferTypearray of string

itemsstring

purchaseOptionarray of string

itemsstring

apiOperationarray of string

itemsstring

resourceIdarray of string

itemsstring

usageTypearray of string

itemsstring

invoiceIdarray of string

itemsstring

itemDescriptionarray of string

itemsstring

cacheEnginearray of string

itemsstring

availabilityZonearray of string

itemsstring

platformarray of string

itemsstring

azureAzureCostAnalyticsFilter (object)

linkedAccountIdarray of string

itemsstring

productCodearray of string

itemsstring

regionarray of string

itemsstring

productFamilyarray of string

itemsstring

tagsarray of Tag (object)

tagKeystring

tagValuestring

serviceGrouparray of ServiceGroup (object)

serviceGroupKeystring

serviceGroupValuestring

serviceGroupSetNmstring

serviceGroupSetIdstring

serviceGroupNmstring

serviceGroupIdstring

dfltYnstring

subscriptionNmarray of string

itemsstring

subscriptionIdarray of string

itemsstring

infraTypearray of string

itemsstring

mtCategoryarray of string

itemsstring

mtNamearray of string

itemsstring

usagearray of string

itemsstring

unitPricearray of string

itemsstring

totalCostarray of string

itemsstring

gcpGcpCostAnalyticsFilter (object)

linkedAccountIdarray of string

itemsstring

productCodearray of string

itemsstring

regionarray of string

itemsstring

productFamilyarray of string

itemsstring

tagsarray of Tag (object)

tagKeystring

tagValuestring

serviceGrouparray of ServiceGroup (object)

serviceGroupKeystring

serviceGroupValuestring

serviceGroupSetNmstring

serviceGroupSetIdstring

serviceGroupNmstring

serviceGroupIdstring

dfltYnstring

isMonthly*monthly

monthly

Example: false

Response

Body

statusAPI Response Status

API Response Status

Example: "success"

errorAPI Response of Error

API Response of Error

codeError Code

Error Code

messageError Message

Error Message

Example: "Error Message"

Request

Response

Cost Analytics Filters APIs

View Cost Analytics filter

POSThttps://api.opsnow.io/cost/v3/billing/analytics/related

Authorization

Body

siteCode*site code

site code

Example: "BESPIN"

companyId*company id

company id

Example: "1"

userIduser id

user id

Example: "abcd"

conditions*Cost Analytics Filters

Cost Analytics Filters

awsAwsCostAnalyticsFilter (object)

linkedAccountIdarray of string

itemsstring

productCodearray of string

itemsstring

regionarray of string

itemsstring

productFamilyarray of string

itemsstring

tagsarray of Tag (object)

tagKeystring

tagValuestring

serviceGrouparray of ServiceGroup (object)

serviceGroupKeystring

serviceGroupValuestring

serviceGroupSetNmstring

serviceGroupSetIdstring

serviceGroupNmstring

serviceGroupIdstring

dfltYnstring

instanceTypearray of string

itemsstring

instanceTypeFamilyarray of string

itemsstring

chargeTypearray of string

itemsstring

osarray of string

itemsstring

databasearray of string

itemsstring

transferTypearray of string

itemsstring

purchaseOptionarray of string

itemsstring

apiOperationarray of string

itemsstring

resourceIdarray of string

itemsstring

usageTypearray of string

itemsstring

invoiceIdarray of string

itemsstring

itemDescriptionarray of string

itemsstring

cacheEnginearray of string

itemsstring

availabilityZonearray of string

itemsstring

platformarray of string

itemsstring

azureAzureCostAnalyticsFilter (object)

linkedAccountIdarray of string

itemsstring

productCodearray of string

itemsstring

regionarray of string

itemsstring

productFamilyarray of string

itemsstring

tagsarray of Tag (object)

tagKeystring

tagValuestring

serviceGrouparray of ServiceGroup (object)

serviceGroupKeystring

serviceGroupValuestring

serviceGroupSetNmstring

serviceGroupSetIdstring

serviceGroupNmstring

serviceGroupIdstring

dfltYnstring

subscriptionNmarray of string

itemsstring

subscriptionIdarray of string

itemsstring

infraTypearray of string

itemsstring

mtCategoryarray of string

itemsstring

mtNamearray of string

itemsstring

usagearray of string

itemsstring

unitPricearray of string

itemsstring

totalCostarray of string

itemsstring

gcpGcpCostAnalyticsFilter (object)

linkedAccountIdarray of string

itemsstring

productCodearray of string

itemsstring

regionarray of string

itemsstring

productFamilyarray of string

itemsstring

tagsarray of Tag (object)

tagKeystring

tagValuestring

serviceGrouparray of ServiceGroup (object)

serviceGroupKeystring

serviceGroupValuestring

serviceGroupSetNmstring

serviceGroupSetIdstring

serviceGroupNmstring

serviceGroupIdstring

dfltYnstring

startDate*Cost Analytics inquiry start date

Cost Analytics inquiry start date

Example: "2024-09-01"

endDate*Cost Analytics inquiry end date

Cost Analytics inquiry end date

Example: "2024-09-30"

viewByView By

View By

Example: "account"

fieldFilter query category

Filter query category

Example: "platform"

selectedKeySelected Key

Selected Key

Example: "test"

searchTextSearch Text

Search Text

Example: "test"

selectedVendors*selected vendors

selected vendors

itemsselected vendors

selected vendors

Example: "[\"AWS\"]"

Response

Body

statusAPI Response Status

API Response Status

Example: "success"

errorAPI Response of Error

API Response of Error

codeError Code

Error Code

messageError Message

Error Message

Example: "Error Message"

Request

Response

Filter of Cost Analytics

View Cost Analytics filter

POSThttps://api.opsnow.io/cost/v3/billing/analytics/filter

Authorization

Body

siteCode*site code

site code

Example: "BESPIN"

companyId*company id

company id

Example: "1"

userIduser id

user id

Example: "abcd"

conditions*Cost Analytics Filters

Cost Analytics Filters

awsAwsCostAnalyticsFilter (object)

linkedAccountIdarray of string

itemsstring

productCodearray of string

itemsstring

regionarray of string

itemsstring

productFamilyarray of string

itemsstring

tagsarray of Tag (object)

tagKeystring

tagValuestring

serviceGrouparray of ServiceGroup (object)

serviceGroupKeystring

serviceGroupValuestring

serviceGroupSetNmstring

serviceGroupSetIdstring

serviceGroupNmstring

serviceGroupIdstring

dfltYnstring

instanceTypearray of string

itemsstring

instanceTypeFamilyarray of string

itemsstring

chargeTypearray of string

itemsstring

osarray of string

itemsstring

databasearray of string

itemsstring

transferTypearray of string

itemsstring

purchaseOptionarray of string

itemsstring

apiOperationarray of string

itemsstring

resourceIdarray of string

itemsstring

usageTypearray of string

itemsstring

invoiceIdarray of string

itemsstring

itemDescriptionarray of string

itemsstring

cacheEnginearray of string

itemsstring

availabilityZonearray of string

itemsstring

platformarray of string

itemsstring

azureAzureCostAnalyticsFilter (object)

linkedAccountIdarray of string

itemsstring

productCodearray of string

itemsstring

regionarray of string

itemsstring

productFamilyarray of string

itemsstring

tagsarray of Tag (object)

tagKeystring

tagValuestring

serviceGrouparray of ServiceGroup (object)

serviceGroupKeystring

serviceGroupValuestring

serviceGroupSetNmstring

serviceGroupSetIdstring

serviceGroupNmstring

serviceGroupIdstring

dfltYnstring

subscriptionNmarray of string

itemsstring

subscriptionIdarray of string

itemsstring

infraTypearray of string

itemsstring

mtCategoryarray of string

itemsstring

mtNamearray of string

itemsstring

usagearray of string

itemsstring

unitPricearray of string

itemsstring

totalCostarray of string

itemsstring

gcpGcpCostAnalyticsFilter (object)

linkedAccountIdarray of string

itemsstring

productCodearray of string

itemsstring

regionarray of string

itemsstring

productFamilyarray of string

itemsstring

tagsarray of Tag (object)

tagKeystring

tagValuestring

serviceGrouparray of ServiceGroup (object)

serviceGroupKeystring

serviceGroupValuestring

serviceGroupSetNmstring

serviceGroupSetIdstring

serviceGroupNmstring

serviceGroupIdstring

dfltYnstring

startDate*Cost Analytics inquiry start date

Cost Analytics inquiry start date

Example: "2024-09-01"

endDate*Cost Analytics inquiry end date

Cost Analytics inquiry end date

Example: "2024-09-30"

viewByView By

View By

Example: "account"

fieldFilter query category

Filter query category

Example: "platform"

selectedKeySelected Key

Selected Key

Example: "test"

searchTextSearch Text

Search Text

Example: "test"

selectedVendors*selected vendors

selected vendors

itemsselected vendors

selected vendors

Example: "[\"AWS\"]"

Response

Body

statusAPI Response Status

API Response Status

Example: "success"

errorAPI Response of Error

API Response of Error

codeError Code

Error Code

messageError Message

Error Message

Example: "Error Message"

Request

Response

Category of cost analytics

View Category of cost analytics

POSThttps://api.opsnow.io/cost/v3/billing/analytics/filter/category

Authorization

Body

siteCode*site code

site code

Example: "BESPIN"

companyId*company id

company id

Example: "1"

userIduser id

user id

Example: "abcd"

conditions*Cost Analytics Filters

Cost Analytics Filters

awsAwsCostAnalyticsFilter (object)

linkedAccountIdarray of string

itemsstring

productCodearray of string

itemsstring

regionarray of string

itemsstring

productFamilyarray of string

itemsstring

tagsarray of Tag (object)

tagKeystring

tagValuestring

serviceGrouparray of ServiceGroup (object)

serviceGroupKeystring

serviceGroupValuestring

serviceGroupSetNmstring

serviceGroupSetIdstring

serviceGroupNmstring

serviceGroupIdstring

dfltYnstring

instanceTypearray of string

itemsstring

instanceTypeFamilyarray of string

itemsstring

chargeTypearray of string

itemsstring

osarray of string

itemsstring

databasearray of string

itemsstring

transferTypearray of string

itemsstring

purchaseOptionarray of string

itemsstring

apiOperationarray of string

itemsstring

resourceIdarray of string

itemsstring

usageTypearray of string

itemsstring

invoiceIdarray of string

itemsstring

itemDescriptionarray of string

itemsstring

cacheEnginearray of string

itemsstring

availabilityZonearray of string

itemsstring

platformarray of string

itemsstring

azureAzureCostAnalyticsFilter (object)

linkedAccountIdarray of string

itemsstring

productCodearray of string

itemsstring

regionarray of string

itemsstring

productFamilyarray of string

itemsstring

tagsarray of Tag (object)

tagKeystring

tagValuestring

serviceGrouparray of ServiceGroup (object)

serviceGroupKeystring

serviceGroupValuestring

serviceGroupSetNmstring

serviceGroupSetIdstring

serviceGroupNmstring

serviceGroupIdstring

dfltYnstring

subscriptionNmarray of string

itemsstring

subscriptionIdarray of string

itemsstring

infraTypearray of string

itemsstring

mtCategoryarray of string

itemsstring

mtNamearray of string

itemsstring

usagearray of string

itemsstring

unitPricearray of string

itemsstring

totalCostarray of string

itemsstring

gcpGcpCostAnalyticsFilter (object)

linkedAccountIdarray of string

itemsstring

productCodearray of string

itemsstring

regionarray of string

itemsstring

productFamilyarray of string

itemsstring

tagsarray of Tag (object)

tagKeystring

tagValuestring

serviceGrouparray of ServiceGroup (object)

serviceGroupKeystring

serviceGroupValuestring

serviceGroupSetNmstring

serviceGroupSetIdstring

serviceGroupNmstring

serviceGroupIdstring

dfltYnstring

startDate*Cost Analytics inquiry start date

Cost Analytics inquiry start date

Example: "2024-09-01"

endDate*Cost Analytics inquiry end date

Cost Analytics inquiry end date

Example: "2024-09-30"

viewByView By

View By

Example: "account"

fieldFilter query category

Filter query category

Example: "platform"

selectedKeySelected Key

Selected Key

Example: "test"

searchTextSearch Text

Search Text

Example: "test"

selectedVendors*selected vendors

selected vendors

itemsselected vendors

selected vendors

Example: "[\"AWS\"]"

Response

Body

statusAPI Response Status

API Response Status

Example: "success"

errorAPI Response of Error

API Response of Error

codeError Code

Error Code

messageError Message

Error Message

Example: "Error Message"

Request

Response

Overview APIs

Cloud cost overview

View cloud costs from the previous period and the estimated costs for the current month.

POSThttps://api.opsnow.io/cost/v3/billing/overview/spend

Authorization

Body

siteCode*site code

site code

Example: "BESPIN"

companyId*company id

company id

Example: "1"

companyNamecompany name

company name

Example: "1"

defaultVendor*default vendor

default vendor

Example: "AWS"

userEmailuser email

user email

Example: "abcd@bespingloba.com"

userIduser id

user id

Example: "abcd"

userNameuser name

user name

Example: "abcd"

vendorvendor

vendor

Example: "AWS"

selectedVendor*selected Vendor

selected Vendor

Example: "AWS"

Response

Body

statusAPI Response Status

API Response Status

Example: "success"

errorAPI Response of Error

API Response of Error

codeError Code

Error Code

messageError Message

Error Message

Example: "Error Message"

Request

Response

Latest cost collection date

View the latest cloud costs collection date of each vendor.

POSThttps://api.opsnow.io/cost/v3/billing/overview/companyMaxDate

Authorization

Body

siteCode*site code

site code

Example: "BESPIN"

companyId*company id

company id

Example: "1"

companyNamecompany name

company name

Example: "1"

defaultVendor*default vendor

default vendor

Example: "AWS"

userEmailuser email

user email

Example: "abcd@bespingloba.com"

userIduser id

user id

Example: "abcd"

userNameuser name

user name

Example: "abcd"

vendorvendor

vendor

Example: "AWS"

Response

Body

statusAPI Response Status

API Response Status

Example: "success"

errorAPI Response of Error

API Response of Error

codeError Code

Error Code

messageError Message

Error Message

Example: "Error Message"

Request

Response

Cloud account status

View cloud accounts and status from specific vendor

POSThttps://api.opsnow.io/cost/v3/billing/overview/accounts

Authorization

Body

siteCode*site code

site code

Example: "BESPIN"

companyId*company id

company id

Example: "1"

userIduser id

user id

Example: "abcd"

vendor*vendor

vendor

Example: "AWS"

Response

Body

statusAPI Response Status

API Response Status

Example: "success"

errorAPI Response of Error

API Response of Error

codeError Code

Error Code

messageError Message

Error Message

Example: "Error Message"

Request

Response

Resources

Common APIs

POSThttps://api.opsnow.io/asset/us-v1/{menu}/{vendor}/grid-headers/{viewType}

Authorization

Path parameters

menu*string

Example: "usage"

vendor*string

vendor

Example: "aws"

viewType*string

view type

Example: "history"

Body

cmpnId*Company id

Company id

Example: "1"

rsrcTypeResource Type

Resource Type

Example: "ec2"

vendorVendor

Vendor

Example: "aws"

viewTypeView Type

View Type(current, history)

Example: "history"

menuMenu

Example: "usage"

Response

Body

statusstring

errorErrorModel (object)

codestring

messagestring

Request

const response = await fetch('https://api.opsnow.io/asset/us-v1/{menu}/{vendor}/grid-headers/{viewType}', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer <token>",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "cmpnId": "1"
    }),
});
const data = await response.json();

Response

{
  "status": "text",
  "error": {
    "code": "text",
    "message": "text"
  }
}

Elastic Search Filter APIs

Filter Data Quick Search For Usage

View Filter Data Quick Search For Usage

PUThttps://api.opsnow.io/asset/us-v1/elastic/filter/{menuId}

Authorization

Path parameters

menuId*string

Menu Id

Example: "usage"

Body

cmpnId*Company id

Company id

Example: "1"

actionType*Action Type

Action Type(current, history)

Example: "current"

keyList*ES Search Key List

ES Search Key List

vndr*Vendor

Vendor

Example: "aws"

key*ES Key

ES Key

Example: "vendors"

value*ES Value

ES Value

Example: "aws"

selectYnSelected or not

Selected or not

Example: "enabled"

Response

Body

resultQuickSearchFilterModel (object)

vendorsarray of ES Search Key List

vndr*Vendor

Vendor

Example: "aws"

key*ES Key

ES Key

Example: "vendors"

value*ES Value

ES Value

Example: "aws"

selectYnSelected or not

Selected or not

Example: "enabled"

accountsarray of ES Search Key List

vndr*Vendor

Vendor

Example: "aws"

key*ES Key

ES Key

Example: "vendors"

value*ES Value

ES Value

Example: "aws"

selectYnSelected or not

Selected or not

Example: "enabled"

regionsarray of ES Search Key List

vndr*Vendor

Vendor

Example: "aws"

key*ES Key

ES Key

Example: "vendors"

value*ES Value

ES Value

Example: "aws"

selectYnSelected or not

Selected or not

Example: "enabled"

productsarray of ES Search Key List

vndr*Vendor

Vendor

Example: "aws"

key*ES Key

ES Key

Example: "vendors"

value*ES Value

ES Value

Example: "aws"

selectYnSelected or not

Selected or not

Example: "enabled"

svcGrpsarray of ES Search Key List

vndr*Vendor

Vendor

Example: "aws"

key*ES Key

ES Key

Example: "vendors"

value*ES Value

ES Value

Example: "aws"

selectYnSelected or not

Selected or not

Example: "enabled"

tagsarray of KeyValueTagModel (object)

vndrVendor

Vendor

Example: "aws"

keyTag Key

Tag Key

Example: "Name"

valueTag Value

Tag Value

Example: "test"

statusstring

errorErrorModel (object)

codestring

messagestring

Request

const response = await fetch('https://api.opsnow.io/asset/us-v1/elastic/filter/{menuId}', {
    method: 'PUT',
    headers: {
      "Authorization": "Bearer <token>",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "actionType": "current",
      "cmpnId": "1",
      "keyList": [
        {
          "key": "vendors",
          "value": "aws",
          "vndr": "aws"
        }
      ]
    }),
});
const data = await response.json();

Response

{
  "result": {
    "vendors": [
      {
        "vndr": "aws",
        "key": "vendors",
        "value": "aws",
        "selectYn": "enabled"
      }
    ],
    "accounts": [
      {
        "vndr": "aws",
        "key": "vendors",
        "value": "aws",
        "selectYn": "enabled"
      }
    ],
    "regions": [
      {
        "vndr": "aws",
        "key": "vendors",
        "value": "aws",
        "selectYn": "enabled"
      }
    ],
    "products": [
      {
        "vndr": "aws",
        "key": "vendors",
        "value": "aws",
        "selectYn": "enabled"
      }
    ],
    "svcGrps": [
      {
        "vndr": "aws",
        "key": "vendors",
        "value": "aws",
        "selectYn": "enabled"
      }
    ],
    "tags": [
      {
        "vndr": "aws",
        "key": "Name",
        "value": "test"
      }
    ]
  },
  "status": "text",
  "error": {
    "code": "text",
    "message": "text"
  }
}

Optimization Detail V3 APIs

Optimization Grid View

Grid detail data inquiry according to optimization category and resource type

POSThttps://api.opsnow.io/asset/us-v1/optimization/detail/list/info

Authorization

Body

cmpnId*Company id

Company id

Example: "1"

optimizeCategory*Optimization category

right-sizingunused

accountId*Account Id

Example: "000000000000"

regionId*Region Id

Example: "ap-northeast-2"

instanceId*Instance Id

Example: "vol-00000"

resourceType*Resource type

Example: "ebs"

vendor*Cloud vendor

Example: "aws"

awsazugcpalincpociopenstack

recommend*Recommend Type

Example: "idle"

Response

Body

statusstring

errorErrorModel (object)

codestring

messagestring

Request

const response = await fetch('https://api.opsnow.io/asset/us-v1/optimization/detail/list/info', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer <token>",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "accountId": "000000000000",
      "cmpnId": "1",
      "instanceId": "vol-00000",
      "optimizeCategory": "right-sizing",
      "recommend": "idle",
      "regionId": "ap-northeast-2",
      "resourceType": "ebs",
      "vendor": "aws"
    }),
});
const data = await response.json();

Response

{
  "status": "text",
  "error": {
    "code": "text",
    "message": "text"
  }
}

Optimization Grid View

Grid data inquiry according to optimization category and resource type

POSThttps://api.opsnow.io/asset/us-v1/optimization/detail/list

Authorization

Body

cmpnId*Company id

Company id

Example: "1"

optimizeCategory*Optimization category

Optimization category

right-sizingunused

resourceType*Resource type

Resource type

Example: "ec2"

vendor*Cloud vendor

Cloud vendor

awsazugcpalincpociopenstack

accountListList of accounts to filter optimization results for

List of accounts to filter optimization results for

itemsList of accounts to filter optimization results for

List of accounts to filter optimization results for

regionListList of regions to filter optimization results for

List of regions to filter optimization results for

itemsList of regions to filter optimization results for

List of regions to filter optimization results for

serviceGroupListList of serviceGroups to filter optimization results for

List of serviceGroups to filter optimization results for

itemsList of serviceGroups to filter optimization results for

List of serviceGroups to filter optimization results for

tagListList of tags to filter optimization results for

List of tags to filter optimization results for

keyTag Key

Tag Key

Example: "Name"

valueTag Values

Tag Values

itemsTag Values

Tag Values

Response

Body

statusstring

errorErrorModel (object)

codestring

messagestring

Request

const response = await fetch('https://api.opsnow.io/asset/us-v1/optimization/detail/list', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer <token>",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "cmpnId": "1",
      "optimizeCategory": "right-sizing",
      "resourceType": "ec2",
      "vendor": "aws"
    }),
});
const data = await response.json();

Response

{
  "status": "text",
  "error": {
    "code": "text",
    "message": "text"
  }
}

Optimization Chart View

View optimization charts by optimization category and resource type

POSThttps://api.opsnow.io/asset/us-v1/optimization/detail/chart

Authorization

Body

cmpnId*Company id

Company id

Example: "1"

optimizeCategory*Optimization category

Optimization category

right-sizingunused

resourceType*Resource type

Resource type

Example: "ec2"

vendor*Cloud vendor

Cloud vendor

awsazugcpalincpociopenstack

accountListList of accounts to filter optimization results for

List of accounts to filter optimization results for

itemsList of accounts to filter optimization results for

List of accounts to filter optimization results for

regionListList of regions to filter optimization results for

List of regions to filter optimization results for

itemsList of regions to filter optimization results for

List of regions to filter optimization results for

serviceGroupListList of serviceGroups to filter optimization results for

List of serviceGroups to filter optimization results for

itemsList of serviceGroups to filter optimization results for

List of serviceGroups to filter optimization results for

tagListList of tags to filter optimization results for

List of tags to filter optimization results for

keyTag Key

Tag Key

Example: "Name"

valueTag Values

Tag Values

itemsTag Values

Tag Values

Response

Body

statusstring

errorErrorModel (object)

codestring

messagestring

Request

const response = await fetch('https://api.opsnow.io/asset/us-v1/optimization/detail/chart', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer <token>",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "cmpnId": "1",
      "optimizeCategory": "right-sizing",
      "resourceType": "ec2",
      "vendor": "aws"
    }),
});
const data = await response.json();

Response

{
  "status": "text",
  "error": {
    "code": "text",
    "message": "text"
  }
}

Optimization Setting V3 APIs

Reset resource optimization settings conditions

Reset the optimization setting conditions for each resource by optimization category.

PUThttps://api.opsnow.io/asset/us-v1/optimization/setting/reset

Authorization

Body

cmpnId*Company id

Company id

Example: "1"

vendor*Vendor

Vendor

awsazugcpalincpociopenstack

resourceType*Resource Type

Resource Type

Example: "ec2"

optimizeCategory*Optimization category

Optimization category

Example: "right-sizing"

right-sizingunused

Response

Body

statusstring

errorErrorModel (object)

codestring

messagestring

Request

const response = await fetch('https://api.opsnow.io/asset/us-v1/optimization/setting/reset', {
    method: 'PUT',
    headers: {
      "Authorization": "Bearer <token>",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "cmpnId": "1",
      "optimizeCategory": "right-sizing",
      "resourceType": "ec2",
      "vendor": "aws"
    }),
});
const data = await response.json();

Response

{
  "status": "text",
  "error": {
    "code": "text",
    "message": "text"
  }
}

View list of support resources by optimization type

GEThttps://api.opsnow.io/asset/us-v1/optimization/setting/optimize-category/{optimizeCategory}

Authorization

Path parameters

optimizeCategory*enum

Optimization category

right-sizingunused

Response

Body

resultarray of OptimizeSettingResourceTypeModel (object)

vendorstring

resourceTypestring

resourceNamestring

statusstring

errorErrorModel (object)

codestring

messagestring

Request

const response = await fetch('https://api.opsnow.io/asset/us-v1/optimization/setting/optimize-category/{optimizeCategory}', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Response

{
  "result": [
    {
      "vendor": "text",
      "resourceType": "text",
      "resourceName": "text"
    }
  ],
  "status": "text",
  "error": {
    "code": "text",
    "message": "text"
  }
}

View list of resource optimization settings conditions

View the list of conditions that can be set according to resources by optimization category. If there are no conditions set, the default conditions are searched. Depending on the optimization type, resource type may be required.

GEThttps://api.opsnow.io/asset/us-v1/optimization/setting/companies/{cmpnId}/vendors/{vendor}/optimize-category/{optimizeCategory}/rule-sets/{ruleSetId}

Authorization

Path parameters

cmpnId*string

Company Id

Example: 1

vendor*enum

Vendor

awsazugcpalincpociopenstack

optimizeCategory*enum

Optimization category

right-sizingunused

ruleSetId*string

Rule id

Query parameters

resourceTypestring

Resource type

Example: "ec2"

Response

Body

statusstring

errorErrorModel (object)

codestring

messagestring

Request

const response = await fetch('https://api.opsnow.io/asset/us-v1/optimization/setting/companies/{cmpnId}/vendors/{vendor}/optimize-category/{optimizeCategory}/rule-sets/{ruleSetId}', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Response

{
  "status": "text",
  "error": {
    "code": "text",
    "message": "text"
  }
}

View list of resource optimization excluded tags

View the list of tags excluded from resource optimization.

GEThttps://api.opsnow.io/asset/us-v1/optimization/setting/companies/{cmpnId}/rule-sets/{ruleSetId}/deny

Authorization

Path parameters

cmpnId*string

Company unique ID

ruleSetId*string

Rule id

Example: "Default"

Response

Body

statusstring

errorErrorModel (object)

codestring

messagestring

Request

const response = await fetch('https://api.opsnow.io/asset/us-v1/optimization/setting/companies/{cmpnId}/rule-sets/{ruleSetId}/deny', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Response

{
  "status": "text",
  "error": {
    "code": "text",
    "message": "text"
  }
}

Search for optimization rule set ID of the site and company

Search for optimization rule set ID using site and company information.

GEThttps://api.opsnow.io/asset/us-v1/optimization/setting/companies/{cmpnId}/rule-set-id

Authorization

Path parameters

cmpnId*string

Company Id

Example: 1

Response

Body

dataRuleSetIdResultModel (object)

ruleSetIdstring

statusstring

errorErrorModel (object)

codestring

messagestring

Request

const response = await fetch('https://api.opsnow.io/asset/us-v1/optimization/setting/companies/{cmpnId}/rule-set-id', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Response

{
  "data": {
    "ruleSetId": "text"
  },
  "status": "text",
  "error": {
    "code": "text",
    "message": "text"
  }
}

Resource Optimization APIs

View top filter area by vendor

Search the top filter area data for each vendor.

PUThttps://api.opsnow.io/asset/us-v1/optimization/summary/filter

Authorization

Body

cmpnId*Company id

Company id

Example: "1"

actionType*Action Type

Action Type(current, history)

Example: "current"

keyList*ES Search Key List

ES Search Key List

vndr*Vendor

Vendor

Example: "aws"

key*ES Key

ES Key

Example: "vendors"

value*ES Value

ES Value

Example: "aws"

selectYnSelected or not

Selected or not

Example: "enabled"

Response

Body

dataQuickSearchFilterModel (object)

vendorsarray of ES Search Key List

vndr*Vendor

Vendor

Example: "aws"

key*ES Key

ES Key

Example: "vendors"

value*ES Value

ES Value

Example: "aws"

selectYnSelected or not

Selected or not

Example: "enabled"

accountsarray of ES Search Key List

vndr*Vendor

Vendor

Example: "aws"

key*ES Key

ES Key

Example: "vendors"

value*ES Value

ES Value

Example: "aws"

selectYnSelected or not

Selected or not

Example: "enabled"

regionsarray of ES Search Key List

vndr*Vendor

Vendor

Example: "aws"

key*ES Key

ES Key

Example: "vendors"

value*ES Value

ES Value

Example: "aws"

selectYnSelected or not

Selected or not

Example: "enabled"

productsarray of ES Search Key List

vndr*Vendor

Vendor

Example: "aws"

key*ES Key

ES Key

Example: "vendors"

value*ES Value

ES Value

Example: "aws"

selectYnSelected or not

Selected or not

Example: "enabled"

svcGrpsarray of ES Search Key List

vndr*Vendor

Vendor

Example: "aws"

key*ES Key

ES Key

Example: "vendors"

value*ES Value

ES Value

Example: "aws"

selectYnSelected or not

Selected or not

Example: "enabled"

tagsarray of KeyValueTagModel (object)

vndrVendor

Vendor

Example: "aws"

keyTag Key

Tag Key

Example: "Name"

valueTag Value

Tag Value

Example: "test"

statusstring

errorErrorModel (object)

codestring

messagestring

Request

const response = await fetch('https://api.opsnow.io/asset/us-v1/optimization/summary/filter', {
    method: 'PUT',
    headers: {
      "Authorization": "Bearer <token>",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "actionType": "current",
      "cmpnId": "1",
      "keyList": [
        {
          "key": "vendors",
          "value": "aws",
          "vndr": "aws"
        }
      ]
    }),
});
const data = await response.json();

Response

{
  "data": {
    "vendors": [
      {
        "vndr": "aws",
        "key": "vendors",
        "value": "aws",
        "selectYn": "enabled"
      }
    ],
    "accounts": [
      {
        "vndr": "aws",
        "key": "vendors",
        "value": "aws",
        "selectYn": "enabled"
      }
    ],
    "regions": [
      {
        "vndr": "aws",
        "key": "vendors",
        "value": "aws",
        "selectYn": "enabled"
      }
    ],
    "products": [
      {
        "vndr": "aws",
        "key": "vendors",
        "value": "aws",
        "selectYn": "enabled"
      }
    ],
    "svcGrps": [
      {
        "vndr": "aws",
        "key": "vendors",
        "value": "aws",
        "selectYn": "enabled"
      }
    ],
    "tags": [
      {
        "vndr": "aws",
        "key": "Name",
        "value": "test"
      }
    ]
  },
  "status": "text",
  "error": {
    "code": "text",
    "message": "text"
  }
}

Last optimization date lookup

Queries the last time resource optimization was performed.

POSThttps://api.opsnow.io/asset/us-v1/optimization/summary/last-execute

Authorization

Body

cmpnId*Company id

Company id

Example: "1"

optimizeCategory*Optimization category

Optimization category

right-sizingunused

resourceType*Resource type

Resource type

Example: "ec2"

vendor*Cloud vendor

Cloud vendor

awsazugcpalincpociopenstack

accountListList of accounts to filter optimization results for

List of accounts to filter optimization results for

itemsList of accounts to filter optimization results for

List of accounts to filter optimization results for

regionListList of regions to filter optimization results for

List of regions to filter optimization results for

itemsList of regions to filter optimization results for

List of regions to filter optimization results for

serviceGroupListList of serviceGroups to filter optimization results for

List of serviceGroups to filter optimization results for

itemsList of serviceGroups to filter optimization results for

List of serviceGroups to filter optimization results for

tagListList of tags to filter optimization results for

List of tags to filter optimization results for

keyTag Key

Tag Key

Example: "Name"

valueTag Values

Tag Values

itemsTag Values

Tag Values

Response

Body

dataLastExecuteDateResultModel (object)

lastExecuteDatestring (date-time)

statusstring

errorErrorModel (object)

codestring

messagestring

Request

const response = await fetch('https://api.opsnow.io/asset/us-v1/optimization/summary/last-execute', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer <token>",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "cmpnId": "1",
      "optimizeCategory": "right-sizing",
      "resourceType": "ec2",
      "vendor": "aws"
    }),
});
const data = await response.json();

Response

{
  "data": {
    "lastExecuteDate": "2024-12-21T16:24:44.403Z"
  },
  "status": "text",
  "error": {
    "code": "text",
    "message": "text"
  }
}

View top card area by optimization category

Search the top card area data for each optimization category.

POSThttps://api.opsnow.io/asset/us-v1/optimization/summary/card

Authorization

Body

cmpnId*Company id

Company id

Example: "1"

optimizeCategory*Optimization category

Optimization category

right-sizingunused

resourceType*Resource type

Resource type

Example: "ec2"

vendor*Cloud vendor

Cloud vendor

awsazugcpalincpociopenstack

accountListList of accounts to filter optimization results for

List of accounts to filter optimization results for

itemsList of accounts to filter optimization results for

List of accounts to filter optimization results for

regionListList of regions to filter optimization results for

List of regions to filter optimization results for

itemsList of regions to filter optimization results for

List of regions to filter optimization results for

serviceGroupListList of serviceGroups to filter optimization results for

List of serviceGroups to filter optimization results for

itemsList of serviceGroups to filter optimization results for

List of serviceGroups to filter optimization results for

tagListList of tags to filter optimization results for

List of tags to filter optimization results for

keyTag Key

Tag Key

Example: "Name"

valueTag Values

Tag Values

itemsTag Values

Tag Values

Response

Body

dataarray of OptimizeSummaryInfoModel (object)

resourceTypestring

expectedSavingCostnumber (double)

expectedSavingCountinteger (int32)

statusstring

errorErrorModel (object)

codestring

messagestring

Request

const response = await fetch('https://api.opsnow.io/asset/us-v1/optimization/summary/card', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer <token>",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "cmpnId": "1",
      "optimizeCategory": "right-sizing",
      "resourceType": "ec2",
      "vendor": "aws"
    }),
});
const data = await response.json();

Response

{
  "data": [
    {
      "resourceType": "text",
      "expectedSavingCost": 0,
      "expectedSavingCount": 0
    }
  ],
  "status": "text",
  "error": {
    "code": "text",
    "message": "text"
  }
}

Perform resource-optimized batch tasks

Perform resource-optimized batch tasks manually.

POSThttps://api.opsnow.io/asset/us-v1/optimization/general/analysis

Authorization

Body

cmpnId*Company id

Company id

Example: "1"

Response

Body

statusstring

errorErrorModel (object)

codestring

messagestring

Request

const response = await fetch('https://api.opsnow.io/asset/us-v1/optimization/general/analysis', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer <token>",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "cmpnId": "1"
    }),
});
const data = await response.json();

Response

{
  "status": "text",
  "error": {
    "code": "text",
    "message": "text"
  }
}

Resource Usage APIs

Usage History Grid Data

View History Usage Grid Data

POSThttps://api.opsnow.io/asset/us-v1/usage/{prvrCd}/grid/history

Authorization

Path parameters

prvrCd*enum

Vendor

Example: "aws"

awsazugcpalincpociopenstack

Body

cmpnId*Company id

Company id

Example: "1"

limitCntPage Limit Count

Page Limit Count

Example: 1

pageNumPage Number Count

Page Number Count

Example: 1

offsetPage Offset

Page Offset

Example: 1

totalCntPage Total Count

Page Total Count

Example: 1

from*From Date

From Date

Example: "2024-09-11"

to*To Date

To Date

Example: "2024-09-25"

sortColId*Sort Column ID

Sort Column ID

Example: "histDt"

sortDirection*Sort Direction

Sort Direction

Example: "desc"

excelYn*Whether to download Excel

Whether to download Excel

Example: "N"

rsrcType*Resource Type

Resource Type

Example: "ec2"

prvrCd*Vendor

Vendor

Example: "aws"

isGetHeaderHeader or not

Header or not

Example: "Y"

viewType*View Type

View Type(hour, day, week, month)

Example: "day"

langCdLanguage Code

Language Code

Example: "en"

hasHistoryViewWhether to check history or not

Whether to check history or not

Example: true

searchTextSearch Text

Search Text

Example: "test"

fieldListField List

Field List

itemsField List

Field List

regionsRegions

Regions

itemsRegions

Regions

svcGrpsService Groups

Service Groups

itemsService Groups

Service Groups

accountsAccounts

Accounts

itemsAccounts

Accounts

tagsTags

Tags

keyTag Key

Tag Key

Example: "Name"

valueTag Values

Tag Values

itemsTag Values

Tag Values

Response

Body

statusstring

errorErrorModel (object)

codestring

messagestring

Request

const response = await fetch('https://api.opsnow.io/asset/us-v1/usage/{prvrCd}/grid/history', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer <token>",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "cmpnId": "1",
      "excelYn": "N",
      "from": "2024-09-11",
      "prvrCd": "aws",
      "rsrcType": "ec2",
      "sortColId": "histDt",
      "sortDirection": "desc",
      "to": "2024-09-25",
      "viewType": "day"
    }),
});
const data = await response.json();

Response

{
  "status": "text",
  "error": {
    "code": "text",
    "message": "text"
  }
}

Usage Current Grid Data

View Current Usage Grid Data

POSThttps://api.opsnow.io/asset/us-v1/usage/{prvrCd}/grid/current

Authorization

Path parameters

prvrCd*enum

Vendor

Example: "aws"

awsazugcpalincpociopenstack

Body

cmpnId*Company id

Company id

Example: "1"

rgnIdRegion Id

Region Id

Example: "ap-northeast-2"

limitCntPage Limit Count

Page Limit Count

Example: 1

pageNumPage Number Count

Page Number Count

Example: 1

offsetPage Offset

Page Offset

Example: 1

totalCntPage Total Count

Page Total Count

Example: 1

sortColIdSort Column ID

Sort Column ID

Example: "seq"

sortDirectionSort Direction

Sort Direction

Example: "desc"

excelYnWhether to download Excel

Whether to download Excel

Example: "N"

rsrcType*Resource Type

Resource Type

Example: "ec2"

prvrCd*Vendor

Vendor

Example: "aws"

viewTypeView Type

View Type(hour, day, week, month)

Example: "day"

fromFrom Date

From Date

Example: "2024-09-11"

toTo Date

To Date

Example: "2024-09-25"

searchTextSearch Text

Search Text

Example: "test"

isGetHeaderHeader or not

Header or not

Example: "Y"

fieldListField List

Field List

itemsField List

Field List

regionsRegions

Regions

itemsRegions

Regions

svcGrpsService Groups

Service Groups

itemsService Groups

Service Groups

accountsAccounts

Accounts

itemsAccounts

Accounts

tagsTags

Tags

keyTag Key

Tag Key

Example: "Name"

valueTag Values

Tag Values

itemsTag Values

Tag Values

svcGrpViewService Group View Id

Service Group View Id

Example: "Default"

langCdLanguage Code

Language Code

Example: "en"

rsrcSeqResource Seq

Resource Seq

Example: "0"

headerTypeHeader Type

Header Type

Example: "single"

isResourceResource or Not

Resource or Not

Example: "N"

rsrcNmResource Name

Resource Name

Example: "test"

hasHistoryViewWhether to check history or not

Whether to check history or not

Example: true

delChkWhether to exclude deleted resources

Whether to exclude deleted resources

Example: "Y"

Response

Body

statusstring

errorErrorModel (object)

codestring

messagestring

Request

const response = await fetch('https://api.opsnow.io/asset/us-v1/usage/{prvrCd}/grid/current', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer <token>",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "cmpnId": "1",
      "prvrCd": "aws",
      "rsrcType": "ec2"
    }),
});
const data = await response.json();

Response

{
  "status": "text",
  "error": {
    "code": "text",
    "message": "text"
  }
}

Usage Current Chart Data

View Current Usage Chart Data

POSThttps://api.opsnow.io/asset/us-v1/usage/{prvrCd}/chart/pie/current

Authorization

Path parameters

prvrCd*enum

Vendor

Example: "aws"

awsazugcpalincpociopenstack

Body

cmpnId*Company id

Company id

Example: "1"

rsrcType*Resource Type

Resource Type

Example: "ec2"

prvrCd*Vendor

Vendor

Example: "aws"

rsrcNmResource Name

Resource Name

Example: "test"

regionsRegions

Regions

itemsRegions

Regions

svcGrpsService Groups

Service Groups

itemsService Groups

Service Groups

accountsAccounts

Accounts

itemsAccounts

Accounts

tagsTags

Tags

keyTag Key

Tag Key

Example: "Name"

valueTag Values

Tag Values

itemsTag Values

Tag Values

reqTypestring

delChkWhether to exclude deleted resources

Whether to exclude deleted resources

Example: "Y"

Response

Body

statusstring

errorErrorModel (object)

codestring

messagestring

Request

const response = await fetch('https://api.opsnow.io/asset/us-v1/usage/{prvrCd}/chart/pie/current', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer <token>",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "cmpnId": "1",
      "prvrCd": "aws",
      "rsrcType": "ec2"
    }),
});
const data = await response.json();

Response

{
  "status": "text",
  "error": {
    "code": "text",
    "message": "text"
  }
}

Usage History Chart Data

View History Usage Chart Data

POSThttps://api.opsnow.io/asset/us-v1/usage/{prvrCd}/chart/history

Authorization

Path parameters

prvrCd*enum

Vendor

Example: "aws"

awsazugcpalincpociopenstack

Body

cmpnId*Company id

Company id

Example: "1"

from*From Date

From Date

Example: "2024-09-11"

to*To Date

To Date

Example: "2024-09-25"

rsrcType*Resource Type

Resource Type

Example: "ec2"

prvrCd*Vendor

Vendor

Example: "aws"

regionsRegions

Regions

itemsRegions

Regions

svcGrpsService Groups

Service Groups

itemsService Groups

Service Groups

accountsAccounts

Accounts

itemsAccounts

Accounts

tagsTags

Tags

keyTag Key

Tag Key

Example: "Name"

valueTag Values

Tag Values

itemsTag Values

Tag Values

viewType*View Type

View Type(hour, day, week, month)

Example: "day"

Response

Body

statusstring

errorErrorModel (object)

codestring

messagestring

Request

const response = await fetch('https://api.opsnow.io/asset/us-v1/usage/{prvrCd}/chart/history', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer <token>",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "cmpnId": "1",
      "from": "2024-09-11",
      "prvrCd": "aws",
      "rsrcType": "ec2",
      "to": "2024-09-25",
      "viewType": "day"
    }),
});
const data = await response.json();

Response

{
  "status": "text",
  "error": {
    "code": "text",
    "message": "text"
  }
}

AutoSavings

AutoSavings Account APIs

Get AutoSavings account List

Retrieve information about the AWS account registered with the company.

GEThttps://api.opsnow.io/cost/v3/autosave/companies/{companyId}/vendors/aws/services/accounts

Authorization

Path parameters

companyId*string

Company ID

Example: 1

Query parameters

browserTimeZonestring

Browser Timezone

Example: "+09:00"

linkedAccountIdstring

Linked Account ID

Example: "'123456789011'"

linkedAccountAliasstring

Linked Account Name

Example: "'Alias equals name'"

accessTypestring

AutoSavings AWS account access type

Example: "'role-arn / access-key '"

roleArnstring

roleArn

Example: "'roleArn'"

accessKeystring

secretKeystring

tokenstring

startDatestring

endDatestring

siteRegionstring

siteRegion

Example: "'GLOBAL / CHINA'"

servicesstring

AutoSavings services subscribed to by the account

Example: "'AUTO-RI, AUTO-STORAGE, AUTO-DISK"

encryptKeystring

subscriptionStatusstring

Current AutoSavings subscription status of the account

Example: "'SUBSCRIBED'"

Response

Body

statusstring

errorError (object)

Codeinteger (int32)

Messagestring

listarray of AwsAutoSavingsAccountModel (object)

account list

companyIdstring

Company Id

Example: "1"

linkedAccountIdstring

Linked account ID

Example: "123456789012"

linkedAccountAliasstring

Linked account Name

Example: "Bespinglobal Platform"

accessTypestring

AWS API Access type

Example: "role-arn"

roleArnstring

AWS ARN

Example: "aws:arn:123456:api"

siteRegionstring

AWS site region code

Example: "GLOBAL"

deleteYnstring

AWS account delete sign

Example: "0:false / 1:true"

createDatestring

AWS account create date

Example: "'%Y-%m-%d %H:%i:%s'"

createUserstring

AWS account create user

Example: "user"

updateDatestring

AWS account update date

Example: "'%Y-%m-%d %H:%i:%s'"

updateUserstring

AWS account update user

Example: "user"

roleArnInfoAwsAutoSavingsRoleArnInformationModel (object)

Role ARN Information(Required information for cross-account registration)

cloudFormationTemplateUrlstring

externalIdstring

dataAwsAutoSavingsSiteRegionModel (object)

Site information for the selected company.

siteRegionstring

Request

Response

Get AutoSavings Account Subscription Histories

Retrieve AWS AutoSavings subscription histories

GEThttps://api.opsnow.io/cost/v3/autosave/companies/{companyId}/vendors/aws/services/accounts/subscription/histories

Authorization

Path parameters

companyId*string

Company ID

Example: 1

Query parameters

browserTimeZonestring

Browser Timezone

Example: "+09:00"

linkedAccountIdstring

Linked Account ID

Example: "'123456789011'"

linkedAccountAliasstring

Linked Account Name

Example: "'Alias equals name'"

accessTypestring

AutoSavings AWS account access type

Example: "'role-arn / access-key '"

roleArnstring

roleArn

Example: "'roleArn'"

accessKeystring

secretKeystring

tokenstring

startDatestring

endDatestring

siteRegionstring

siteRegion

Example: "'GLOBAL / CHINA'"

servicesstring

AutoSavings services subscribed to by the account

Example: "'AUTO-RI, AUTO-STORAGE, AUTO-DISK"

encryptKeystring

subscriptionStatusstring

Current AutoSavings subscription status of the account

Example: "'SUBSCRIBED'"

latestboolean

View the latest subscription information by account

Response

Body

listarray of AwsAutoSavingsAccountSubscriptionHistoryModel (object)

AutoSavings account subscription histories

linkedAccountIdstring

payerAccountIdstring

autoSavingsServicestring

subscriptionStatusstring

startDateTimestring

cancelDateTimestring

endDateTimestring

Request

Response

Get AutoSavings Account State

Retrieve registered AWS AutoSavings accounts state

GEThttps://api.opsnow.io/cost/v3/autosave/companies/{companyId}/vendors/aws/services/accounts/state

Authorization

Path parameters

companyId*string

Company ID

Example: 1

Query parameters

browserTimeZonestring

Browser Timezone

Example: "+09:00"

linkedAccountIdstring

Linked Account ID

Example: "'123456789011'"

linkedAccountAliasstring

Linked Account Name

Example: "'Alias equals name'"

accessTypestring

AutoSavings AWS account access type

Example: "'role-arn / access-key '"

roleArnstring

roleArn

Example: "'roleArn'"

accessKeystring

secretKeystring

tokenstring

startDatestring

endDatestring

siteRegionstring

siteRegion

Example: "'GLOBAL / CHINA'"

servicesstring

AutoSavings services subscribed to by the account

Example: "'AUTO-RI, AUTO-STORAGE, AUTO-DISK"

encryptKeystring

subscriptionStatusstring

Current AutoSavings subscription status of the account

Example: "'SUBSCRIBED'"

Response

Body

statusstring

errorError (object)

Codeinteger (int32)

Messagestring

dataAwsAutoSavingsAccountSubscriptionStateModel (object)

The subscription states of AutoSavings for the registered accounts.

totalCountinteger (int32)

전체 계정 수

subscriptionCountinteger (int32)

구독 계정 수

stateenum

구독 상태

NONEPARTIALALL

savingsCostnumber (double)

절감액

monthlyEstimateCostnumber (double)

예상 절감액

accountsarray of AwsAutoSavingsAccountSubscriptionModel (object)

계정 구독 현황 목록

linkedAccountIdstring

linkedAccountNamestring

autoRiSubscribedboolean

autoSpSubscribedboolean

subscribedboolean

purchaseboolean

estimatedCostnumber (double)

accountStatusstring

Request

Response

Get AutoSavings account AWS role ARN Info

Retrieve the necessary information for AWS cross-account registration.

GEThttps://api.opsnow.io/cost/v3/autosave/companies/{companyId}/vendors/aws/services/accounts/role-arn

Authorization

Path parameters

companyId*string

Company ID

Example: 1

Query parameters

browserTimeZonestring

Browser Timezone

Example: "+09:00"

linkedAccountIdstring

Linked Account ID

Example: "'123456789011'"

linkedAccountAliasstring

Linked Account Name

Example: "'Alias equals name'"

accessTypestring

AutoSavings AWS account access type

Example: "'role-arn / access-key '"

roleArnstring

roleArn

Example: "'roleArn'"

accessKeystring

secretKeystring

tokenstring

startDatestring

endDatestring

siteRegionstring

siteRegion

Example: "'GLOBAL / CHINA'"

servicesstring

AutoSavings services subscribed to by the account

Example: "'AUTO-RI, AUTO-STORAGE, AUTO-DISK"

encryptKeystring

subscriptionStatusstring

Current AutoSavings subscription status of the account

Example: "'SUBSCRIBED'"

Response

Body

statusstring

errorError (object)

Codeinteger (int32)

Messagestring

listarray of AwsAutoSavingsAccountModel (object)

account list

companyIdstring

Company Id

Example: "1"

linkedAccountIdstring

Linked account ID

Example: "123456789012"

linkedAccountAliasstring

Linked account Name

Example: "Bespinglobal Platform"

accessTypestring

AWS API Access type

Example: "role-arn"

roleArnstring

AWS ARN

Example: "aws:arn:123456:api"

siteRegionstring

AWS site region code

Example: "GLOBAL"

deleteYnstring

AWS account delete sign

Example: "0:false / 1:true"

createDatestring

AWS account create date

Example: "'%Y-%m-%d %H:%i:%s'"

createUserstring

AWS account create user

Example: "user"

updateDatestring

AWS account update date

Example: "'%Y-%m-%d %H:%i:%s'"

updateUserstring

AWS account update user

Example: "user"

roleArnInfoAwsAutoSavingsRoleArnInformationModel (object)

Role ARN Information(Required information for cross-account registration)

cloudFormationTemplateUrlstring

externalIdstring

dataAwsAutoSavingsSiteRegionModel (object)

Site information for the selected company.

siteRegionstring

Request

Response

Get AutoSavings Site Region

Retrieve Information about customer sites utilizing AWS AutoSavings.

GEThttps://api.opsnow.io/cost/v3/autosave/companies/{companyId}/vendors/aws/services/accounts/region

Authorization

Path parameters

companyId*string

Company ID

Example: 1

Query parameters

browserTimeZonestring

Browser Timezone

Example: "+09:00"

linkedAccountIdstring

Linked Account ID

Example: "'123456789011'"

linkedAccountAliasstring

Linked Account Name

Example: "'Alias equals name'"

accessTypestring

AutoSavings AWS account access type

Example: "'role-arn / access-key '"

roleArnstring

roleArn

Example: "'roleArn'"

accessKeystring

secretKeystring

tokenstring

startDatestring

endDatestring

siteRegionstring

siteRegion

Example: "'GLOBAL / CHINA'"

servicesstring

AutoSavings services subscribed to by the account

Example: "'AUTO-RI, AUTO-STORAGE, AUTO-DISK"

encryptKeystring

subscriptionStatusstring

Current AutoSavings subscription status of the account

Example: "'SUBSCRIBED'"

Response

Body

statusstring

errorError (object)

Codeinteger (int32)

Messagestring

listarray of AwsAutoSavingsAccountModel (object)

account list

companyIdstring

Company Id

Example: "1"

linkedAccountIdstring

Linked account ID

Example: "123456789012"

linkedAccountAliasstring

Linked account Name

Example: "Bespinglobal Platform"

accessTypestring

AWS API Access type

Example: "role-arn"

roleArnstring

AWS ARN

Example: "aws:arn:123456:api"

siteRegionstring

AWS site region code

Example: "GLOBAL"

deleteYnstring

AWS account delete sign

Example: "0:false / 1:true"

createDatestring

AWS account create date

Example: "'%Y-%m-%d %H:%i:%s'"

createUserstring

AWS account create user

Example: "user"

updateDatestring

AWS account update date

Example: "'%Y-%m-%d %H:%i:%s'"

updateUserstring

AWS account update user

Example: "user"

roleArnInfoAwsAutoSavingsRoleArnInformationModel (object)

Role ARN Information(Required information for cross-account registration)

cloudFormationTemplateUrlstring

externalIdstring

dataAwsAutoSavingsSiteRegionModel (object)

Site information for the selected company.

siteRegionstring

Request

Response

Integrated(User & AutoSavings) Coverage APIs

Get Savings Plans List

Get Coverage List

GEThttps://api.opsnow.io/cost/v3/autosave/companies/{companyId}/vendors/aws/services/integration/coverages

Authorization

Path parameters

companyId*string

Company ID

Example: 1

Query parameters

dateTypeenum

Date query type

Example: "DAILY"

{DAILY, MONTHLY}

startDate*string

Start Date

Example: "2020-10-01"

endDate*string

End Date

Example: "2020-10-31"

accountsstring

Linked Account IDs

Example: "['123456789011', '123456789012']"

productsstring

Products

Example: "['EC2InstanceReserved', 'ComputeReserved']"

autoRiYnstring

If retrieve only AutoRI or not

searchTypestring

Search type

Example: "All, My, AutoSavings"

commitmentServicestring

AWS commitment service type

Example: "all, savings-plans, reserved-instance"

Response

Body

statusstring

errorError (object)

Codeinteger (int32)

Messagestring

listarray of AwsCoverageModel (object)

reservedInstanceCoverageRatenumber (double)

Reserved Instance coverage

savingsPlansCoverageRatenumber (double)

Savings Plans coverage

autoRiCoverageRatenumber (double)

AutoRI coverage

autoSpCoverageRatenumber (double)

AutoSP coverage

onDemandCoverageRatenumber (double)

On-Demand coverage

reservedInstanceOnDemandCostEquivalentnumber (double)

Reserved Instance On-Demand equivalent

savingsPlansOnDemandCostEquivalentnumber (double)

Savings Plans On-Demand equivalent

autoRiOnDemandCostEquivalentnumber (double)

AutoRI On-Demand equivalent

autoSpOnDemandCostEquivalentnumber (double)

AutoSP On-Demand equivalent

onDemandCostnumber (double)

On-Demand Cost($)

totalOnDemandCostEquivalentnumber (double)

Total Cost

reservedInstanceNormalizeFactorAmountnumber (double)

Reserved Instance normalized factor amount

savingsPlansNormalizeFactorAmountnumber (double)

Savings Plans normalized factor amount

autoRiNormalizeFactorAmountnumber (double)

AutoRI normalized factor amount

autoSpNormalizeFactorAmountnumber (double)

AutoSP normalized factor amount

onDemandNormalizeFactorAmountnumber (double)

On-Demand normalized factor amount

totalNormalizeFactorAmountnumber (double)

Total normalized factor amount

reservedInstanceAmountnumber (double)

Reserved Instance usage amount

savingsPlansAmountnumber (double)

Savings Plans usage amount

autoRiAmountnumber (double)

AutoRI usage amount

autoSpAmountnumber (double)

AutoSP usage amount

onDemandAmountnumber (double)

On-Demand usage amount

totalAmountnumber (double)

Total usage amount

linkedAccountIdstring

Linked Account ID

Example: "123456789011"

linkedAccountAliasstring

Linked Account Name

Example: "Service Platform"

productCodestring

제품코드

Example: "AmazonEC2"

productNamestring

제품명

Example: "EC2"

platformstring

Platform Code

Example: "Linux"

instanceTypestring

인스턴스타입

Example: "c4.xlarge"

instanceSizestring

인스턴스사이즈

Example: "c4.xlarge"

tenancystring

Tenancy

Example: "Shared"

regionCodestring

리전 코드

Example: "ap-northeast-2"

regionNamestring

리전 이름

Example: "Asia Pacific (Seoul)"

Request

Response

Get Savings Plans Total Transition

Get Coverage Total Transition

GEThttps://api.opsnow.io/cost/v3/autosave/companies/{companyId}/vendors/aws/services/integration/coverages/time-series/{dateType}

Authorization

Path parameters

companyId*string

Company ID

Example: 1

dateType*string

Date query type

Example: "DAILY"

Query parameters

startDate*string

Start Date

Example: "2020-10-01"

endDate*string

End Date

Example: "2020-10-31"

accountsstring

Linked Account IDs

Example: "['123456789011', '123456789012']"

productsstring

Products

Example: "['EC2InstanceReserved', 'ComputeReserved']"

autoRiYnstring

If retrieve only AutoRI or not

searchTypestring

Search type

Example: "All, My, AutoSavings"

commitmentServicestring

AWS commitment service type

Example: "all, savings-plans, reserved-instance"

Response

Body

statusstring

errorError (object)

Codeinteger (int32)

Messagestring

listarray of AwsCoverageTransitionModel (object)

reservedInstanceCoverageRatenumber (double)

Reserved Instance coverage

savingsPlansCoverageRatenumber (double)

Savings Plans coverage

autoRiCoverageRatenumber (double)

AutoRI coverage

autoSpCoverageRatenumber (double)

AutoSP coverage

onDemandCoverageRatenumber (double)

On-Demand coverage

reservedInstanceOnDemandCostEquivalentnumber (double)

Reserved Instance On-Demand equivalent

savingsPlansOnDemandCostEquivalentnumber (double)

Savings Plans On-Demand equivalent

autoRiOnDemandCostEquivalentnumber (double)

AutoRI On-Demand equivalent

autoSpOnDemandCostEquivalentnumber (double)

AutoSP On-Demand equivalent

onDemandCostnumber (double)

On-Demand Cost($)

totalOnDemandCostEquivalentnumber (double)

Total Cost

reservedInstanceNormalizeFactorAmountnumber (double)

Reserved Instance normalized factor amount

savingsPlansNormalizeFactorAmountnumber (double)

Savings Plans normalized factor amount

autoRiNormalizeFactorAmountnumber (double)

AutoRI normalized factor amount

autoSpNormalizeFactorAmountnumber (double)

AutoSP normalized factor amount

onDemandNormalizeFactorAmountnumber (double)

On-Demand normalized factor amount

totalNormalizeFactorAmountnumber (double)

Total normalized factor amount

reservedInstanceAmountnumber (double)

Reserved Instance usage amount

savingsPlansAmountnumber (double)

Savings Plans usage amount

autoRiAmountnumber (double)

AutoRI usage amount

autoSpAmountnumber (double)

AutoSP usage amount

onDemandAmountnumber (double)

On-Demand usage amount

totalAmountnumber (double)

Total usage amount

usageDate*string

Usage date

Example: "2020-07-01"

Request

Response

Get Savings Plans Filter

Get Coverage Filter

GEThttps://api.opsnow.io/cost/v3/autosave/companies/{companyId}/vendors/aws/services/integration/coverages/categories

Authorization

Path parameters

companyId*string

Company ID

Example: 1

Query parameters

dateTypeenum

Date query type

Example: "DAILY"

{DAILY, MONTHLY}

startDate*string

Start Date

Example: "2020-10-01"

endDate*string

End Date

Example: "2020-10-31"

accountsstring

Linked Account IDs

Example: "['123456789011', '123456789012']"

productsstring

Products

Example: "['EC2InstanceReserved', 'ComputeReserved']"

autoRiYnstring

If retrieve only AutoRI or not

searchTypestring

Search type

Example: "All, My, AutoSavings"

commitmentServicestring

AWS commitment service type

Example: "all, savings-plans, reserved-instance"

Response

Body

statusstring

errorError (object)

Codeinteger (int32)

Messagestring

dataAwsCommonFilterResultModel (object)

data

accountsarray of CommonCodeWithParentModel (object)

Linked Account ID

Example: "['123456789011', '123456789012']"

codestring

Code

Example: "ap-northeast-2"

namestring

Code name

Example: "Asia Pacific (Seoul)"

parentCodestring

Parent code(Code for group)

Example: "RGNCONVERT"

codesarray of string

Selected codes

Example: "['t3s','m5','c5']"

itemsstring

Selected codes

Example: "['t3s','m5','c5']"

sortinteger (int32)

정렬

productsarray of CommonCodeWithParentModel (object)

Products

Example: "[ {'code':'EC2InstanceReserved', 'value':'EC2 Instance'} ]"

codestring

Code

Example: "ap-northeast-2"

namestring

Code name

Example: "Asia Pacific (Seoul)"

parentCodestring

Parent code(Code for group)

Example: "RGNCONVERT"

codesarray of string

Selected codes

Example: "['t3s','m5','c5']"

itemsstring

Selected codes

Example: "['t3s','m5','c5']"

sortinteger (int32)

정렬

regionsarray of CommonCodeWithParentModel (object)

Regions

Example: "[ {'code':'EC2InstanceReserved', 'value':'EC2 Instance'} ]"

codestring

Code

Example: "ap-northeast-2"

namestring

Code name

Example: "Asia Pacific (Seoul)"

parentCodestring

Parent code(Code for group)

Example: "RGNCONVERT"

codesarray of string

Selected codes

Example: "['t3s','m5','c5']"

itemsstring

Selected codes

Example: "['t3s','m5','c5']"

sortinteger (int32)

정렬

instanceTypesarray of string

Instance types

Example: "[ 't2.micro', 'm4.xlarge' ]"

itemsstring

Instance types

Example: "[ 't2.micro', 'm4.xlarge' ]"

opsNowProductsarray of string

OpsNow product types

Example: "[ 'SELF', 'AUTO-RI']"

itemsstring

OpsNow product types

Example: "[ 'SELF', 'AUTO-RI']"

Request

Response

Get Savings Plans total summary

Get Coverage Total summary

GEThttps://api.opsnow.io/cost/v3/autosave/companies/{companyId}/vendors/aws/services/integration/coverages/aggregated

Authorization

Path parameters

companyId*string

Company ID

Example: 1

Query parameters

dateTypeenum

Date query type

Example: "DAILY"

{DAILY, MONTHLY}

startDate*string

Start Date

Example: "2020-10-01"

endDate*string

End Date

Example: "2020-10-31"

accountsstring

Linked Account IDs

Example: "['123456789011', '123456789012']"

productsstring

Products

Example: "['EC2InstanceReserved', 'ComputeReserved']"

autoRiYnstring

If retrieve only AutoRI or not

searchTypestring

Search type

Example: "All, My, AutoSavings"

commitmentServicestring

AWS commitment service type

Example: "all, savings-plans, reserved-instance"

Response

Body

statusstring

errorError (object)

Codeinteger (int32)

Messagestring

dataAwsCoverageValuesModel (object)

reservedInstanceCoverageRatenumber (double)

Reserved Instance coverage

savingsPlansCoverageRatenumber (double)

Savings Plans coverage

autoRiCoverageRatenumber (double)

AutoRI coverage

autoSpCoverageRatenumber (double)

AutoSP coverage

onDemandCoverageRatenumber (double)

On-Demand coverage

reservedInstanceOnDemandCostEquivalentnumber (double)

Reserved Instance On-Demand equivalent

savingsPlansOnDemandCostEquivalentnumber (double)

Savings Plans On-Demand equivalent

autoRiOnDemandCostEquivalentnumber (double)

AutoRI On-Demand equivalent

autoSpOnDemandCostEquivalentnumber (double)

AutoSP On-Demand equivalent

onDemandCostnumber (double)

On-Demand Cost($)

totalOnDemandCostEquivalentnumber (double)

Total Cost

reservedInstanceNormalizeFactorAmountnumber (double)

Reserved Instance normalized factor amount

savingsPlansNormalizeFactorAmountnumber (double)

Savings Plans normalized factor amount

autoRiNormalizeFactorAmountnumber (double)

AutoRI normalized factor amount

autoSpNormalizeFactorAmountnumber (double)

AutoSP normalized factor amount

onDemandNormalizeFactorAmountnumber (double)

On-Demand normalized factor amount

totalNormalizeFactorAmountnumber (double)

Total normalized factor amount

reservedInstanceAmountnumber (double)

Reserved Instance usage amount

savingsPlansAmountnumber (double)

Savings Plans usage amount

autoRiAmountnumber (double)

AutoRI usage amount

autoSpAmountnumber (double)

AutoSP usage amount

onDemandAmountnumber (double)

On-Demand usage amount

totalAmountnumber (double)

Total usage amount

Request

Response

Integrated(User & AutoSavings) Inventory APIs

Get My Inventory List

GEThttps://api.opsnow.io/cost/v3/autosave/companies/{companyId}/vendors/aws/services/integration/inventory/my-list

Authorization

Path parameters

companyId*string

Company ID

Example: 1

Query parameters

dateTypeenum

Date query type

Example: "DAILY"

{DAILY, MONTHLY}

startDate*string

Start Date

Example: "2023-10-01"

endDate*string

End Date

Example: "2023-10-31"

accountsstring

Linked Account ID

Example: "['123456789011', '123456789012']"

productsstring

Products

Example: "['EC2InstanceReserved', 'ComputeReserved']"

regionsstring

Regions

Example: "[ {'code':'EC2InstanceReserved', 'value':'EC2 Instance'} ]"

instanceTypesstring

Instance types

Example: "[ 't2.micro', 'm4.xlarge' ]"

opsnowProductCodesstring

OpsNow RI Purchase types

Example: "[ 'AUTO-RI', 'AUTO-SP', 'CLIENT-RI' ]"

searchTypestring

Search type

Example: "All, My, AutoSavings"

Response

Body

statusstring

errorError (object)

Codeinteger (int32)

Messagestring

listarray of AwsIntegrationInventoryModel (object)

inventoryIdstring

Inventory ID

Example: "3118c6a8-7fc3-4b5d-8b53-a82fbe6f3169"

linkedAccountIdstring

Linked account ID

Example: "123456789012"

linkedAccountAliasstring

Linked account Name

Example: "Bespinglobal Platform"

productCodestring

Product type code

Example: "AmazonEC2"

productNamestring

Product type name

Example: "EC2"

instanceTypestring

Instance type

Example: "c4.xlarge"

regionCodestring

Region code

Example: "ap-northeast-2"

regionNamestring

Region name

Example: "Asia Pacific (Seoul)"

purchaseOptionstring

Payment option

Example: "All Upfront"

remainingDaysinteger (int32)

Contract remaining days

Example: 365

startDatestring

Contract start date

Example: "2019-01-01 23:59:59"

endDatestring

Contract end date

Example: "2011-01-01 23:59:58"

durationinteger (int32)

Contract unit(seconds)

Example: 31536000

platformstring

Platform(OS)

Example: "Linux/UNIX"

operationNamestring

Operation Name

Example: "RunInstances"

statusstring

Commitment status

Example: "active"

arnstring

ARN

Example: "arn:aws:rds:ap-northeast-2:249145062117:ri:ri-2020-05-15-05-12-58-377"

hourlyCommitmentCostnumber (double)

Hourly commitment cost

Example: 100

upfrontFeenumber (double)

Upfront fee

Example: 777

recurringFeenumber (double)

Recurring fee

Example: 777

Request

Response

Get Savings Plans Inventory List

GEThttps://api.opsnow.io/cost/v3/autosave/companies/{companyId}/vendors/aws/services/integration/inventory/list

Authorization

Path parameters

companyId*string

Company ID

Example: 1

Query parameters

dateTypeenum

Date query type

Example: "DAILY"

{DAILY, MONTHLY}

startDate*string

Start Date

Example: "2023-10-01"

endDate*string

End Date

Example: "2023-10-31"

accountsstring

Linked Account ID

Example: "['123456789011', '123456789012']"

productsstring

Products

Example: "['EC2InstanceReserved', 'ComputeReserved']"

regionsstring

Regions

Example: "[ {'code':'EC2InstanceReserved', 'value':'EC2 Instance'} ]"

instanceTypesstring

Instance types

Example: "[ 't2.micro', 'm4.xlarge' ]"

opsnowProductCodesstring

OpsNow RI Purchase types

Example: "[ 'AUTO-RI', 'AUTO-SP', 'CLIENT-RI' ]"

searchTypestring

Search type

Example: "All, My, AutoSavings"

Response

Body

statusstring

errorError (object)

Codeinteger (int32)

Messagestring

listarray of AwsIntegrationInventoryModel (object)

inventoryIdstring

Inventory ID

Example: "3118c6a8-7fc3-4b5d-8b53-a82fbe6f3169"

linkedAccountIdstring

Linked account ID

Example: "123456789012"

linkedAccountAliasstring

Linked account Name

Example: "Bespinglobal Platform"

productCodestring

Product type code

Example: "AmazonEC2"

productNamestring

Product type name

Example: "EC2"

instanceTypestring

Instance type

Example: "c4.xlarge"

regionCodestring

Region code

Example: "ap-northeast-2"

regionNamestring

Region name

Example: "Asia Pacific (Seoul)"

purchaseOptionstring

Payment option

Example: "All Upfront"

remainingDaysinteger (int32)

Contract remaining days

Example: 365

startDatestring

Contract start date

Example: "2019-01-01 23:59:59"

endDatestring

Contract end date

Example: "2011-01-01 23:59:58"

durationinteger (int32)

Contract unit(seconds)

Example: 31536000

platformstring

Platform(OS)

Example: "Linux/UNIX"

operationNamestring

Operation Name

Example: "RunInstances"

statusstring

Commitment status

Example: "active"

arnstring

ARN

Example: "arn:aws:rds:ap-northeast-2:249145062117:ri:ri-2020-05-15-05-12-58-377"

hourlyCommitmentCostnumber (double)

Hourly commitment cost

Example: 100

upfrontFeenumber (double)

Upfront fee

Example: 777

recurringFeenumber (double)

Recurring fee

Example: 777

Request

Response

Get AutoSavings Inventory List

GEThttps://api.opsnow.io/cost/v3/autosave/companies/{companyId}/vendors/aws/services/integration/inventory/auto-list

Authorization

Path parameters

companyId*string

Company ID

Example: 1

Query parameters

dateTypeenum

Date query type

Example: "DAILY"

{DAILY, MONTHLY}

startDate*string

Start Date

Example: "2023-10-01"

endDate*string

End Date

Example: "2023-10-31"

accountsstring

Linked Account ID

Example: "['123456789011', '123456789012']"

productsstring

Products

Example: "['EC2InstanceReserved', 'ComputeReserved']"

regionsstring

Regions

Example: "[ {'code':'EC2InstanceReserved', 'value':'EC2 Instance'} ]"

instanceTypesstring

Instance types

Example: "[ 't2.micro', 'm4.xlarge' ]"

opsnowProductCodesstring

OpsNow RI Purchase types

Example: "[ 'AUTO-RI', 'AUTO-SP', 'CLIENT-RI' ]"

searchTypestring

Search type

Example: "All, My, AutoSavings"

Response

Body

statusstring

errorError (object)

Codeinteger (int32)

Messagestring

listarray of AwsIntegrationInventoryModel (object)

inventoryIdstring

Inventory ID

Example: "3118c6a8-7fc3-4b5d-8b53-a82fbe6f3169"

linkedAccountIdstring

Linked account ID

Example: "123456789012"

linkedAccountAliasstring

Linked account Name

Example: "Bespinglobal Platform"

productCodestring

Product type code

Example: "AmazonEC2"

productNamestring

Product type name

Example: "EC2"

instanceTypestring

Instance type

Example: "c4.xlarge"

regionCodestring

Region code

Example: "ap-northeast-2"

regionNamestring

Region name

Example: "Asia Pacific (Seoul)"

purchaseOptionstring

Payment option

Example: "All Upfront"

remainingDaysinteger (int32)

Contract remaining days

Example: 365

startDatestring

Contract start date

Example: "2019-01-01 23:59:59"

endDatestring

Contract end date

Example: "2011-01-01 23:59:58"

durationinteger (int32)

Contract unit(seconds)

Example: 31536000

platformstring

Platform(OS)

Example: "Linux/UNIX"

operationNamestring

Operation Name

Example: "RunInstances"

statusstring

Commitment status

Example: "active"

arnstring

ARN

Example: "arn:aws:rds:ap-northeast-2:249145062117:ri:ri-2020-05-15-05-12-58-377"

hourlyCommitmentCostnumber (double)

Hourly commitment cost

Example: 100

upfrontFeenumber (double)

Upfront fee

Example: 777

recurringFeenumber (double)

Recurring fee

Example: 777

Request

Response

Integrated(User & AutoSavings) Utilization APIs

Get Agreement Utilization List

GEThttps://api.opsnow.io/cost/v3/autosave/companies/{companyId}/vendors/aws/services/integration/utilizations

Authorization

Path parameters

companyId*string

Company ID

Example: 1

Query parameters

dateTypeenum

Date query type

Example: "DAILY"

{DAILY, MONTHLY}

startDate*string

Start Date

Example: "2023-10-01"

endDate*string

End Date

Example: "2023-10-31"

accountsstring

Linked Account ID

Example: "['123456789011', '123456789012']"

productsstring

Products

Example: "['EC2InstanceReserved', 'ComputeReserved']"

regionsstring

Regions

Example: "[ {'code':'EC2InstanceReserved', 'value':'EC2 Instance'} ]"

instanceTypesstring

Instance types

Example: "[ 't2.micro', 'm4.xlarge' ]"

opsnowProductCodesstring

OpsNow RI Purchase types

Example: "[ 'AUTO-RI', 'AUTO-SP', 'CLIENT-RI' ]"

searchTypestring

Search type

Example: "All, My, AutoSavings"

Response

Body

statusstring

errorError (object)

Codeinteger (int32)

Messagestring

listarray of AwsIntegrationUtilizationModel (object)

Utilization List

utilizationnumber (double)

Utilization(%)

Example: 78.15

commitmentCostnumber (double)

Total commitment cost($)

Example: 2880

usedCommitmentCostnumber (double)

Cost paid by RI($)

Example: 3690.19

netSavingsCostnumber (double)

Net savings cost - On-Demand equivalent($)

Example: 810.19

usedCommitmentCostOnDemandEquivalentnumber (double)

Cost paid by RI - On-Demand equivalent($)

netSavingsRatenumber (double)

Savings rate(%)

Example: 28.13

opsNowProductstring

Applied OpsNow product

Example: "AUTO-RI"

inventoryIdstring

inventory ID

Example: "ri-2020-03-27-04-12-02-595"

inventoryArnstring

inventory ARN

Example: "arn:aws:rds:ap-northeast-2:216093335544:ri:ri-2020-03-27-04-12-02-595"

linkedAccountIdstring

Linked account ID

Example: "123456789012"

linkedAccountAliasstring

Linked account Name

Example: "Bespinglobal Platform"

productCodestring

Product code

Example: "EC2InstanceSavingsPlans"

productNamestring

Product name

Example: "EC2 Instance"

instanceTypestring

Instance type

Example: "c5.2xlarge"

instanceSizestring

Instance size

Example: "c4.xlarge"

regionCodestring

Region code

Example: "ap-northeast-2"

regionNamestring

Region name

Example: "Asia Pacific (Seoul)"

purchaseOptionstring

Payment option

Example: "All Upfront"

startDatestring (date-time)

Contract start date

endDatestring (date-time)

Contract end date

Request

Response

Get Total Transition

Get Utilization Total Transition

GEThttps://api.opsnow.io/cost/v3/autosave/companies/{companyId}/vendors/aws/services/integration/utilizations/time-series/{dateType}

Authorization

Path parameters

companyId*string

Company ID

Example: 1

dateType*string

Date query type

Example: "DAILY"

Query parameters

startDate*string

Start Date

Example: "2023-10-01"

endDate*string

End Date

Example: "2023-10-31"

accountsstring

Linked Account ID

Example: "['123456789011', '123456789012']"

productsstring

Products

Example: "['EC2InstanceReserved', 'ComputeReserved']"

regionsstring

Regions

Example: "[ {'code':'EC2InstanceReserved', 'value':'EC2 Instance'} ]"

instanceTypesstring

Instance types

Example: "[ 't2.micro', 'm4.xlarge' ]"

opsnowProductCodesstring

OpsNow RI Purchase types

Example: "[ 'AUTO-RI', 'AUTO-SP', 'CLIENT-RI' ]"

searchTypestring

Search type

Example: "All, My, AutoSavings"

Response

Body

statusstring

errorError (object)

Codeinteger (int32)

Messagestring

listarray of AwsUtilizationPaymentModel (object)

utilizationnumber (double)

Utilization(%)

Example: 78.15

commitmentCostnumber (double)

Total commitment cost($)

Example: 3690.19

usedCommitmentCostnumber (double)

Used Savings Plans commitment cost($)

Example: 2880

netSavingsCostnumber (double)

Net savings cost On-Demand equivalent($)

Example: 810.19

netSavingsRatenumber (double)

Savings rate(%)

usedCommitmentCostOnDemandEquivalentnumber (double)

Used Savings Plans commitment cost On-Demand equivalent($)

usageDatestring

사용일

Example: "2020-07-01"

utilizationnumber (double)

Utilization(%)

Example: 78.15

commitmentCostnumber (double)

Total commitment cost($)

Example: 2880

usedCommitmentCostnumber (double)

Cost paid by RI($)

Example: 3690.19

netSavingsCostnumber (double)

Net savings cost - On-Demand equivalent($)

Example: 810.19

usedCommitmentCostOnDemandEquivalentnumber (double)

Cost paid by RI - On-Demand equivalent($)

netSavingsRatenumber (double)

Savings rate(%)

Example: 28.13

opsNowProductstring

Applied OpsNow product

Example: "AUTO-RI"

Request

Response

Overview Monthly Overview Savings

GEThttps://api.opsnow.io/cost/v3/autosave/companies/{companyId}/vendors/aws/services/integration/utilizations/overview-savings

Authorization

Path parameters

companyId*string

Company ID

Query parameters

startDatestring

Search start date

endDatestring

Search end date

Response

Body

statusstring

errorError (object)

Codeinteger (int32)

Messagestring

stateAwsAutoSavingsAccountSubscriptionStateModel (object)

The subscription states of AutoSavings for the registered accounts.

totalCountinteger (int32)

전체 계정 수

subscriptionCountinteger (int32)

구독 계정 수

stateenum

구독 상태

NONEPARTIALALL

savingsCostnumber (double)

절감액

monthlyEstimateCostnumber (double)

예상 절감액

accountsarray of AwsAutoSavingsAccountSubscriptionModel (object)

계정 구독 현황 목록

linkedAccountIdstring

linkedAccountNamestring

autoRiSubscribedboolean

autoSpSubscribedboolean

subscribedboolean

purchaseboolean

estimatedCostnumber (double)

accountStatusstring

listarray of AwsMonthlyNetSavingsModel (object)

List of hourly & estimated net savings

yearMonthstring

Year & Month

lastDaystring

Linked Account Name

Example: "Service Platform"

totalSavingCostnumber (double)

Total net savings cost

autoSavingCostnumber (double)

AutoSavings net savings cost

mySavingCostnumber (double)

My Commitment net savings cost

estimatedCostnumber (double)

Estimated net savings cost

estimatedAutoSavingCostnumber (double)

Estimated AutoSavings net savings cost - Added to only estimated future cost information

estimatedMySavingCostnumber (double)

Estimated My Commitment net savings cost - Added to only estimated future cost information

savingsCostComparedPreviousMonthnumber (double)

전월 대비 절감액

savingsRateComparedPreviousMonthnumber (double)

전월 대비 절감률

lastMonthNetSavingsAwsMonthlyNetSavingsModel (object)

Last month's net savings

yearMonthstring

Year & Month

lastDaystring

Linked Account Name

Example: "Service Platform"

totalSavingCostnumber (double)

Total net savings cost

autoSavingCostnumber (double)

AutoSavings net savings cost

mySavingCostnumber (double)

My Commitment net savings cost

estimatedCostnumber (double)

Estimated net savings cost

estimatedAutoSavingCostnumber (double)

Estimated AutoSavings net savings cost - Added to only estimated future cost information

estimatedMySavingCostnumber (double)

Estimated My Commitment net savings cost - Added to only estimated future cost information

savingsCostComparedPreviousMonthnumber (double)

전월 대비 절감액

savingsRateComparedPreviousMonthnumber (double)

전월 대비 절감률

Request

Response

Get Filter

Get Utilization Filter

GEThttps://api.opsnow.io/cost/v3/autosave/companies/{companyId}/vendors/aws/services/integration/utilizations/categories

Authorization

Path parameters

companyId*string

Company ID

Example: 1

Query parameters

dateTypeenum

Date query type

Example: "DAILY"

{DAILY, MONTHLY}

startDate*string

Start Date

Example: "2023-10-01"

endDate*string

End Date

Example: "2023-10-31"

accountsstring

Linked Account ID

Example: "['123456789011', '123456789012']"

productsstring

Products

Example: "['EC2InstanceReserved', 'ComputeReserved']"

regionsstring

Regions

Example: "[ {'code':'EC2InstanceReserved', 'value':'EC2 Instance'} ]"

instanceTypesstring

Instance types

Example: "[ 't2.micro', 'm4.xlarge' ]"

opsnowProductCodesstring

OpsNow RI Purchase types

Example: "[ 'AUTO-RI', 'AUTO-SP', 'CLIENT-RI' ]"

searchTypestring

Search type

Example: "All, My, AutoSavings"

Response

Body

statusstring

errorError (object)

Codeinteger (int32)

Messagestring

dataAwsCommonFilterResultModel (object)

data

accountsarray of CommonCodeWithParentModel (object)

Linked Account ID

Example: "['123456789011', '123456789012']"

codestring

Code

Example: "ap-northeast-2"

namestring

Code name

Example: "Asia Pacific (Seoul)"

parentCodestring

Parent code(Code for group)

Example: "RGNCONVERT"

codesarray of string

Selected codes

Example: "['t3s','m5','c5']"

itemsstring

Selected codes

Example: "['t3s','m5','c5']"

sortinteger (int32)

정렬

productsarray of CommonCodeWithParentModel (object)

Products

Example: "[ {'code':'EC2InstanceReserved', 'value':'EC2 Instance'} ]"

codestring

Code

Example: "ap-northeast-2"

namestring

Code name

Example: "Asia Pacific (Seoul)"

parentCodestring

Parent code(Code for group)

Example: "RGNCONVERT"

codesarray of string

Selected codes

Example: "['t3s','m5','c5']"

itemsstring

Selected codes

Example: "['t3s','m5','c5']"

sortinteger (int32)

정렬

regionsarray of CommonCodeWithParentModel (object)

Regions

Example: "[ {'code':'EC2InstanceReserved', 'value':'EC2 Instance'} ]"

codestring

Code

Example: "ap-northeast-2"

namestring

Code name

Example: "Asia Pacific (Seoul)"

parentCodestring

Parent code(Code for group)

Example: "RGNCONVERT"

codesarray of string

Selected codes

Example: "['t3s','m5','c5']"

itemsstring

Selected codes

Example: "['t3s','m5','c5']"

sortinteger (int32)

정렬

instanceTypesarray of string

Instance types

Example: "[ 't2.micro', 'm4.xlarge' ]"

itemsstring

Instance types

Example: "[ 't2.micro', 'm4.xlarge' ]"

opsNowProductsarray of string

OpsNow product types

Example: "[ 'SELF', 'AUTO-RI']"

itemsstring

OpsNow product types

Example: "[ 'SELF', 'AUTO-RI']"

Request

Response

Get total summary

Get Utilization Total summary

GEThttps://api.opsnow.io/cost/v3/autosave/companies/{companyId}/vendors/aws/services/integration/utilizations/aggregated

Authorization

Path parameters

companyId*string

Company ID

Example: 1

Query parameters

dateTypeenum

Date query type

Example: "DAILY"

{DAILY, MONTHLY}

startDate*string

Start Date

Example: "2023-10-01"

endDate*string

End Date

Example: "2023-10-31"

accountsstring

Linked Account ID

Example: "['123456789011', '123456789012']"

productsstring

Products

Example: "['EC2InstanceReserved', 'ComputeReserved']"

regionsstring

Regions

Example: "[ {'code':'EC2InstanceReserved', 'value':'EC2 Instance'} ]"

instanceTypesstring

Instance types

Example: "[ 't2.micro', 'm4.xlarge' ]"

opsnowProductCodesstring

OpsNow RI Purchase types

Example: "[ 'AUTO-RI', 'AUTO-SP', 'CLIENT-RI' ]"

searchTypestring

Search type

Example: "All, My, AutoSavings"

Response

Body

statusstring

errorError (object)

Codeinteger (int32)

Messagestring

dataAwsUtilizationPaymentModel (object)

utilizationnumber (double)

Utilization(%)

Example: 78.15

commitmentCostnumber (double)

Total commitment cost($)

Example: 3690.19

usedCommitmentCostnumber (double)

Used Savings Plans commitment cost($)

Example: 2880

netSavingsCostnumber (double)

Net savings cost On-Demand equivalent($)

Example: 810.19

netSavingsRatenumber (double)

Savings rate(%)

usedCommitmentCostOnDemandEquivalentnumber (double)

Used Savings Plans commitment cost On-Demand equivalent($)

usageDatestring

사용일

Example: "2020-07-01"

utilizationnumber (double)

Utilization(%)

Example: 78.15

commitmentCostnumber (double)

Total commitment cost($)

Example: 2880

usedCommitmentCostnumber (double)

Cost paid by RI($)

Example: 3690.19

netSavingsCostnumber (double)

Net savings cost - On-Demand equivalent($)

Example: 810.19

usedCommitmentCostOnDemandEquivalentnumber (double)

Cost paid by RI - On-Demand equivalent($)

netSavingsRatenumber (double)

Savings rate(%)

Example: 28.13

opsNowProductstring

Applied OpsNow product

Example: "AUTO-RI"

Request

Response

Platform

Company APIs

listCompanies

Retrieves a list of all companies accessible to the logged-in user.

GEThttps://api.opsnow.io/platform/v2/companies

Authorization

Response

Body

statusstring

The status attribute indicates the state of the request, with "success" meaning the request was processed successfully and "error" indicating an error occurred during processing.

Example: "success"

dataListCompaniesResponseModel (object)

listarray of ListCompanyModel (object)

companyIdstring

The unique identifier of the company(organization).

Example: "123e4567-e89b-12d3-a456-426614174000"

companyNamestring

The name of the company(organization).

Example: "opsnow"

isMainCompanyenum

indicates whether the company is the main company

Example: "Y"

truefalse

Request

Response

listCompanyUsers

Retrieves a list of all users associated with a company.

GEThttps://api.opsnow.io/platform/v2/companies/{companyId}/users

Authorization

Path parameters

companyId*string

The ID of the organization, obtainable through 'listCompanies'.

Example: "f23a80d2-2077-4e0a-aa85-e7b08a379be7"

Response

Body

statusstring

The status attribute indicates the state of the request, with "success" meaning the request was processed successfully and "error" indicating an error occurred during processing.

Example: "success"

dataListCompanyUsersResponseModel (object)

listarray of ListCompanyUsersEntity (object)

userIdstring

The unique identifier of the user.

Example: "123e4567-e89b-12d3-a456-426614174000"

emailstring

The email address of the user.

Example: "user@example.com"

displayNamestring

The display name of the user.

Example: "John Doe"

masterCompanyIdstring

The unique identifier of the master company.

Example: "65dd4cbf-b412-4f83-8476-97a3f1e161b2"

userStatCdenum

The status code of the user.

Example: "ACTIVATED"

UNKNOWNPENDINGACTIVATEDDEACTIVATEDWILL_DORMANTDORMANTDESTROYEDWITHDRAWAL

userRoleenum

The role of the user.

Example: "ADMIN"

ADMINMEMBER

masterUserRoleenum

The role of the user in the master company.

Example: "OWNER"

OWNERMASTER_USER

enabledenum

Indicates if the user account is enabled.

Example: true

truefalse

createdDatestring (date-time)

The date and time when the user account was created.

Example: "2023-01-01T12:00:00.000Z"

Request

Response

Cloud Account - AWS APIs

listAwsAccounts

Retrieves a list of AWS accounts associated with the specified company ID.

GEThttps://api.opsnow.io/platform/v2/companies/{companyId}/vendors/aws/accounts

Authorization

Path parameters

companyId*string

The ID of the organization, obtainable through 'listCompanies'.

Example: "f23a80d2-2077-4e0a-aa85-e7b08a379be7"

Query parameters

isAddReadyToStartboolean

Specifies whether additional Member Accounts can be registered when isAddReadyToStart is set to true.

Example: true

accountTypestring

The accountType parameter represents the type of AWS account, primarily used to distinguish between master and member accounts. In the AWS account structure, the master account is the root account of an AWS Organization, responsible for managing member accounts and consolidating billing. In contrast, member accounts are individual accounts that belong to the master account, each with its own resources and services. This parameter is used in API requests to specify whether to query for master accounts or member accounts. The acceptable values are master and member.

Example: "master"

Response

Body

statusstring

The status attribute indicates the state of the request, with "success" meaning the request was processed successfully and "error" indicating an error occurred during processing.

Example: "success"

dataListAwsAccountsResponseModel (object)

listarray of ListAwsAccountEntity (object)

accountIdstring

The unique identifier of the AWS account.

Example: "123456789012"

accountAliasstring

The alias of the AWS account, used for easy identification.

Example: "AWS 1st DEV Infra Account"

accountTypestring

Example: "master"

isCostAvailablestring

Indicates whether cost data is available for the AWS account.

Example: "true"

statusenum

The current status of the AWS account (in-progress, healthy, error, ready-to-start, -).

Example: "healthy"

healthyin-progresserrorinactiveto-be-deletedready-to-startdisabledEnabled-

contractStatusenum

The contract status of the AWS account, indicating its compliance or agreement state.

Example: "SUBSCRIBED"

SUBSCRIBEDTO_BE_CANCELEDPAYMENT_WAITNONE-

isSpPurchaseAccountboolean

A property that indicates whether the account is an SP purchase account. It returns true if the account is using AutoSP and is an AutoSP account. Example: true.

Example: true

errorDescriptionstring

A description of any errors associated with the AWS account, if applicable.

Example:

"Error occurred during stack creation. You can identify the cause of the error in AWS Console > CloudFormation > Events tab. Please take necessary actions and retry."

createdDatestring (date-time)

The date when the AWS account was created.

Example: "2024-05-20T07:06:47.253Z"

updatedDatestring (date-time)

The date when the AWS account information was last updated.

Example: "2024-05-20T07:06:47.253Z"

Request

Response

getAwsAccount

Fetches detailed information for a specific AWS account using the provided company and account IDs.

GEThttps://api.opsnow.io/platform/v2/companies/{companyId}/vendors/aws/accounts/{accountId}

Authorization

Path parameters

companyId*string

The ID of the organization, obtainable through 'listCompanies'.

Example: "f23a80d2-2077-4e0a-aa85-e7b08a379be7"

accountId*string

The unique identifier of the AWS account.

Example: 123456789012

Response

Body

statusstring

The status attribute indicates the state of the request, with "success" meaning the request was processed successfully and "error" indicating an error occurred during processing.

Example: "success"

dataGetAwsAccountResponseModel (object)

accountIdstring

The unique identifier of the AWS account.

Example: "123456789012"

accountAliasstring

The alias of the AWS account, used for easy identification.

Example: "AWS 1st DEV Infra Account"

accountTypestring

Example: "master"

managementAccountIdstring

The identifier of the management account associated with this AWS account.

Example: "987654321987"

statusenum

The current status of the AWS account (in-progress, healthy, error, ready-to-start, -).

Example: "healthy"

healthyin-progresserrorinactiveto-be-deletedready-to-startdisabledEnabled-

roleArnstring

The Amazon Resource Name (ARN) of the role associated with this AWS account.

Example: "arn:aws:iam::123456789012:role/role-name"

stackNamestring

The name of the AWS CloudFormation stack associated with this account.

Example: "opsnow-stack-7bfe7be4-b423-4e92-b6ad-b685ce2fb2e2"

stackTemplateVersionstring

The version of the AWS CloudFormation template used by the stack.

Example: "1.0"

curBucketNamestring

The name of the current S3 bucket associated with this AWS account.

Example: "bucket-name"

curBucketRegionstring

The AWS region where the current S3 bucket is located.

Example: "us-east-1"

curBucketPrefixstring

The prefix used for objects stored in the current S3 bucket.

Example: "cur"

contractStatusenum

The AWS region where the current S3 bucket is located.

Example: "us-east-1"

SUBSCRIBEDTO_BE_CANCELEDPAYMENT_WAITNONE-

createdDatestring (date-time)

The date when the AWS account was created.

Example: "2024-05-20T07:06:47.253Z"

updatedDatestring (date-time)

The date when the AWS account information was last updated.

Example: "2024-05-20T07:06:47.253Z"

Request

Response

updateAwsAccount

Updates the information of an existing AWS account identified by company and account IDs.

PUThttps://api.opsnow.io/platform/v2/companies/{companyId}/vendors/aws/accounts/{accountId}

Authorization

Path parameters

companyId*string

The ID of the organization, obtainable through 'listCompanies'.

Example: "f23a80d2-2077-4e0a-aa85-e7b08a379be7"

accountId*string

The unique identifier of the AWS account.

Example: 123456789012

Body

accountAliasstring

The alias of the AWS account, used for easy identification.

Example: "AWS 1st DEV Infra Account"

isCancelDeleteAccountboolean

Specifies whether to cancel the deletion of the AWS Account.

Example: true

Response

Body

statusstring

The status attribute indicates the state of the request, with "success" meaning the request was processed successfully and "error" indicating an error occurred during processing.

Example: "success"

dataUpdateAwsAccountResponseModel (object)

accountIdstring

The unique identifier of the AWS account.

Example: "123456789012"

Request

Response

deleteAwsAccount

Removes an AWS account from the system using the specified company and account IDs.

DELETEhttps://api.opsnow.io/platform/v2/companies/{companyId}/vendors/aws/accounts/{accountId}

Authorization

Path parameters

companyId*string

The ID of the organization, obtainable through 'listCompanies'.

Example: "f23a80d2-2077-4e0a-aa85-e7b08a379be7"

accountId*string

The unique identifier of the AWS account.

Example: 123456789012

Response

Body

statusstring

The status attribute indicates the state of the request, with "success" meaning the request was processed successfully and "error" indicating an error occurred during processing.

Example: "success"

dataDeleteAwsAccountResponseModel (object)

accountIdstring

The unique identifier of the AWS account.

Example: "123456789012"

Request

Response

getAwsAccountSavingsAmount

Retrieves savings amount information for a specified AWS account, using the given company and account IDs.

GEThttps://api.opsnow.io/platform/v2/companies/{companyId}/vendors/aws/accounts/{accountId}/recommendation-savingsplan

Authorization

Path parameters

companyId*string

The ID of the organization, obtainable through 'listCompanies'.

Example: "f23a80d2-2077-4e0a-aa85-e7b08a379be7"

accountId*string

The unique identifier of the AWS account.

Example: 123456789012

Response

Body

statusstring

The status attribute indicates the state of the request, with "success" meaning the request was processed successfully and "error" indicating an error occurred during processing.

Example: "success"

dataGetAwsAccountSavingsRecommendationResponseModel (object)

netSavingsstring

The net savings amount associated with the AWS account.

Example: "10000.7"

Request

Response

getAwsAccountSetup

Obtains the setup information for an AWS account linked to the given company ID.

GEThttps://api.opsnow.io/platform/v2/companies/{companyId}/vendors/aws/accounts/setup

Authorization

Path parameters

companyId*string

The ID of the organization, obtainable through 'listCompanies'.

Example: "f23a80d2-2077-4e0a-aa85-e7b08a379be7"

Query parameters

registrationTypestring

Used to determine how to register AWS accounts. If the value is 'single', it registers a single account. If the value is 'bulk', it provides information to register multiple accounts at once.

Example: "single"

excludeAccountsarray of string

When obtaining the information needed to register accounts, specify the accounts you want to exclude when selecting in bulk. Enter AWS account numbers separated by commas, and the information will be returned excluding these accounts. Example: '123456789012, 234567890123'.

Example: "123456789012, 234567890123"

itemsstring

Response

Body

statusstring

The status attribute indicates the state of the request, with "success" meaning the request was processed successfully and "error" indicating an error occurred during processing.

Example: "success"

dataGetAwsAccountSetupResponseModel (object)

stackCreateConsoleLinkstring

The console link for creating the AWS CloudFormation stack.

Example:

"https://console.aws.amazon.com/cloudformation/home?region=us-east-1#/stacks/create/review?templateURL=https://s3-data-dev-cloudformation.s3.ap-northeast-2.amazonaws.com/v1.2/opsnow-template-v1.2.yml&stackName=opsnow-stack-d442326f-878e-4500-8f82-d7c868f275bb&param_CostUsageReportBucketName=opsnow-cur-d442326f-878e-4500-8f82-d7c868f275bb&param_CrossAccountExternalID=ae06161e-8d5b-4c34-80c1-26f2cf00fff5&param_CrossLinkedAccountID=370166107047&param_Domain=opsnow360.io&param_Profile=us2&param_UserId=0f27a2-ae56-4a2f-8544-68ecb8674639&param_ResourceId=d442326f-878e-4500-8f82-d7c868f275bb"

stackCreateCliCommandstring

The CLI command for creating the AWS CloudFormation stack.

Example:

"aws cloudformation create-stack --stack-name opsnow-stack-d442326f-878e-4500-8f82-d7c868f275bb --region us-east-1 --template-url https://s3-data-dev-cloudformation.s3.ap-northeast-2.amazonaws.com/v1.2/opsnow-template-v1.2.yml --parameters ParameterKey=CrossAccountExternalID,ParameterValue=ae06161e-8d5b-4c34-80c1-26f2cf00fff5 ParameterKey=CrossLinkedAccountID,ParameterValue=370166107047 ParameterKey=CostUsageReportBucketName,ParameterValue=opsnow-cur-d442326f-878e-4500-8f82-d7c868f275bb ParameterKey=Domain,ParameterValue=opsnow360.io ParameterKey=Profile,ParameterValue=us2 ParameterKey=UserId,ParameterValue=0a0f27a2-ae56-4a2f-8544-68ecb8674639 ParameterKey=ResourceId,ParameterValue=d442326f-878e-4500-8f82-d7c868f275bb --capabilities CAPABILITY_NAMED_IAM"

stackDeleteCliCommandstring

The CLI command for deleting the AWS CloudFormation stack.

Example:

"aws cloudformation delete-stack-set --stack-name opsnow-stack-d442326f-878e-4500-8f82-d7c868f275bb --region us-east-1 \\\\ && \\\\aws cloudformation delete-stack --stack-name opsnow-stack-d442326f-878e-4500-8f82-d7c868f275bb --region us-east-1 "

stackNamestring

The name of the AWS CloudFormation stack associated with this account.

Example: "opsnow-stack-7bfe7be4-b423-4e92-b6ad-b685ce2fb2e2"

templateUrlstring

The URL of the AWS CloudFormation template.

Example: "3f50b07a-df54-4a7e-8db7-75a5406e970d"

crossAccountExternalIdstring

The external ID used for cross-account linking.

Example: "ae06161e-8d5b-4c34-80c1-26f2cf00fff5"

crossLinkedAccountIdstring

The ID of the linked cross-account.

Example: "123123123123"

costUsageReportBucketNamestring

The name of the S3 bucket where the cost usage report is stored.

Example: "opsnow-cur-d442326f-878e-4500-8f82-d7c868f275bb"

domainstring

Information about the domain.

Example: "opsnow.io"

profilestring

Profile information.

Example: "us2"

userIdstring

The user ID.

Example: "a6e1e5f8-924d-4a8f-9f78-61c0879c9243"

resourceIdstring

The resource ID.

Example: "3f50b07a-df54-4a7e-8db7-75a5406e970d"

organizationIdstring

The ID of the organization, obtainable through 'listCompanies'.

Example: "f23a80d2-2077-4e0a-aa85-e7b08a379be7"

Request

Response

Cloud Account - Azure APIs

listAzureTenants

Retrieves a list of Azure tenants associated with the specified company ID.

GEThttps://api.opsnow.io/platform/v2/companies/{companyId}/vendors/azure/tenants

Authorization

Path parameters

companyId*string

The ID of the organization, obtainable through 'listCompanies'.

Example: "f23a80d2-2077-4e0a-aa85-e7b08a379be7"

Response

Body

statusstring

The status attribute indicates the state of the request, with "success" meaning the request was processed successfully and "error" indicating an error occurred during processing.

Example: "success"

dataListAzureTenantsResponseModel (object)

listarray of ListAzureTenantsEntity (object)

tenantIdstring

A unique identifier used to identify an Azure Active Directory (AAD) tenant. It is used to distinguish the tenant to which all the organization's Azure resources and services belong.

Example: "6a05a771-d671-440a-9d64-087df0c16d6a"

applicationIdstring

The applicationId is a unique identifier assigned to an application when it is registered in Azure Active Directory (AAD). This identifier is used to identify the application and authenticate it when communicating with other services or applications. It is often referred to as ClientId. For example, when the application sends an authentication request to AAD, it includes this applicationId to prove its identity.

Example: "993a65dd-691f-44f7-ba1d-21e7b4c60d38"

tenantAliasstring

The alias name of the Azure tenant.

Example: "First Tenant"

tenantTypestring

Represents the type of the tenant, primarily categorized based on the subscription model. Examples include EA (Enterprise Agreement), Pay-As-You-Go, CSP and Azure Plan. This provides information related to the billing plan used by the tenant.

Example: "PAY-AS-YOU-GO"

statusenum

The current status of the Azure tenant(subscription).

Example: "healthy"

healthyin-progresserrorinactiveto-be-deletedready-to-startdisabledEnabled-

subscriptionCountinteger (int32)

Indicates the number of Azure subscriptions registered to the organization. This shows the total count of currently active Azure subscriptions for the organization.

Example: 5

createdDatestring (date-time)

The date and time when the Azure tenant was registered.

Example: "2023-07-10T14:48:00.000Z"

updatedDatestring (date-time)

The date and time when the Azure tenant was last updated.

Example: "2023-07-10T14:48:00.000Z"

Request

Response

createAzureTenant

Creates a new Azure tenant for the specified company ID.

POSThttps://api.opsnow.io/platform/v2/companies/{companyId}/vendors/azure/tenants

Authorization

Path parameters

companyId*string

The ID of the organization, obtainable through 'listCompanies'.

Example: "f23a80d2-2077-4e0a-aa85-e7b08a379be7"

Body

tenantId*string

A unique identifier used to identify an Azure Active Directory (AAD) tenant. It is used to distinguish the tenant to which all the organization's Azure resources and services belong.

Example: "6a05a771-d671-440a-9d64-087df0c16d6a"

tenantAlias*string

The alias name of the Azure tenant.

Example: "First Tenant"

applicationId*string

Example: "993a65dd-691f-44f7-ba1d-21e7b4c60d38"

clientSecret*string

The clientSecret is a secret key generated when an application is registered in Azure Active Directory (AAD). This secret key is used along with the applicationId when the application makes an authentication request. If both pieces of information match, AAD verifies the legitimacy of the application. It is crucial to store and manage the clientSecret securely as it is sensitive information that can pose security risks if exposed.

Example: "your-client-secret"

tenantType*string

Example: "PAY-AS-YOU-GO"

Pattern: PAY-AS-YOU-GO|EA|AZURE-PLAN|CSP

enrollmentNumberstring

The 'Enrollment Number' refers to a unique identifier assigned to an organization when they purchase Microsoft Azure services. This number is used to manage multiple subscriptions, track usage and costs for billing purposes, and oversee services and resources linked to a specific subscription. It allows organizations to efficiently manage and monitor their Azure services.

Example: "123456"

primaryKeystring

In the context of an Azure Enterprise Agreement (EA) account, the PRIMARY_KEY is a unique key provided to the organization. This key is used to authenticate and access Azure services and resources associated with the EA account. It acts as a secure credential, allowing the organization to manage and monitor its Azure usage and billing.

Example: "jwt-token-format"

Response

Body

statusstring

The status attribute indicates the state of the request, with "success" meaning the request was processed successfully and "error" indicating an error occurred during processing.

Example: "success"

dataCreateAzureTenantResponseModel (object)

tenantIdstring

A unique identifier used to identify an Azure Active Directory (AAD) tenant. It is used to distinguish the tenant to which all the organization's Azure resources and services belong.

Example: "6a05a771-d671-440a-9d64-087df0c16d6a"

Request

Response

getAzureTenant

Obtains the details of a specific Azure tenant linked to the given company ID.

GEThttps://api.opsnow.io/platform/v2/companies/{companyId}/vendors/azure/tenants/{tenantId}

Authorization

Path parameters

companyId*string

The ID of the organization, obtainable through 'listCompanies'.

Example: "f23a80d2-2077-4e0a-aa85-e7b08a379be7"

tenantId*string

A unique identifier used to identify an Azure Active Directory (AAD) tenant. It is used to distinguish the tenant to which all the organization's Azure resources and services belong.

Example: "6a05a771-d671-440a-9d64-087df0c16d6a"

Response

Body

statusstring

The status attribute indicates the state of the request, with "success" meaning the request was processed successfully and "error" indicating an error occurred during processing.

Example: "success"

dataGetAzureTenantResponseModel (object)

tenantIdstring

A unique identifier used to identify an Azure Active Directory (AAD) tenant. It is used to distinguish the tenant to which all the organization's Azure resources and services belong.

Example: "6a05a771-d671-440a-9d64-087df0c16d6a"

tenantAliasstring

The alias name of the Azure tenant.

Example: "First Tenant"

tenantTypestring

Example: "PAY-AS-YOU-GO"

applicationIdstring

Example: "993a65dd-691f-44f7-ba1d-21e7b4c60d38"

enrollmentNumberstring

Example: "123456"

statusenum

The current status of the Azure tenant(subscription).

Example: "healthy"

healthyin-progresserrorinactiveto-be-deletedready-to-startdisabledEnabled-

createdDatestring

The date and time when the Azure tenant was registered.

Example: "2023-07-10T14:48:00.000Z"

updatedDatestring

The date and time when the Azure tenant was last updated.

Example: "2023-07-10T14:48:00.000Z"

Request

Response

updateAzureTenant

Updates the information of a specific Azure tenant associated with the given company ID.

PUThttps://api.opsnow.io/platform/v2/companies/{companyId}/vendors/azure/tenants/{tenantId}

Authorization

Path parameters

companyId*string

The ID of the organization, obtainable through 'listCompanies'.

Example: "f23a80d2-2077-4e0a-aa85-e7b08a379be7"

tenantId*string

A unique identifier used to identify an Azure Active Directory (AAD) tenant. It is used to distinguish the tenant to which all the organization's Azure resources and services belong.

Example: "6a05a771-d671-440a-9d64-087df0c16d6a"

Body

tenantAlias*string

The alias name of the Azure tenant.

Example: "First Tenant"

Response

Body

statusstring

The status attribute indicates the state of the request, with "success" meaning the request was processed successfully and "error" indicating an error occurred during processing.

Example: "success"

dataUpdateAzureTenantResponseModel (object)

tenantIdstring

A unique identifier used to identify an Azure Active Directory (AAD) tenant. It is used to distinguish the tenant to which all the organization's Azure resources and services belong.

Example: "6a05a771-d671-440a-9d64-087df0c16d6a"

subscriptionIdstring

A unique identifier for an Azure subscription, used to manage and bill for a set of Azure resources and services.

Example: "c925a595-81d2-470c-a8cd-f7bd56fa8e95"

Request

Response

deleteAzureTenant

Deletes a specific Azure tenant linked to the specified company ID.

DELETEhttps://api.opsnow.io/platform/v2/companies/{companyId}/vendors/azure/tenants/{tenantId}

Authorization

Path parameters

companyId*string

The ID of the organization, obtainable through 'listCompanies'.

Example: "f23a80d2-2077-4e0a-aa85-e7b08a379be7"

tenantId*string

A unique identifier used to identify an Azure Active Directory (AAD) tenant. It is used to distinguish the tenant to which all the organization's Azure resources and services belong.

Example: "6a05a771-d671-440a-9d64-087df0c16d6a"

Response

Body

statusstring

The status attribute indicates the state of the request, with "success" meaning the request was processed successfully and "error" indicating an error occurred during processing.

Example: "success"

dataDeleteAzureTenantResponseModel (object)

tenantIdstring

A unique identifier used to identify an Azure Active Directory (AAD) tenant. It is used to distinguish the tenant to which all the organization's Azure resources and services belong.

Example: "6a05a771-d671-440a-9d64-087df0c16d6a"

Request

Response

listAzureSubscriptions

Retrieves a list of Azure subscriptions associated with the specified tenant ID.

GEThttps://api.opsnow.io/platform/v2/companies/{companyId}/vendors/azure/tenants/{tenantId}/subscriptions

Authorization

Path parameters

companyId*string

The ID of the organization, obtainable through 'listCompanies'.

Example: "f23a80d2-2077-4e0a-aa85-e7b08a379be7"

tenantId*string

A unique identifier used to identify an Azure Active Directory (AAD) tenant. It is used to distinguish the tenant to which all the organization's Azure resources and services belong.

Example: "6a05a771-d671-440a-9d64-087df0c16d6a"

Response

Body

statusstring

The status attribute indicates the state of the request, with "success" meaning the request was processed successfully and "error" indicating an error occurred during processing.

Example: "success"

dataListAzureSubscriptionsResponseModel (object)

listarray of ListAzureSubscriptionsEntity (object)

companyIdstring

The unique identifier of the company(organization).

Example: "123e4567-e89b-12d3-a456-426614174000"

subscriptionIdstring

A unique identifier for an Azure subscription, used to manage and bill for a set of Azure resources and services.

Example: "c925a595-81d2-470c-a8cd-f7bd56fa8e95"

subscriptionAliasstring

The alias name of the Azure subscription.

Example: "First Subscription"

tenantIdstring

A unique identifier used to identify an Azure Active Directory (AAD) tenant. It is used to distinguish the tenant to which all the organization's Azure resources and services belong.

Example: "6a05a771-d671-440a-9d64-087df0c16d6a"

statusenum

The current status of the Azure tenant(subscription).

Example: "healthy"

healthyin-progresserrorinactiveto-be-deletedready-to-startdisabledEnabled-

Request

Response

createAzureSubscription

Creates a new Azure subscription for the specified tenant ID.

POSThttps://api.opsnow.io/platform/v2/companies/{companyId}/vendors/azure/tenants/{tenantId}/subscriptions

Authorization

Path parameters

companyId*string

The ID of the organization, obtainable through 'listCompanies'.

Example: "f23a80d2-2077-4e0a-aa85-e7b08a379be7"

tenantId*string

A unique identifier used to identify an Azure Active Directory (AAD) tenant. It is used to distinguish the tenant to which all the organization's Azure resources and services belong.

Example: "6a05a771-d671-440a-9d64-087df0c16d6a"

Body

subscriptionId*string

A unique identifier for an Azure subscription, used to manage and bill for a set of Azure resources and services.

Example: "c925a595-81d2-470c-a8cd-f7bd56fa8e95"

subscriptionAlias*string

The alias name of the Azure subscription.

Example: "First Subscription"

Response

Body

statusstring

The status attribute indicates the state of the request, with "success" meaning the request was processed successfully and "error" indicating an error occurred during processing.

Example: "success"

dataCreateAzureSubscriptionResponseModel (object)

subscriptionIdstring

A unique identifier for an Azure subscription, used to manage and bill for a set of Azure resources and services.

Example: "c925a595-81d2-470c-a8cd-f7bd56fa8e95"

tenantIdstring

A unique identifier used to identify an Azure Active Directory (AAD) tenant. It is used to distinguish the tenant to which all the organization's Azure resources and services belong.

Example: "6a05a771-d671-440a-9d64-087df0c16d6a"

Request

Response

getAzureSubscription

Obtains the details of a specific Azure subscription linked to the given tenant ID.

GEThttps://api.opsnow.io/platform/v2/companies/{companyId}/vendors/azure/tenants/{tenantId}/subscriptions/{subscriptionId}

Authorization

Path parameters

companyId*string

The ID of the organization, obtainable through 'listCompanies'.

Example: "f23a80d2-2077-4e0a-aa85-e7b08a379be7"

tenantId*string

A unique identifier used to identify an Azure Active Directory (AAD) tenant. It is used to distinguish the tenant to which all the organization's Azure resources and services belong.

Example: "6a05a771-d671-440a-9d64-087df0c16d6a"

subscriptionId*string

A unique identifier for an Azure subscription, used to manage and bill for a set of Azure resources and services.

Example: "c925a595-81d2-470c-a8cd-f7bd56fa8e95"

Response

Body

statusstring

The status attribute indicates the state of the request, with "success" meaning the request was processed successfully and "error" indicating an error occurred during processing.

Example: "success"

dataGetAzureSubscriptionResponseModel (object)

tenantIdstring

A unique identifier used to identify an Azure Active Directory (AAD) tenant. It is used to distinguish the tenant to which all the organization's Azure resources and services belong.

Example: "6a05a771-d671-440a-9d64-087df0c16d6a"

subscriptionIdstring

A unique identifier for an Azure subscription, used to manage and bill for a set of Azure resources and services.

Example: "c925a595-81d2-470c-a8cd-f7bd56fa8e95"

subscriptionAliasstring

The alias name of the Azure subscription.

Example: "First Subscription"

statusenum

The current status of the Azure tenant(subscription).

Example: "healthy"

healthyin-progresserrorinactiveto-be-deletedready-to-startdisabledEnabled-

createdDatestring

The date and time when the Azure tenant was registered.

Example: "2023-07-10T14:48:00.000Z"

updatedDatestring

The date and time when the Azure tenant was last updated.

Example: "2023-07-10T14:48:00.000Z"

Request

Response

updateAzureSubscription

Updates the information of a specific Azure subscription associated with the given tenant ID.

PUThttps://api.opsnow.io/platform/v2/companies/{companyId}/vendors/azure/tenants/{tenantId}/subscriptions/{subscriptionId}

Authorization

Path parameters

companyId*string

The ID of the organization, obtainable through 'listCompanies'.

Example: "f23a80d2-2077-4e0a-aa85-e7b08a379be7"

tenantId*string

A unique identifier used to identify an Azure Active Directory (AAD) tenant. It is used to distinguish the tenant to which all the organization's Azure resources and services belong.

Example: "6a05a771-d671-440a-9d64-087df0c16d6a"

subscriptionId*string

A unique identifier for an Azure subscription, used to manage and bill for a set of Azure resources and services.

Example: "c925a595-81d2-470c-a8cd-f7bd56fa8e95"

Body

subscriptionAlias*string

The alias name of the Azure subscription.

Example: "First Subscription"

Response

Body

statusstring

The status attribute indicates the state of the request, with "success" meaning the request was processed successfully and "error" indicating an error occurred during processing.

Example: "success"

dataUpdateAzureSubscriptionResponseModel (object)

subscriptionIdstring

A unique identifier for an Azure subscription, used to manage and bill for a set of Azure resources and services.

Example: "c925a595-81d2-470c-a8cd-f7bd56fa8e95"

tenantIdstring

A unique identifier used to identify an Azure Active Directory (AAD) tenant. It is used to distinguish the tenant to which all the organization's Azure resources and services belong.

Example: "6a05a771-d671-440a-9d64-087df0c16d6a"

Request

Response

deleteAzureSubscription

Deletes a specific Azure subscription linked to the specified tenant ID.

DELETEhttps://api.opsnow.io/platform/v2/companies/{companyId}/vendors/azure/tenants/{tenantId}/subscriptions/{subscriptionId}

Authorization

Path parameters

companyId*string

The ID of the organization, obtainable through 'listCompanies'.

Example: "f23a80d2-2077-4e0a-aa85-e7b08a379be7"

tenantId*string

A unique identifier used to identify an Azure Active Directory (AAD) tenant. It is used to distinguish the tenant to which all the organization's Azure resources and services belong.

Example: "6a05a771-d671-440a-9d64-087df0c16d6a"

subscriptionId*string

A unique identifier for an Azure subscription, used to manage and bill for a set of Azure resources and services.

Example: "c925a595-81d2-470c-a8cd-f7bd56fa8e95"

Response

Body

statusstring

The status attribute indicates the state of the request, with "success" meaning the request was processed successfully and "error" indicating an error occurred during processing.

Example: "success"

dataDeleteAzureSubscriptionResponseModel (object)

subscriptionIdstring

A unique identifier for an Azure subscription, used to manage and bill for a set of Azure resources and services.

Example: "c925a595-81d2-470c-a8cd-f7bd56fa8e95"

tenantIdstring

A unique identifier used to identify an Azure Active Directory (AAD) tenant. It is used to distinguish the tenant to which all the organization's Azure resources and services belong.

Example: "6a05a771-d671-440a-9d64-087df0c16d6a"

Request

Response

listAzureRegistrableSubscriptions

List registrable Azure subscriptions for the specified tenant ID.

POSThttps://api.opsnow.io/platform/v2/companies/{companyId}/vendors/azure/tenants/registrable-subscriptions

Authorization

Path parameters

companyId*string

The ID of the organization, obtainable through 'listCompanies'.

Example: "f23a80d2-2077-4e0a-aa85-e7b08a379be7"

Body

tenantId*string

A unique identifier used to identify an Azure Active Directory (AAD) tenant. It is used to distinguish the tenant to which all the organization's Azure resources and services belong.

Example: "6a05a771-d671-440a-9d64-087df0c16d6a"

applicationId*string

Example: "993a65dd-691f-44f7-ba1d-21e7b4c60d38"

clientSecret*string

Example: "your-client-secret"

tenantType*string

Example: "PAY-AS-YOU-GO"

Pattern: PAY-AS-YOU-GO|EA|AZURE-PLAN|CSP

Response

Body

statusstring

The status attribute indicates the state of the request, with "success" meaning the request was processed successfully and "error" indicating an error occurred during processing.

Example: "success"

dataListAzureRegistrableSubscriptionsResponseModel (object)

listarray of ListAzureSubscriptionsEntity (object)

companyIdstring

The unique identifier of the company(organization).

Example: "123e4567-e89b-12d3-a456-426614174000"

subscriptionIdstring

A unique identifier for an Azure subscription, used to manage and bill for a set of Azure resources and services.

Example: "c925a595-81d2-470c-a8cd-f7bd56fa8e95"

subscriptionAliasstring

The alias name of the Azure subscription.

Example: "First Subscription"

tenantIdstring

A unique identifier used to identify an Azure Active Directory (AAD) tenant. It is used to distinguish the tenant to which all the organization's Azure resources and services belong.

Example: "6a05a771-d671-440a-9d64-087df0c16d6a"

statusenum

The current status of the Azure tenant(subscription).

Example: "healthy"

healthyin-progresserrorinactiveto-be-deletedready-to-startdisabledEnabled-

Request

Response

Cloud Account - GCP APIs

listGcpProjects

Retrieves a list of GCP projects with the given company ID.

GEThttps://api.opsnow.io/platform/v2/companies/{companyId}/vendors/gcp/projects

Authorization

Path parameters

companyId*string

The ID of the organization, obtainable through 'listCompanies'.

Example: "f23a80d2-2077-4e0a-aa85-e7b08a379be7"

Response

Body

statusstring

The status attribute indicates the state of the request, with "success" meaning the request was processed successfully and "error" indicating an error occurred during processing.

Example: "success"

dataListGcpProjectsResponseModel (object)

listarray of ListGcpProjectWithCompanyEntity (object)

projectIdstring

A unique identifier for a Google Cloud Platform project, used to organize and manage GCP resources, services, and billing.

Example: "cloud-platform-1234"

projectAliasstring

A user-friendly name or alias for a GCP project, used for easier identification and management.

Example: "My Cloud Project"

projectTypestring

The type of the GCP project, indicating whether it's used for billing purposes or resource management.

Example: "BILLING"

companyNamestring

The name of the company(organization).

Example: "opsnow"

serviceAccountIdstring

A unique identifier used to identify a Google Cloud service account. It is used to distinguish the service account that interacts with Google Cloud resources and services.

Example: "106821279384347983826"

datasetIdstring

A unique identifier for a BigQuery dataset, which is a collection of tables and views in Google Cloud Platform.

Example: "my_dataset"

bigqueryTableNamestring

The name of a specific table within a BigQuery dataset, used to store and query large datasets.

Example: "users_table"

statusstring

The current status of the GCP project, indicating its operational state.

Example: "active"

Request

Response

createGcpProject

Creates a new gcp project for the specified company ID.

POSThttps://api.opsnow.io/platform/v2/companies/{companyId}/vendors/gcp/projects

Authorization

Path parameters

companyId*string

The ID of the organization, obtainable through 'listCompanies'.

Example: "f23a80d2-2077-4e0a-aa85-e7b08a379be7"

Body

serviceAccountId*string

A unique identifier used to identify a Google Cloud service account. It is used to distinguish the service account that interacts with Google Cloud resources and services.

Example: "106821279384347983826"

projectId*string

A unique identifier for a Google Cloud Platform project, used to organize and manage GCP resources, services, and billing.

Example: "cloud-platform-1234"

projectAlias*string

A user-friendly name or alias for a GCP project, used for easier identification and management.

Example: "My Cloud Project"

datasetIdstring

A unique identifier for a BigQuery dataset, which is a collection of tables and views in Google Cloud Platform.

Example: "my_dataset"

Response

Body

statusstring

The status attribute indicates the state of the request, with "success" meaning the request was processed successfully and "error" indicating an error occurred during processing.

Example: "success"

dataCreateGcpProjectResponseModel (object)

projectIdstring

A unique identifier for a Google Cloud Platform project, used to organize and manage GCP resources, services, and billing.

Example: "cloud-platform-1234"

Request

Response

getGcpProject

Retrieves detailed information about a specific GCP project linked to the given company ID and project ID.

GEThttps://api.opsnow.io/platform/v2/companies/{companyId}/vendors/gcp/projects/{projectId}

Authorization

Path parameters

companyId*string

The ID of the organization, obtainable through 'listCompanies'.

Example: "f23a80d2-2077-4e0a-aa85-e7b08a379be7"

projectId*string

A unique identifier for a Google Cloud Platform project, used to organize and manage GCP resources, services, and billing.

Example: "cloud-platform-1234"

Response

Body

statusstring

The status attribute indicates the state of the request, with "success" meaning the request was processed successfully and "error" indicating an error occurred during processing.

Example: "success"

dataGetGcpProjectResponseModel (object)

projectIdstring

A unique identifier for a Google Cloud Platform project, used to organize and manage GCP resources, services, and billing.

Example: "cloud-platform-1234"

projectAliasstring

A user-friendly name or alias for a GCP project, used for easier identification and management.

Example: "My Cloud Project"

companyNamestring

The name of the company(organization).

Example: "opsnow"

serviceAccountIdstring

A unique identifier used to identify a Google Cloud service account. It is used to distinguish the service account that interacts with Google Cloud resources and services.

Example: "106821279384347983826"

projectTypestring

The type of the GCP project, indicating whether it's used for billing purposes or resource management.

Example: "BILLING"

datasetIdstring

A unique identifier for a BigQuery dataset, which is a collection of tables and views in Google Cloud Platform.

Example: "my_dataset"

bigQueryTableNamestring

The name of a specific table within a BigQuery dataset, used to store and query large datasets.

Example: "users_table"

statusstring

The current status of the GCP project, indicating its operational state.

Example: "active"

createdDatestring

The date and time when the GCP project or resource was created.

Example: "2023-07-10T14:48:00.000Z"

updatedDatestring

The date and time when the GCP project or resource was last updated.

Example: "2023-07-10T14:48:00.000Z"

Request

Response

updateGcpProject

Updates the information of a specific GCP project with the given project ID.

PUThttps://api.opsnow.io/platform/v2/companies/{companyId}/vendors/gcp/projects/{projectId}

Authorization

Path parameters

companyId*string

The ID of the organization, obtainable through 'listCompanies'.

Example: "f23a80d2-2077-4e0a-aa85-e7b08a379be7"

projectId*string

A unique identifier for a Google Cloud Platform project, used to organize and manage GCP resources, services, and billing.

Example: "cloud-platform-1234"

Body

projectAliasstring

A user-friendly name or alias for a GCP project, used for easier identification and management.

Example: "My Cloud Project"

datasetIdstring

A unique identifier for a BigQuery dataset, which is a collection of tables and views in Google Cloud Platform.

Example: "my_dataset"

Response

Body

statusstring

The status attribute indicates the state of the request, with "success" meaning the request was processed successfully and "error" indicating an error occurred during processing.

Example: "success"

dataUpdateGcpProjectResponseModel (object)

projectIdstring

A unique identifier for a Google Cloud Platform project, used to organize and manage GCP resources, services, and billing.

Example: "cloud-platform-1234"

Request

Response

deleteGcpProject

Deletes a specific Gcp Project linked to the specified project ID.

DELETEhttps://api.opsnow.io/platform/v2/companies/{companyId}/vendors/gcp/projects/{projectId}

Authorization

Path parameters

companyId*string

The ID of the organization, obtainable through 'listCompanies'.

Example: "f23a80d2-2077-4e0a-aa85-e7b08a379be7"

projectId*string

A unique identifier for a Google Cloud Platform project, used to organize and manage GCP resources, services, and billing.

Example: "cloud-platform-1234"

Response

Body

statusstring

The status attribute indicates the state of the request, with "success" meaning the request was processed successfully and "error" indicating an error occurred during processing.

Example: "success"

dataDeleteGcpProjectResponseModel (object)

projectIdstring

A unique identifier for a Google Cloud Platform project, used to organize and manage GCP resources, services, and billing.

Example: "cloud-platform-1234"

Request

Response

listGcpServiceAccounts

Retrieves a list of GCP service accounts with the given company ID.

GEThttps://api.opsnow.io/platform/v2/companies/{companyId}/vendors/gcp/service-accounts

Authorization

Path parameters

companyId*string

The ID of the organization, obtainable through 'listCompanies'.

Example: "f23a80d2-2077-4e0a-aa85-e7b08a379be7"

Response

Body

statusstring

The status attribute indicates the state of the request, with "success" meaning the request was processed successfully and "error" indicating an error occurred during processing.

Example: "success"

dataListGcpServiceAccountsResponseModel (object)

listarray of ListGcpServiceAccountEntity (object)

serviceAccountIdstring

A unique identifier used to identify a Google Cloud service account. It is used to distinguish the service account that interacts with Google Cloud resources and services.

Example: "106821279384347983826"

serviceAccountAliasstring

The alias name of the GCP service account.

Example: "my-service-account"

serviceAccountEmailstring

The email address associated with the GCP service account. This email is used to identify the service account and is in the format of [NAME]@[PROJECT_ID].iam.gserviceaccount.com.

Example: "my-service-account@my-project.iam.gserviceaccount.com"

statusenum

The current status of the GCP service account, indicating its operational state.

Example: "healthy"

healthyin-progresserrorinactiveto-be-deletedready-to-startdisabledEnabled-

createdDatestring

The date and time when the GCP project or resource was created.

Example: "2023-07-10T14:48:00.000Z"

updatedDatestring

The date and time when the GCP project or resource was last updated.

Example: "2023-07-10T14:48:00.000Z"

Request

Response

createGcpServiceAccount

Creates a new gcp service account for the specified company ID.

POSThttps://api.opsnow.io/platform/v2/companies/{companyId}/vendors/gcp/service-accounts

Authorization

Path parameters

companyId*string

The ID of the organization, obtainable through 'listCompanies'.

Example: "f23a80d2-2077-4e0a-aa85-e7b08a379be7"

Body

serviceAccountAlias*string

The alias name of the GCP service account.

Example: "my-service-account"

serviceAccountKey*string

A Base64-encoded string of the JSON key file containing the credentials for a GCP service account

Example: "<Base64-encoded JSON key file string>"

Response

Body

statusstring

The status attribute indicates the state of the request, with "success" meaning the request was processed successfully and "error" indicating an error occurred during processing.

Example: "success"

dataCreateGcpServiceAccountResponseModel (object)

serviceAccountIdstring

A unique identifier used to identify a Google Cloud service account. It is used to distinguish the service account that interacts with Google Cloud resources and services.

Example: "106821279384347983826"

Request

Response

getGcpServiceAccount

Retrieves detailed information about a specific GCP service account and its associated project

GEThttps://api.opsnow.io/platform/v2/companies/{companyId}/vendors/gcp/service-accounts/{serviceAccountId}

Authorization

Path parameters

companyId*string

The ID of the organization, obtainable through 'listCompanies'.

Example: "f23a80d2-2077-4e0a-aa85-e7b08a379be7"

serviceAccountId*string

A unique identifier used to identify a Google Cloud service account. It is used to distinguish the service account that interacts with Google Cloud resources and services.

Example: 106821279384347980000

Response

Body

statusstring

The status attribute indicates the state of the request, with "success" meaning the request was processed successfully and "error" indicating an error occurred during processing.

Example: "success"

dataGetGcpServiceAccountResponseModel (object)

serviceAccountIdstring

A unique identifier used to identify a Google Cloud service account. It is used to distinguish the service account that interacts with Google Cloud resources and services.

Example: "106821279384347983826"

serviceAccountAliasstring

The alias name of the GCP service account.

Example: "my-service-account"

serviceAccountProjectIdstring

A unique identifier for a Google Cloud Platform project, used to organize and manage GCP resources, services, and billing.

Example: "cloud-platform-1234"

serviceAccountEmailstring

The email address associated with the GCP service account. This email is used to identify the service account and is in the format of [NAME]@[PROJECT_ID].iam.gserviceaccount.com.

Example: "my-service-account@my-project.iam.gserviceaccount.com"

createdDatestring

The date and time when the GCP project or resource was created.

Example: "2023-07-10T14:48:00.000Z"

updatedDatestring

The date and time when the GCP project or resource was last updated.

Example: "2023-07-10T14:48:00.000Z"

projectsarray of GetGcpProjectResponseModel (object)

projectIdstring

A unique identifier for a Google Cloud Platform project, used to organize and manage GCP resources, services, and billing.

Example: "cloud-platform-1234"

projectAliasstring

A user-friendly name or alias for a GCP project, used for easier identification and management.

Example: "My Cloud Project"

companyNamestring

The name of the company(organization).

Example: "opsnow"

serviceAccountIdstring

A unique identifier used to identify a Google Cloud service account. It is used to distinguish the service account that interacts with Google Cloud resources and services.

Example: "106821279384347983826"

projectTypestring

The type of the GCP project, indicating whether it's used for billing purposes or resource management.

Example: "BILLING"

datasetIdstring

A unique identifier for a BigQuery dataset, which is a collection of tables and views in Google Cloud Platform.

Example: "my_dataset"

bigQueryTableNamestring

The name of a specific table within a BigQuery dataset, used to store and query large datasets.

Example: "users_table"

statusstring

The current status of the GCP project, indicating its operational state.

Example: "active"

createdDatestring

The date and time when the GCP project or resource was created.

Example: "2023-07-10T14:48:00.000Z"

updatedDatestring

The date and time when the GCP project or resource was last updated.

Example: "2023-07-10T14:48:00.000Z"

Request

Response

updateGcpServiceAccount

Updates the information of a specific GCP account associated with the given company ID.

PUThttps://api.opsnow.io/platform/v2/companies/{companyId}/vendors/gcp/service-accounts/{serviceAccountId}

Authorization

Path parameters

companyId*string

The ID of the organization, obtainable through 'listCompanies'.

Example: "f23a80d2-2077-4e0a-aa85-e7b08a379be7"

serviceAccountId*string

A unique identifier used to identify a Google Cloud service account. It is used to distinguish the service account that interacts with Google Cloud resources and services.

Example: 106821279384347980000

Body

serviceAccountAlias*string

The alias name of the GCP service account.

Example: "my-service-account"

Response

Body

statusstring

The status attribute indicates the state of the request, with "success" meaning the request was processed successfully and "error" indicating an error occurred during processing.

Example: "success"

dataUpdateGcpServiceAccountResponseModel (object)

serviceAccountIdstring

A unique identifier used to identify a Google Cloud service account. It is used to distinguish the service account that interacts with Google Cloud resources and services.

Example: "106821279384347983826"

Request

Response

deleteGcpServiceAccount

Deletes a specific Gcp Account linked to the specified company ID.

DELETEhttps://api.opsnow.io/platform/v2/companies/{companyId}/vendors/gcp/service-accounts/{serviceAccountId}

Authorization

Path parameters

companyId*string

The ID of the organization, obtainable through 'listCompanies'.

Example: "f23a80d2-2077-4e0a-aa85-e7b08a379be7"

serviceAccountId*string

A unique identifier used to identify a Google Cloud service account. It is used to distinguish the service account that interacts with Google Cloud resources and services.

Example: 106821279384347980000

Response

Body

statusstring

The status attribute indicates the state of the request, with "success" meaning the request was processed successfully and "error" indicating an error occurred during processing.

Example: "success"

dataDeleteGcpServiceAccountResponseModel (object)

serviceAccountIdstring

A unique identifier used to identify a Google Cloud service account. It is used to distinguish the service account that interacts with Google Cloud resources and services.

Example: "106821279384347983826"

Request

Response

listGcpServiceAccountProjects

Retrieves a list of GCP projects with the given Service Account ID.

GEThttps://api.opsnow.io/platform/v2/companies/{companyId}/vendors/gcp/service-accounts/{serviceAccountId}/projects

Authorization

Path parameters

companyId*string

The ID of the organization, obtainable through 'listCompanies'.

Example: "f23a80d2-2077-4e0a-aa85-e7b08a379be7"

serviceAccountId*string

A unique identifier used to identify a Google Cloud service account. It is used to distinguish the service account that interacts with Google Cloud resources and services.

Example: 106821279384347980000

Response

Body

statusstring

The status attribute indicates the state of the request, with "success" meaning the request was processed successfully and "error" indicating an error occurred during processing.

Example: "success"

dataListGcpProjectsResponseModel (object)

listarray of ListGcpProjectWithCompanyEntity (object)

projectIdstring

A unique identifier for a Google Cloud Platform project, used to organize and manage GCP resources, services, and billing.

Example: "cloud-platform-1234"

projectAliasstring

A user-friendly name or alias for a GCP project, used for easier identification and management.

Example: "My Cloud Project"

projectTypestring

The type of the GCP project, indicating whether it's used for billing purposes or resource management.

Example: "BILLING"

companyNamestring

The name of the company(organization).

Example: "opsnow"

serviceAccountIdstring

A unique identifier used to identify a Google Cloud service account. It is used to distinguish the service account that interacts with Google Cloud resources and services.

Example: "106821279384347983826"

datasetIdstring

A unique identifier for a BigQuery dataset, which is a collection of tables and views in Google Cloud Platform.

Example: "my_dataset"

bigqueryTableNamestring

The name of a specific table within a BigQuery dataset, used to store and query large datasets.

Example: "users_table"

statusstring

The current status of the GCP project, indicating its operational state.

Example: "active"

Request

Response

Errors

opsnow.io uses standard HTTP response codes to indicate the success or failure of API requests. Typically, they are as follows:

1. 2xx: Success

2. 4xx: Client Error

Indicates inaccurate or incomplete parameters.

code

description

400

Bad Request: Used when the client's request is malformed or invalid.

401

Unauthorized: Used when the client is not authenticated or when the authentication token has expired.

404

Not Found: Used when the requested resource is not present on the server.

405

Method Not Allowed: Used when attempting to access a resource with an unsupported HTTP method.

429

Too Many Requests: Used when the client has sent too many requests within a given time frame, typically indicating exceeding request limits.

3. 5xx: Server Error

Indicates that there is an error on the opsnow.io server.

code

description

500

Internal Server Error: Used when an internal server error occurs. Specific details about the cause should be checked in the server logs.

503

Service Unavailable: Used when the server is temporarily unable to handle the request. This could occur, for example, when the server is overloaded or undergoing maintenance.

504

Gateway Timeout: Used when the server, acting as a gateway or proxy, did not receive a timely response from the upstream server.

opsnow.io also outputs error messages and error codes in JSON format.

{
    "status": "fail",
    "error": {
        "code": 401,
        "message": "Unauthorized"
    }
}

Get result list of AWS commitment recommendation

Retrieve results of AWS commitment recommendation

GEThttps://api.opsnow.io/cost/v3/commitment/companies/{companyId}/vendors/aws/services/{service}/recommendations

Authorization

Path parameters

companyId*string

Company ID

service*string

Query parameters

product*string

Recommendation target product

purchase*string

Service

term*string

Analysis terms

Example: 14

linkedAccountsstring

Linked accounts

purchaseOptionstring

Purchase option

leasContractLengthstring

Commitment terms

offerClassstring

Offer Class

analyzeTypeCodestring

Savings Plan analysis type code

Response

Body

statusstring

errorError (object)

Codeinteger (int32)

Messagestring

dataarray of AwsRecommenderInventoryModel (object)

AWS Recommendation list

accountIdstring

Account ID

Example: "123456789012"

accountAliasstring

Name of account

Example: "Bespinglobal Platform"

productstring

Instance type

Example: "c4.xlarge"

linkedAccountIdstring

Linked account ID

Example: "123456789012"

linkedAccountAliasstring

Linked account Name

Example: "Bespinglobal Platform"

startDatestring

Contract start date

Example: "2019-01-01 23:59:59"

endDatestring

Contract end date

Example: "2011-01-01 23:59:58"

operationCodestring

Platform(OS) code

osstring

Platform(OS) name

Example: "Linux/UNIX"

regionstring

Region code

Example: "ap-northeast-2"

instanceTypestring

Instance type

Example: "c4.xlarge"

familyTypestring

Instance family

Example: "c4"

savingsPlanTypestring

Savings Plan purchase type

analyzeTypeCodestring

Savings Plan analysis type code

analyzeTypeNamestring

Savings Plan analysis type name

paymentOptionsstring

Payment option(Upfront)

Example: "All Upfront"

termLengthstring

Commitment terms

Example: "1yr"

offerClassstring

Offer Class(RI, EC2)

Example: "standard"

flexibilitystring

Size Flexibility

Example: "Flexible"

azstring

Multi-AZ Option

Example: "Single-AZ"

commitmentnumber (double)

Hourly commitment cost

monthCommitmentnumber (double)

Monthly commitment cost

monthOnDemandCostnumber (double)

Monthly On-Demand cost

monthSaveCostnumber (double)

Monthly net savings cost

residualOnDemandCostnumber (double)

Residual On-Demand cost after purchasing recommendation

onDemandCostnumber (double)

Used On-Demand cost

onDemandCostOnlyEC2number (double)

Used On-Demand cost (Only for EC2)

reservedInstanceOnDemandCostnumber (double)

Reserved Instance cost On-Demand Equivalent

savingsPlansOnDemandCostnumber (double)

Savings Plan cost On-Demand Equivalent

savingsPlansOnDemandCostOnlyEC2number (double)

Savings Plan cost On-Demand Equivalent (Only for EC2)

coverageRatenumber (double)

Current coverage for this linked account ID before purchasing recommendation

expectancyCoverageRatenumber (double)

Expected coverage for this linked account ID after purchasing recommendation

Request

Response

Get purchase option information of AWS commitment recommendation

Retrieve the cost information based on AWS commitment purchase options and their corresponding purchase outcomes.

GEThttps://api.opsnow.io/cost/v3/commitment/companies/{companyId}/vendors/aws/services/{service}/recommendations/purchase-options

Authorization

Path parameters

companyId*string

Company ID

service*string

Query parameters

product*string

Recommendation target product

purchase*string

Service

term*string

Analysis terms

Example: 14

linkedAccountsstring

Linked accounts

purchaseOptionstring

Purchase option

leasContractLengthstring

Commitment terms

offerClassstring

Offer Class

analyzeTypeCodestring

Savings Plan analysis type code

Response

Body

statusstring

errorError (object)

Codeinteger (int32)

Messagestring

dataarray of AwsRecommenderOptionModel (object)

Purchase option list

paymentOptionsstring

Payment option(Upfront)

Example: "All Upfront"

termLengthstring

Commitment terms

Example: "1yr"

offerClassstring

Offer Class(RI, EC2)

Example: "standard"

analyzeTypeCodestring

Savings Plan analysis type code

analyzeTypeNamestring

Savings Plan analysis type name

residualOnDemandCostnumber (double)

Residual On-Demand cost after purchasing recommendation

onDemandCostBeforePurchasenumber (double)

On-Demand cost before purchasing recommendation

monthCommitmentnumber (double)

Monthly commitment cost

monthSaveCostnumber (double)

Monthly net savings cost

onDemandCostnumber (double)

Used On-Demand cost

onDemandCostOnlyEC2number (double)

Used On-Demand cost (Only for EC2)

reservedInstanceOnDemandCostnumber (double)

Reserved Instance cost On-Demand Equivalent

savingsPlansOnDemandCostnumber (double)

Savings Plan cost On-Demand Equivalent

savingsPlansOnDemandCostOnlyEC2number (double)

Savings Plan cost On-Demand Equivalent (Only for EC2)

coverageRatenumber (double)

Current coverage rate

expectancyCoverageRatenumber (double)

Expected coverage rate after purchasing recommendation

linkedAccountIdstring

Linked account id

accountsarray of AwsRecommenderOptionModel (object)

Purchase option data for each linked account

paymentOptionsstring

Payment option(Upfront)

Example: "All Upfront"

termLengthstring

Commitment terms

Example: "1yr"

offerClassstring

Offer Class(RI, EC2)

Example: "standard"

analyzeTypeCodestring

Savings Plan analysis type code

analyzeTypeNamestring

Savings Plan analysis type name

residualOnDemandCostnumber (double)

Residual On-Demand cost after purchasing recommendation

onDemandCostBeforePurchasenumber (double)

On-Demand cost before purchasing recommendation

monthCommitmentnumber (double)

Monthly commitment cost

monthSaveCostnumber (double)

Monthly net savings cost

onDemandCostnumber (double)

Used On-Demand cost

onDemandCostOnlyEC2number (double)

Used On-Demand cost (Only for EC2)

reservedInstanceOnDemandCostnumber (double)

Reserved Instance cost On-Demand Equivalent

savingsPlansOnDemandCostnumber (double)

Savings Plan cost On-Demand Equivalent

savingsPlansOnDemandCostOnlyEC2number (double)

Savings Plan cost On-Demand Equivalent (Only for EC2)

coverageRatenumber (double)

Current coverage rate

expectancyCoverageRatenumber (double)

Expected coverage rate after purchasing recommendation

linkedAccountIdstring

Linked account id

accountsarray of AwsRecommenderOptionModel (object)

Purchase option data for each linked account

Circular reference to array of AwsRecommenderOptionModel (object) ↩

Request

Response

Get list of user's AWS Reserved Instance inventory

Retrieve Reserved Instance inventory(purchased by user).

GEThttps://api.opsnow.io/cost/v3/commitment/companies/{companyId}/vendors/aws/services/reserved-instance/my-inventory

Authorization

Path parameters

companyId*string

Company ID

Example: 1

Query parameters

dateTypeenum

Date query type

Example: "DAILY"

{DAILY, MONTHLY}

startDate*string

Start Date

Example: "2020-10-01"

endDate*string

End Date

Example: "2020-10-31"

accountsstring

Linked Account IDs

Example: "['123456789011', '123456789012']"

productsstring

Products

Example: "['EC2InstanceReserved', 'ComputeReserved']"

isExpiredstring

Whether the commitment is expired

searchTypestring

Commitment search type

Example: "All, My, AutoSavings"

Response

Body

statusstring

errorError (object)

Codeinteger (int32)

Messagestring

listarray of AwsReservedInstanceInventoryModel (object)

reservedInstanceIdstring

Reserved ID

Example: "3118c6a8-7fc3-4b5d-8b53-a82fbe6f3169"

linkedAccountIdstring

Linked account ID

Example: "123456789012"

linkedAccountAliasstring

Linked account Name

Example: "Bespinglobal Platform"

productCodestring

Product type code

Example: "AmazonEC2"

productNamestring

Product type name

Example: "EC2"

instanceTypestring

Instance type

Example: "c4.xlarge"

instanceSizestring

Instance size

Example: "xlarge"

regionCodestring

Region code

Example: "ap-northeast-2"

regionNamestring

Region name

Example: "Asia Pacific (Seoul)"

purchaseOptionstring

Payment option

Example: "All Upfront"

remainingDaysinteger (int32)

Contract remaining days

Example: 365

startDatestring

Contract start date

Example: "2019-01-01 23:59:59"

endDatestring

Contract end date

Example: "2011-01-01 23:59:58"

durationinteger (int32)

Contract unit(seconds)

Example: 31536000

platformstring

Platform(OS)

Example: "Linux/UNIX"

useTypestring

Usage Type

Example: "APN2-HeavyUsage:t3.micro"

operationNamestring

Operation Name

Example: "RunInstances"

tenancystring

Tenancy

Example: "Shared"

riCountinteger (int32)

Reserved Count

Example: 5

statusstring

Commitment status

Example: "active"

offerClassstring

Offer Class

Example: "standard"

arnstring

Reserved ARN

Example: "arn:aws:rds:ap-northeast-2:249145062117:ri:ri-2020-05-15-05-12-58-377"

upfrontFeenumber (double)

Upfront fee

Example: 777

recurringFeenumber (double)

Recurring fee

Example: 777

azstring

Availability Zone

Example: "777"

multiAzstring

Multi Availability Zone

Example: "777"

Request

Response

Get list of AWS Reserved Instance inventory

Retrieve Reserved Instance inventory(purchased list).

GEThttps://api.opsnow.io/cost/v3/commitment/companies/{companyId}/vendors/aws/services/reserved-instance/inventory

Authorization

Path parameters

companyId*string

Company ID

Example: 1

Query parameters

dateTypeenum

Date query type

Example: "DAILY"

{DAILY, MONTHLY}

startDate*string

Start Date

Example: "2020-10-01"

endDate*string

End Date

Example: "2020-10-31"

accountsstring

Linked Account IDs

Example: "['123456789011', '123456789012']"

productsstring

Products

Example: "['EC2InstanceReserved', 'ComputeReserved']"

isExpiredstring

Whether the commitment is expired

searchTypestring

Commitment search type

Example: "All, My, AutoSavings"

Response

Body

statusstring

errorError (object)

Codeinteger (int32)

Messagestring

listarray of AwsReservedInstanceInventoryModel (object)

reservedInstanceIdstring

Reserved ID

Example: "3118c6a8-7fc3-4b5d-8b53-a82fbe6f3169"

linkedAccountIdstring

Linked account ID

Example: "123456789012"

linkedAccountAliasstring

Linked account Name

Example: "Bespinglobal Platform"

productCodestring

Product type code

Example: "AmazonEC2"

productNamestring

Product type name

Example: "EC2"

instanceTypestring

Instance type

Example: "c4.xlarge"

instanceSizestring

Instance size

Example: "xlarge"

regionCodestring

Region code

Example: "ap-northeast-2"

regionNamestring

Region name

Example: "Asia Pacific (Seoul)"

purchaseOptionstring

Payment option

Example: "All Upfront"

remainingDaysinteger (int32)

Contract remaining days

Example: 365

startDatestring

Contract start date

Example: "2019-01-01 23:59:59"

endDatestring

Contract end date

Example: "2011-01-01 23:59:58"

durationinteger (int32)

Contract unit(seconds)

Example: 31536000

platformstring

Platform(OS)

Example: "Linux/UNIX"

useTypestring

Usage Type

Example: "APN2-HeavyUsage:t3.micro"

operationNamestring

Operation Name

Example: "RunInstances"

tenancystring

Tenancy

Example: "Shared"

riCountinteger (int32)

Reserved Count

Example: 5

statusstring

Commitment status

Example: "active"

offerClassstring

Offer Class

Example: "standard"

arnstring

Reserved ARN

Example: "arn:aws:rds:ap-northeast-2:249145062117:ri:ri-2020-05-15-05-12-58-377"

upfrontFeenumber (double)

Upfront fee

Example: 777

recurringFeenumber (double)

Recurring fee

Example: 777

azstring

Availability Zone

Example: "777"

multiAzstring

Multi Availability Zone

Example: "777"

Request

Response

Get category list of AWS Reserved Instance inventory

Retrieve the categories of AWS Reserved Instance inventory. The items within these categories can be used when categorizing the Reserved Instance commitments.

GEThttps://api.opsnow.io/cost/v3/commitment/companies/{companyId}/vendors/aws/services/reserved-instance/inventory/categories

Authorization

Path parameters

companyId*string

Company ID

Example: 1

Query parameters

dateTypeenum

Date query type

Example: "DAILY"

{DAILY, MONTHLY}

startDate*string

Start Date

Example: "2020-10-01"

endDate*string

End Date

Example: "2020-10-31"

accountsstring

Linked Account IDs

Example: "['123456789011', '123456789012']"

productsstring

Products

Example: "['EC2InstanceReserved', 'ComputeReserved']"

isExpiredstring

Whether the commitment is expired

searchTypestring

Commitment search type

Example: "All, My, AutoSavings"

Response

Body

statusstring

errorError (object)

Codeinteger (int32)

Messagestring

dataAwsReservedInstanceFilterResultModel (object)

data

accountsarray of CommonCodeWithParentModel (object)

Linked Account ID

codestring

Code

Example: "ap-northeast-2"

namestring

Code name

Example: "Asia Pacific (Seoul)"

parentCodestring

Parent code(Code for group)

Example: "RGNCONVERT"

codesarray of string

Selected codes

Example: "['t3s','m5','c5']"

itemsstring

Selected codes

Example: "['t3s','m5','c5']"

sortinteger (int32)

정렬

productsarray of CommonCodeWithParentModel (object)

서비스 유형(제품)

codestring

Code

Example: "ap-northeast-2"

namestring

Code name

Example: "Asia Pacific (Seoul)"

parentCodestring

Parent code(Code for group)

Example: "RGNCONVERT"

codesarray of string

Selected codes

Example: "['t3s','m5','c5']"

itemsstring

Selected codes

Example: "['t3s','m5','c5']"

sortinteger (int32)

정렬

Request

Response

Get list of AutoSavings AWS Reserved Instance inventory

Retrieve Reserved Instance inventory(purchased by AutoSavings).

GEThttps://api.opsnow.io/cost/v3/commitment/companies/{companyId}/vendors/aws/services/reserved-instance/auto-savings-inventory

Authorization

Path parameters

companyId*string

Company ID

Example: 1

Query parameters

dateTypeenum

Date query type

Example: "DAILY"

{DAILY, MONTHLY}

startDate*string

Start Date

Example: "2020-10-01"

endDate*string

End Date

Example: "2020-10-31"

accountsstring

Linked Account IDs

Example: "['123456789011', '123456789012']"

productsstring

Products

Example: "['EC2InstanceReserved', 'ComputeReserved']"

isExpiredstring

Whether the commitment is expired

searchTypestring

Commitment search type

Example: "All, My, AutoSavings"

Response

Body

statusstring

errorError (object)

Codeinteger (int32)

Messagestring

listarray of AwsReservedInstanceInventoryModel (object)

reservedInstanceIdstring

Reserved ID

Example: "3118c6a8-7fc3-4b5d-8b53-a82fbe6f3169"

linkedAccountIdstring

Linked account ID

Example: "123456789012"

linkedAccountAliasstring

Linked account Name

Example: "Bespinglobal Platform"

productCodestring

Product type code

Example: "AmazonEC2"

productNamestring

Product type name

Example: "EC2"

instanceTypestring

Instance type

Example: "c4.xlarge"

instanceSizestring

Instance size

Example: "xlarge"

regionCodestring

Region code

Example: "ap-northeast-2"

regionNamestring

Region name

Example: "Asia Pacific (Seoul)"

purchaseOptionstring

Payment option

Example: "All Upfront"

remainingDaysinteger (int32)

Contract remaining days

Example: 365

startDatestring

Contract start date

Example: "2019-01-01 23:59:59"

endDatestring

Contract end date

Example: "2011-01-01 23:59:58"

durationinteger (int32)

Contract unit(seconds)

Example: 31536000

platformstring

Platform(OS)

Example: "Linux/UNIX"

useTypestring

Usage Type

Example: "APN2-HeavyUsage:t3.micro"

operationNamestring

Operation Name

Example: "RunInstances"

tenancystring

Tenancy

Example: "Shared"

riCountinteger (int32)

Reserved Count

Example: 5

statusstring

Commitment status

Example: "active"

offerClassstring

Offer Class

Example: "standard"

arnstring

Reserved ARN

Example: "arn:aws:rds:ap-northeast-2:249145062117:ri:ri-2020-05-15-05-12-58-377"

upfrontFeenumber (double)

Upfront fee

Example: 777

recurringFeenumber (double)

Recurring fee

Example: 777

azstring

Availability Zone

Example: "777"

multiAzstring

Multi Availability Zone

Example: "777"

Request

Response

Get utilization data of AWS Reserved Instance

Retrieve utilization data of each AWS Reserved Instance.

GEThttps://api.opsnow.io/cost/v3/commitment/companies/{companyId}/vendors/aws/services/reserved-instance/utilizations

Authorization

Path parameters

companyId*string

Company ID

Example: 1

Query parameters

dateTypeenum

Date query type

Example: "DAILY"

{DAILY, MONTHLY}

startDate*string

Start Date

Example: "2020-10-01"

endDate*string

End Date

Example: "2020-10-31"

accountsstring

Linked Account IDs

Example: "['123456789011', '123456789012']"

productsstring

Products

Example: "['EC2InstanceReserved', 'ComputeReserved']"

isExpiredstring

Whether the commitment is expired

searchTypestring

Commitment search type

Example: "All, My, AutoSavings"

Response

Body

statusstring

errorError (object)

Codeinteger (int32)

Messagestring

listarray of AwsReservedInstanceUtilizationModel (object)

utilizationnumber (double)

Utilization(%)

Example: 78.15

commitmentCostnumber (double)

Total commitment cost($)

Example: 3690.19

usedCommitmentCostnumber (double)

Used Savings Plans commitment cost($)

Example: 2880

netSavingsCostnumber (double)

Net savings cost On-Demand equivalent($)

Example: 810.19

netSavingsRatenumber (double)

Savings rate(%)

usedCommitmentCostOnDemandEquivalentnumber (double)

Used Savings Plans commitment cost On-Demand equivalent($)

reservedInstanceIdstring

Reserved ID

Example: "ri-2020-03-27-04-12-02-595"

reservedInstanceArnstring

Reserved ARN

Example: "arn:aws:rds:ap-northeast-2:216093335544:ri:ri-2020-03-27-04-12-02-595"

linkedAccountIdstring

Linked account ID

Example: "123456789012"

linkedAccountAliasstring

Linked account Name

Example: "Bespinglobal Platform"

productCodestring

서비스유형 코드

Example: "EC2InstanceSavingsPlans"

productNamestring

서비스유형 이름

Example: "EC2 Instance"

instanceTypestring

인스턴스 타입

Example: "c5.2xlarge"

instanceSizestring

인스턴스사이즈

Example: "c4.xlarge"

tenancystring

Tenancy

Example: "Shared"

regionCodestring

리전 코드

Example: "ap-northeast-2"

regionNamestring

리전 이름

Example: "Asia Pacific (Seoul)"

purchaseOptionstring

Payment option

Example: "All Upfront"

startDatestring

계약시작일

Example: "2019-01-01 23:59:59"

endDatestring

계약종료일

Example: "2011-01-01 23:59:58"

platformstring

Platform(OS)

Example: "Linux/UNIX"

operationNamestring

Operation Name

Example: "RunInstances"

riCountinteger (int32)

Reserved Count

Example: 5

Request

Response

Get utilization summary trends of AWS Reserved Instance

Retrieve time-series utilization summary for AWS Reserved Instance.

GEThttps://api.opsnow.io/cost/v3/commitment/companies/{companyId}/vendors/aws/services/reserved-instance/utilizations/time-series/{dateType}

Authorization

Path parameters

companyId*string

Company ID

Example: 1

dateType*string

Date query type

Example: "DAILY"

Query parameters

startDate*string

Start Date

Example: "2020-10-01"

endDate*string

End Date

Example: "2020-10-31"

accountsstring

Linked Account IDs

Example: "['123456789011', '123456789012']"

productsstring

Products

Example: "['EC2InstanceReserved', 'ComputeReserved']"

isExpiredstring

Whether the commitment is expired

searchTypestring

Commitment search type

Example: "All, My, AutoSavings"

Response

Body

statusstring

errorError (object)

Codeinteger (int32)

Messagestring

listarray of AwsUtilizationPaymentModel (object)

utilizationnumber (double)

Utilization(%)

Example: 78.15

commitmentCostnumber (double)

Total commitment cost($)

Example: 3690.19

usedCommitmentCostnumber (double)

Used Savings Plans commitment cost($)

Example: 2880

netSavingsCostnumber (double)

Net savings cost On-Demand equivalent($)

Example: 810.19

netSavingsRatenumber (double)

Savings rate(%)

usedCommitmentCostOnDemandEquivalentnumber (double)

Used Savings Plans commitment cost On-Demand equivalent($)

usageDatestring

사용일

Example: "2020-07-01"

utilizationnumber (double)

Utilization(%)

Example: 78.15

commitmentCostnumber (double)

Total commitment cost($)

Example: 3690.19

usedCommitmentCostnumber (double)

Used Savings Plans commitment cost($)

Example: 2880

netSavingsCostnumber (double)

Net savings cost On-Demand equivalent($)

Example: 810.19

netSavingsRatenumber (double)

Savings rate(%)

usedCommitmentCostOnDemandEquivalentnumber (double)

Used Savings Plans commitment cost On-Demand equivalent($)

Request

Response

Get category list of AWS Reserved Instance utilization

Retrieve the categories of AWS Reserved Instance utilization. The items within these categories can be used when categorizing the values of Reserved Instance related to utilization.

GEThttps://api.opsnow.io/cost/v3/commitment/companies/{companyId}/vendors/aws/services/reserved-instance/utilizations/categories

Authorization

Path parameters

companyId*string

Company ID

Example: 1

Query parameters

dateTypeenum

Date query type

Example: "DAILY"

{DAILY, MONTHLY}

startDate*string

Start Date

Example: "2020-10-01"

endDate*string

End Date

Example: "2020-10-31"

accountsstring

Linked Account IDs

Example: "['123456789011', '123456789012']"

productsstring

Products

Example: "['EC2InstanceReserved', 'ComputeReserved']"

isExpiredstring

Whether the commitment is expired

searchTypestring

Commitment search type

Example: "All, My, AutoSavings"

Response

Body

statusstring

errorError (object)

Codeinteger (int32)

Messagestring

dataAwsReservedInstanceFilterResultModel (object)

data

accountsarray of CommonCodeWithParentModel (object)

Linked Account ID

codestring

Code

Example: "ap-northeast-2"

namestring

Code name

Example: "Asia Pacific (Seoul)"

parentCodestring

Parent code(Code for group)

Example: "RGNCONVERT"

codesarray of string

Selected codes

Example: "['t3s','m5','c5']"

itemsstring

Selected codes

Example: "['t3s','m5','c5']"

sortinteger (int32)

정렬

productsarray of CommonCodeWithParentModel (object)

서비스 유형(제품)

codestring

Code

Example: "ap-northeast-2"

namestring

Code name

Example: "Asia Pacific (Seoul)"

parentCodestring

Parent code(Code for group)

Example: "RGNCONVERT"

codesarray of string

Selected codes

Example: "['t3s','m5','c5']"

itemsstring

Selected codes

Example: "['t3s','m5','c5']"

sortinteger (int32)

정렬

Request

Response

Get utilization summary of AWS Reserved Instance

Retrieve aggregated utilization summary for AWS Reserved Instance.

GEThttps://api.opsnow.io/cost/v3/commitment/companies/{companyId}/vendors/aws/services/reserved-instance/utilizations/aggregated

Authorization

Path parameters

companyId*string

Company ID

Example: 1

Query parameters

dateTypeenum

Date query type

Example: "DAILY"

{DAILY, MONTHLY}

startDate*string

Start Date

Example: "2020-10-01"

endDate*string

End Date

Example: "2020-10-31"

accountsstring

Linked Account IDs

Example: "['123456789011', '123456789012']"

productsstring

Products

Example: "['EC2InstanceReserved', 'ComputeReserved']"

isExpiredstring

Whether the commitment is expired

searchTypestring

Commitment search type

Example: "All, My, AutoSavings"

Response

Body

statusstring

errorError (object)

Codeinteger (int32)

Messagestring

dataAwsUtilizationPaymentModel (object)

utilizationnumber (double)

Utilization(%)

Example: 78.15

commitmentCostnumber (double)

Total commitment cost($)

Example: 3690.19

usedCommitmentCostnumber (double)

Used Savings Plans commitment cost($)

Example: 2880

netSavingsCostnumber (double)

Net savings cost On-Demand equivalent($)

Example: 810.19

netSavingsRatenumber (double)

Savings rate(%)

usedCommitmentCostOnDemandEquivalentnumber (double)

Used Savings Plans commitment cost On-Demand equivalent($)

usageDatestring

사용일

Example: "2020-07-01"

utilizationnumber (double)

Utilization(%)

Example: 78.15

commitmentCostnumber (double)

Total commitment cost($)

Example: 3690.19

usedCommitmentCostnumber (double)

Used Savings Plans commitment cost($)

Example: 2880

netSavingsCostnumber (double)

Net savings cost On-Demand equivalent($)

Example: 810.19

netSavingsRatenumber (double)

Savings rate(%)

usedCommitmentCostOnDemandEquivalentnumber (double)

Used Savings Plans commitment cost On-Demand equivalent($)

Request

Response

Get utilization data of user's AWS Reserved Instance

Retrieve utilization data of user's each AWS Reserved Instance.

GEThttps://api.opsnow.io/cost/v3/commitment/companies/{companyId}/vendors/aws/services/reserved-instance/my-utilizations

Authorization

Path parameters

companyId*string

Company ID

Example: 1

Query parameters

dateTypeenum

Date query type

Example: "DAILY"

{DAILY, MONTHLY}

startDate*string

Start Date

Example: "2020-10-01"

endDate*string

End Date

Example: "2020-10-31"

accountsstring

Linked Account IDs

Example: "['123456789011', '123456789012']"

productsstring

Products

Example: "['EC2InstanceReserved', 'ComputeReserved']"

isExpiredstring

Whether the commitment is expired

searchTypestring

Commitment search type

Example: "All, My, AutoSavings"

Response

Body

statusstring

errorError (object)

Codeinteger (int32)

Messagestring

listarray of AwsReservedInstanceUtilizationModel (object)

utilizationnumber (double)

Utilization(%)

Example: 78.15

commitmentCostnumber (double)

Total commitment cost($)

Example: 3690.19

usedCommitmentCostnumber (double)

Used Savings Plans commitment cost($)

Example: 2880

netSavingsCostnumber (double)

Net savings cost On-Demand equivalent($)

Example: 810.19

netSavingsRatenumber (double)

Savings rate(%)

usedCommitmentCostOnDemandEquivalentnumber (double)

Used Savings Plans commitment cost On-Demand equivalent($)

reservedInstanceIdstring

Reserved ID

Example: "ri-2020-03-27-04-12-02-595"

reservedInstanceArnstring

Reserved ARN

Example: "arn:aws:rds:ap-northeast-2:216093335544:ri:ri-2020-03-27-04-12-02-595"

linkedAccountIdstring

Linked account ID

Example: "123456789012"

linkedAccountAliasstring

Linked account Name

Example: "Bespinglobal Platform"

productCodestring

서비스유형 코드

Example: "EC2InstanceSavingsPlans"

productNamestring

서비스유형 이름

Example: "EC2 Instance"

instanceTypestring

인스턴스 타입

Example: "c5.2xlarge"

instanceSizestring

인스턴스사이즈

Example: "c4.xlarge"

tenancystring

Tenancy

Example: "Shared"

regionCodestring

리전 코드

Example: "ap-northeast-2"

regionNamestring

리전 이름

Example: "Asia Pacific (Seoul)"

purchaseOptionstring

Payment option

Example: "All Upfront"

startDatestring

계약시작일

Example: "2019-01-01 23:59:59"

endDatestring

계약종료일

Example: "2011-01-01 23:59:58"

platformstring

Platform(OS)

Example: "Linux/UNIX"

operationNamestring

Operation Name

Example: "RunInstances"

riCountinteger (int32)

Reserved Count

Example: 5

Request

Response

Get utilization summary trends of user's AWS Reserved Instance

Retrieve time-series utilization summary for user's AWS Reserved Instance.

GEThttps://api.opsnow.io/cost/v3/commitment/companies/{companyId}/vendors/aws/services/reserved-instance/my-utilizations/time-series/{dateType}

Authorization

Path parameters

companyId*string

Company ID

Example: 1

dateType*string

Date query type

Example: "DAILY"

Query parameters

startDate*string

Start Date

Example: "2020-10-01"

endDate*string

End Date

Example: "2020-10-31"

accountsstring

Linked Account IDs

Example: "['123456789011', '123456789012']"

productsstring

Products

Example: "['EC2InstanceReserved', 'ComputeReserved']"

isExpiredstring

Whether the commitment is expired

searchTypestring

Commitment search type

Example: "All, My, AutoSavings"

Response

Body

statusstring

errorError (object)

Codeinteger (int32)

Messagestring

listarray of AwsUtilizationPaymentModel (object)

utilizationnumber (double)

Utilization(%)

Example: 78.15

commitmentCostnumber (double)

Total commitment cost($)

Example: 3690.19

usedCommitmentCostnumber (double)

Used Savings Plans commitment cost($)

Example: 2880

netSavingsCostnumber (double)

Net savings cost On-Demand equivalent($)

Example: 810.19

netSavingsRatenumber (double)

Savings rate(%)

usedCommitmentCostOnDemandEquivalentnumber (double)

Used Savings Plans commitment cost On-Demand equivalent($)

usageDatestring

사용일

Example: "2020-07-01"

utilizationnumber (double)

Utilization(%)

Example: 78.15

commitmentCostnumber (double)

Total commitment cost($)

Example: 3690.19

usedCommitmentCostnumber (double)

Used Savings Plans commitment cost($)

Example: 2880

netSavingsCostnumber (double)

Net savings cost On-Demand equivalent($)

Example: 810.19

netSavingsRatenumber (double)

Savings rate(%)

usedCommitmentCostOnDemandEquivalentnumber (double)

Used Savings Plans commitment cost On-Demand equivalent($)

Request

Response

Get category list of user's AWS Reserved Instance utilization

Retrieve the categories of user's AWS Reserved Instance utilization. The items within these categories can be used when categorizing the values of Reserved Instance related to utilization.

GEThttps://api.opsnow.io/cost/v3/commitment/companies/{companyId}/vendors/aws/services/reserved-instance/my-utilizations/categories

Authorization

Path parameters

companyId*string

Company ID

Example: 1

Query parameters

dateTypeenum

Date query type

Example: "DAILY"

{DAILY, MONTHLY}

startDate*string

Start Date

Example: "2020-10-01"

endDate*string

End Date

Example: "2020-10-31"

accountsstring

Linked Account IDs

Example: "['123456789011', '123456789012']"

productsstring

Products

Example: "['EC2InstanceReserved', 'ComputeReserved']"

isExpiredstring

Whether the commitment is expired

searchTypestring

Commitment search type

Example: "All, My, AutoSavings"

Response

Body

statusstring

errorError (object)

Codeinteger (int32)

Messagestring

dataAwsReservedInstanceFilterResultModel (object)

data

accountsarray of CommonCodeWithParentModel (object)

Linked Account ID

codestring

Code

Example: "ap-northeast-2"

namestring

Code name

Example: "Asia Pacific (Seoul)"

parentCodestring

Parent code(Code for group)

Example: "RGNCONVERT"

codesarray of string

Selected codes

Example: "['t3s','m5','c5']"

itemsstring

Selected codes

Example: "['t3s','m5','c5']"

sortinteger (int32)

정렬

productsarray of CommonCodeWithParentModel (object)

서비스 유형(제품)

codestring

Code

Example: "ap-northeast-2"

namestring

Code name

Example: "Asia Pacific (Seoul)"

parentCodestring

Parent code(Code for group)

Example: "RGNCONVERT"

codesarray of string

Selected codes

Example: "['t3s','m5','c5']"

itemsstring

Selected codes

Example: "['t3s','m5','c5']"

sortinteger (int32)

정렬

Request

Response

Get utilization summary of user's AWS Reserved Instance

Retrieve aggregated utilization summary for user's AWS Reserved Instance.

GEThttps://api.opsnow.io/cost/v3/commitment/companies/{companyId}/vendors/aws/services/reserved-instance/my-utilizations/aggregated

Authorization

Path parameters

companyId*string

Company ID

Example: 1

Query parameters

dateTypeenum

Date query type

Example: "DAILY"

{DAILY, MONTHLY}

startDate*string

Start Date

Example: "2020-10-01"

endDate*string

End Date

Example: "2020-10-31"

accountsstring

Linked Account IDs

Example: "['123456789011', '123456789012']"

productsstring

Products

Example: "['EC2InstanceReserved', 'ComputeReserved']"

isExpiredstring

Whether the commitment is expired

searchTypestring

Commitment search type

Example: "All, My, AutoSavings"

Response

Body

statusstring

errorError (object)

Codeinteger (int32)

Messagestring

dataAwsUtilizationPaymentModel (object)

utilizationnumber (double)

Utilization(%)

Example: 78.15

commitmentCostnumber (double)

Total commitment cost($)

Example: 3690.19

usedCommitmentCostnumber (double)

Used Savings Plans commitment cost($)

Example: 2880

netSavingsCostnumber (double)

Net savings cost On-Demand equivalent($)

Example: 810.19

netSavingsRatenumber (double)

Savings rate(%)

usedCommitmentCostOnDemandEquivalentnumber (double)

Used Savings Plans commitment cost On-Demand equivalent($)

usageDatestring

사용일

Example: "2020-07-01"

utilizationnumber (double)

Utilization(%)

Example: 78.15

commitmentCostnumber (double)

Total commitment cost($)

Example: 3690.19

usedCommitmentCostnumber (double)

Used Savings Plans commitment cost($)

Example: 2880

netSavingsCostnumber (double)

Net savings cost On-Demand equivalent($)

Example: 810.19

netSavingsRatenumber (double)

Savings rate(%)

usedCommitmentCostOnDemandEquivalentnumber (double)

Used Savings Plans commitment cost On-Demand equivalent($)

Request

Response

Get list of user's AWS Savings Plans inventory

Retrieve Savings Plans inventory(purchased by user).

GEThttps://api.opsnow.io/cost/v3/commitment/companies/{companyId}/vendors/aws/services/savings-plans/my-inventory

Authorization

Path parameters

companyId*string

Company ID

Example: 1

Query parameters

dateTypeenum

Date query type

Example: "DAILY"

{DAILY, MONTHLY}

startDate*string

Start Date

Example: "2020-10-01"

endDate*string

End Date

Example: "2020-10-31"

accountsstring

Linked Account ID

Example: "['123456789011', '123456789012']"

productsstring

Service type

Example: "['EC2InstanceReserved', 'ComputeReserved']"

isExpiredstring

Whether the commitment is expired

Example: false

searchTypestring

Commitment search Type

Example: "All, My, AutoSavings"

Response

Body

statusstring

errorError (object)

Codeinteger (int32)

Messagestring

listarray of AwsSavingsPlansInventoryModel (object)

savingsPlansIdstring

Savings plans ID

Example: "3118c6a8-7fc3-4b5d-8b53-a82fbe6f3169"

linkedAccountIdstring

Linked account ID

Example: "123456789012"

linkedAccountAliasstring

Linked account Name

Example: "123456789012"

productCodestring

Product code

Example: "EC2InstanceSavingsPlans"

productNamestring

Product name

Example: "EC2 Instance"

instanceFamilystring

Instance family

Example: "c4"

regionCodestring

Region code

Example: "ap-northeast-2"

regionNamestring

Region name

Example: "Asia Pacific (Seoul)"

purchaseOptionstring

Payment option

Example: "All Upfront"

remainingDaysinteger (int32)

Remaining contract days

Example: 365

startDatestring

Contract start date

Example: "2019-01-01 23:59:59"

endDatestring

Contract end date

Example: "2011-01-01 23:59:58"

durationinteger (int32)

Contract unit(second)

Example: 31536000

useTypestring

operationNamestring

statusstring

Commitment status

Example: "active"

arnstring

Savings Plans ARN

Example: "arn:aws:savingsplans::123456789012:savingsplan/3118c6a8-7fc3-4b5d-8b53-a82fbe6f3169"

hourlyCommitmentCostnumber (double)

Commitment cost(hourly)

Example: 100

upfrontFeenumber (double)

Upfront fee

Example: 100

recurringFeenumber (double)

Recurring fee

Example: 100

Request

Response

Get list of AWS Savings Plans inventory

Retrieve Savings Plans inventory(purchased list).

GEThttps://api.opsnow.io/cost/v3/commitment/companies/{companyId}/vendors/aws/services/savings-plans/inventory

Authorization

Path parameters

companyId*string

Company ID

Example: 1

Query parameters

dateTypeenum

Date query type

Example: "DAILY"

{DAILY, MONTHLY}

startDate*string

Start Date

Example: "2020-10-01"

endDate*string

End Date

Example: "2020-10-31"

accountsstring

Linked Account ID

Example: "['123456789011', '123456789012']"

productsstring

Service type

Example: "['EC2InstanceReserved', 'ComputeReserved']"

isExpiredstring

Whether the commitment is expired

Example: false

searchTypestring

Commitment search Type

Example: "All, My, AutoSavings"

Response

Body

statusstring

errorError (object)

Codeinteger (int32)

Messagestring

listarray of AwsSavingsPlansInventoryModel (object)

savingsPlansIdstring

Savings plans ID

Example: "3118c6a8-7fc3-4b5d-8b53-a82fbe6f3169"

linkedAccountIdstring

Linked account ID

Example: "123456789012"

linkedAccountAliasstring

Linked account Name

Example: "123456789012"

productCodestring

Product code

Example: "EC2InstanceSavingsPlans"

productNamestring

Product name

Example: "EC2 Instance"

instanceFamilystring

Instance family

Example: "c4"

regionCodestring

Region code

Example: "ap-northeast-2"

regionNamestring

Region name

Example: "Asia Pacific (Seoul)"

purchaseOptionstring

Payment option

Example: "All Upfront"

remainingDaysinteger (int32)

Remaining contract days

Example: 365

startDatestring

Contract start date

Example: "2019-01-01 23:59:59"

endDatestring

Contract end date

Example: "2011-01-01 23:59:58"

durationinteger (int32)

Contract unit(second)

Example: 31536000

useTypestring

operationNamestring

statusstring

Commitment status

Example: "active"

arnstring

Savings Plans ARN

Example: "arn:aws:savingsplans::123456789012:savingsplan/3118c6a8-7fc3-4b5d-8b53-a82fbe6f3169"

hourlyCommitmentCostnumber (double)

Commitment cost(hourly)

Example: 100

upfrontFeenumber (double)

Upfront fee

Example: 100

recurringFeenumber (double)

Recurring fee

Example: 100

Request

Response

Get category list of AWS Savings Plans inventory

Retrieve the categories of AWS Savings Plans inventory. The items within these categories can be used when categorizing the Savings Plans commitments.

GEThttps://api.opsnow.io/cost/v3/commitment/companies/{companyId}/vendors/aws/services/savings-plans/inventory/categories

Authorization

Path parameters

companyId*string

Company ID

Example: 1

Query parameters

dateTypeenum

Date query type

Example: "DAILY"

{DAILY, MONTHLY}

startDate*string

Start Date

Example: "2020-10-01"

endDate*string

End Date

Example: "2020-10-31"

accountsstring

Linked Account ID

Example: "['123456789011', '123456789012']"

productsstring

Service type

Example: "['EC2InstanceReserved', 'ComputeReserved']"

isExpiredstring

Whether the commitment is expired

Example: false

searchTypestring

Commitment search Type

Example: "All, My, AutoSavings"

Response

Body

statusstring

errorError (object)

Codeinteger (int32)

Messagestring

dataAwsSavingsPlansFilterResultModel (object)

accountsarray of CommonCodeWithParentModel (object)

Linked Account ID

codestring

Code

Example: "ap-northeast-2"

namestring

Code name

Example: "Asia Pacific (Seoul)"

parentCodestring

Parent code(Code for group)

Example: "RGNCONVERT"

codesarray of string

Selected codes

Example: "['t3s','m5','c5']"

itemsstring

Selected codes

Example: "['t3s','m5','c5']"

sortinteger (int32)

정렬

productsarray of CommonCodeWithParentModel (object)

Service types(products)

codestring

Code

Example: "ap-northeast-2"

namestring

Code name

Example: "Asia Pacific (Seoul)"

parentCodestring

Parent code(Code for group)

Example: "RGNCONVERT"

codesarray of string

Selected codes

Example: "['t3s','m5','c5']"

itemsstring

Selected codes

Example: "['t3s','m5','c5']"

sortinteger (int32)

정렬

Request

Response

Get list of AutoSavings AWS Savings Plans inventory

Retrieve Savings Plans inventory(purchased by AutoSavings).

GEThttps://api.opsnow.io/cost/v3/commitment/companies/{companyId}/vendors/aws/services/savings-plans/auto-savings-inventory

Authorization

Path parameters

companyId*string

Company ID

Example: 1

Query parameters

dateTypeenum

Date query type

Example: "DAILY"

{DAILY, MONTHLY}

startDate*string

Start Date

Example: "2020-10-01"

endDate*string

End Date

Example: "2020-10-31"

accountsstring

Linked Account ID

Example: "['123456789011', '123456789012']"

productsstring

Service type

Example: "['EC2InstanceReserved', 'ComputeReserved']"

isExpiredstring

Whether the commitment is expired

Example: false

searchTypestring

Commitment search Type

Example: "All, My, AutoSavings"

Response

Body

statusstring

errorError (object)

Codeinteger (int32)

Messagestring

listarray of AwsSavingsPlansInventoryModel (object)

savingsPlansIdstring

Savings plans ID

Example: "3118c6a8-7fc3-4b5d-8b53-a82fbe6f3169"

linkedAccountIdstring

Linked account ID

Example: "123456789012"

linkedAccountAliasstring

Linked account Name

Example: "123456789012"

productCodestring

Product code

Example: "EC2InstanceSavingsPlans"

productNamestring

Product name

Example: "EC2 Instance"

instanceFamilystring

Instance family

Example: "c4"

regionCodestring

Region code

Example: "ap-northeast-2"

regionNamestring

Region name

Example: "Asia Pacific (Seoul)"

purchaseOptionstring

Payment option

Example: "All Upfront"

remainingDaysinteger (int32)

Remaining contract days

Example: 365

startDatestring

Contract start date

Example: "2019-01-01 23:59:59"

endDatestring

Contract end date

Example: "2011-01-01 23:59:58"

durationinteger (int32)

Contract unit(second)

Example: 31536000

useTypestring

operationNamestring

statusstring

Commitment status

Example: "active"

arnstring

Savings Plans ARN

Example: "arn:aws:savingsplans::123456789012:savingsplan/3118c6a8-7fc3-4b5d-8b53-a82fbe6f3169"

hourlyCommitmentCostnumber (double)

Commitment cost(hourly)

Example: 100

upfrontFeenumber (double)

Upfront fee

Example: 100

recurringFeenumber (double)

Recurring fee

Example: 100

Request

Response

Get utilization data of AWS Savings Plans

Retrieve utilization data of each AWS Savings Plans.

GEThttps://api.opsnow.io/cost/v3/commitment/companies/{companyId}/vendors/aws/services/savings-plans/utilizations

Authorization

Path parameters

companyId*string

Company ID

Example: 1

Query parameters

dateTypeenum

Date query type

Example: "DAILY"

{DAILY, MONTHLY}

startDate*string

Start Date

Example: "2020-10-01"

endDate*string

End Date

Example: "2020-10-31"

accountsstring

Linked Account ID

Example: "['123456789011', '123456789012']"

productsstring

Service type

Example: "['EC2InstanceReserved', 'ComputeReserved']"

isExpiredstring

Whether the commitment is expired

Example: false

searchTypestring

Commitment search Type

Example: "All, My, AutoSavings"

Response

Body

statusstring

errorError (object)

Codeinteger (int32)

Messagestring

listarray of AwsSavingsPlansUtilizationModel (object)

utilizationnumber (double)

Utilization(%)

Example: 78.15

commitmentCostnumber (double)

Total commitment cost($)

Example: 3690.19

usedCommitmentCostnumber (double)

Used Savings Plans commitment cost($)

Example: 2880

netSavingsCostnumber (double)

Net savings cost On-Demand equivalent($)

Example: 810.19

netSavingsRatenumber (double)

Savings rate(%)

usedCommitmentCostOnDemandEquivalentnumber (double)

Used Savings Plans commitment cost On-Demand equivalent($)

savingsPlansIdstring

Savings plans ID

Example: "3118c6a8-7fc3-4b5d-8b53-a82fbe6f3169"

linkedAccountIdstring

Linked account ID

Example: "123456789012"

linkedAccountAliasstring

Linked account Name

Example: "Bespin"

productCodestring

서비스유형 코드

Example: "EC2InstanceSavingsPlans"

productNamestring

서비스유형 이름

Example: "EC2 Instance"

instanceFamilystring

인스턴스패밀리

Example: "c4"

regionCodestring

리전 코드

Example: "ap-northeast-2"

regionNamestring

리전 이름

Example: "Asia Pacific (Seoul)"

Request

Response

Get utilization summary trends of AWS Savings Plans

Retrieve time-series utilization summary for AWS Savings Plans.

GEThttps://api.opsnow.io/cost/v3/commitment/companies/{companyId}/vendors/aws/services/savings-plans/utilizations/time-series/{dateType}

Authorization

Path parameters

companyId*string

Company ID

Example: 1

dateType*string

Date query type

Example: "DAILY"

Query parameters

startDate*string

Start Date

Example: "2020-10-01"

endDate*string

End Date

Example: "2020-10-31"

accountsstring

Linked Account ID

Example: "['123456789011', '123456789012']"

productsstring

Service type

Example: "['EC2InstanceReserved', 'ComputeReserved']"

isExpiredstring

Whether the commitment is expired

Example: false

searchTypestring

Commitment search Type

Example: "All, My, AutoSavings"

Response

Body

statusstring

errorError (object)

Codeinteger (int32)

Messagestring

listarray of AwsUtilizationPaymentModel (object)

utilizationnumber (double)

Utilization(%)

Example: 78.15

commitmentCostnumber (double)

Total commitment cost($)

Example: 3690.19

usedCommitmentCostnumber (double)

Used Savings Plans commitment cost($)

Example: 2880

netSavingsCostnumber (double)

Net savings cost On-Demand equivalent($)

Example: 810.19

netSavingsRatenumber (double)

Savings rate(%)

usedCommitmentCostOnDemandEquivalentnumber (double)

Used Savings Plans commitment cost On-Demand equivalent($)

usageDatestring

사용일

Example: "2020-07-01"

utilizationnumber (double)

Utilization(%)

Example: 78.15

commitmentCostnumber (double)

Total commitment cost($)

Example: 3690.19

usedCommitmentCostnumber (double)

Used Savings Plans commitment cost($)

Example: 2880

netSavingsCostnumber (double)

Net savings cost On-Demand equivalent($)

Example: 810.19

netSavingsRatenumber (double)

Savings rate(%)

usedCommitmentCostOnDemandEquivalentnumber (double)

Used Savings Plans commitment cost On-Demand equivalent($)

Request

Response

Get category list of AWS Savings Plans utilization

Retrieve the categories of AWS Savings Plans utilization. The items within these categories can be used when categorizing the values of Savings Plans related to utilization.

GEThttps://api.opsnow.io/cost/v3/commitment/companies/{companyId}/vendors/aws/services/savings-plans/utilizations/categories

Authorization

Path parameters

companyId*string

Company ID

Example: 1

Query parameters

dateTypeenum

Date query type

Example: "DAILY"

{DAILY, MONTHLY}

startDate*string

Start Date

Example: "2020-10-01"

endDate*string

End Date

Example: "2020-10-31"

accountsstring

Linked Account ID

Example: "['123456789011', '123456789012']"

productsstring

Service type

Example: "['EC2InstanceReserved', 'ComputeReserved']"

isExpiredstring

Whether the commitment is expired

Example: false

searchTypestring

Commitment search Type

Example: "All, My, AutoSavings"

Response

Body

statusstring

errorError (object)

Codeinteger (int32)

Messagestring

dataAwsSavingsPlansFilterResultModel (object)

accountsarray of CommonCodeWithParentModel (object)

Linked Account ID

codestring

Code

Example: "ap-northeast-2"

namestring

Code name

Example: "Asia Pacific (Seoul)"

parentCodestring

Parent code(Code for group)

Example: "RGNCONVERT"

codesarray of string

Selected codes

Example: "['t3s','m5','c5']"

itemsstring

Selected codes

Example: "['t3s','m5','c5']"

sortinteger (int32)

정렬

productsarray of CommonCodeWithParentModel (object)

Service types(products)

codestring

Code

Example: "ap-northeast-2"

namestring

Code name

Example: "Asia Pacific (Seoul)"

parentCodestring

Parent code(Code for group)

Example: "RGNCONVERT"

codesarray of string

Selected codes

Example: "['t3s','m5','c5']"

itemsstring

Selected codes

Example: "['t3s','m5','c5']"

sortinteger (int32)

정렬

Request

Response

Get utilization summary of AWS Savings Plans

Retrieve aggregated utilization summary for AWS Savings Plans.

GEThttps://api.opsnow.io/cost/v3/commitment/companies/{companyId}/vendors/aws/services/savings-plans/utilizations/aggregated

Authorization

Path parameters

companyId*string

Company ID

Example: 1

Query parameters

dateTypeenum

Date query type

Example: "DAILY"

{DAILY, MONTHLY}

startDate*string

Start Date

Example: "2020-10-01"

endDate*string

End Date

Example: "2020-10-31"

accountsstring

Linked Account ID

Example: "['123456789011', '123456789012']"

productsstring

Service type

Example: "['EC2InstanceReserved', 'ComputeReserved']"

isExpiredstring

Whether the commitment is expired

Example: false

searchTypestring

Commitment search Type

Example: "All, My, AutoSavings"

Response

Body

statusstring

errorError (object)

Codeinteger (int32)

Messagestring

dataAwsUtilizationPaymentModel (object)

utilizationnumber (double)

Utilization(%)

Example: 78.15

commitmentCostnumber (double)

Total commitment cost($)

Example: 3690.19

usedCommitmentCostnumber (double)

Used Savings Plans commitment cost($)

Example: 2880

netSavingsCostnumber (double)

Net savings cost On-Demand equivalent($)

Example: 810.19

netSavingsRatenumber (double)

Savings rate(%)

usedCommitmentCostOnDemandEquivalentnumber (double)

Used Savings Plans commitment cost On-Demand equivalent($)

usageDatestring

사용일

Example: "2020-07-01"

utilizationnumber (double)

Utilization(%)

Example: 78.15

commitmentCostnumber (double)

Total commitment cost($)

Example: 3690.19

usedCommitmentCostnumber (double)

Used Savings Plans commitment cost($)

Example: 2880

netSavingsCostnumber (double)

Net savings cost On-Demand equivalent($)

Example: 810.19

netSavingsRatenumber (double)

Savings rate(%)

usedCommitmentCostOnDemandEquivalentnumber (double)

Used Savings Plans commitment cost On-Demand equivalent($)

Request

Response

Get utilization data of AWS commitment

Retrieve utilization data of each AWS commitment.

GEThttps://api.opsnow.io/cost/v3/commitment/companies/{companyId}/vendors/aws/services/all/utilizations

Authorization

Path parameters

companyId*string

Company ID

Example: 1

Query parameters

dateTypeenum

Date query type

Example: "DAILY"

{DAILY, MONTHLY}

startDate*string

Start Date

Example: "2020-10-01"

endDate*string

End Date

Example: "2020-10-31"

accountsstring

Linked Account ID

Example: "['123456789011', '123456789012']"

productsstring

Service type

Example: "['EC2InstanceReserved', 'ComputeReserved']"

isExpiredstring

Whether the commitment is expired

Example: false

searchTypestring

Commitment search Type

Example: "All, My, AutoSavings"

Response

Body

statusstring

errorError (object)

Codeinteger (int32)

Messagestring

listarray of AwsUtilizationModel (object)

utilizationnumber (double)

Utilization(%)

Example: 78.15

commitmentCostnumber (double)

Total commitment cost($)

Example: 3690.19

usedCommitmentCostnumber (double)

Used Savings Plans commitment cost($)

Example: 2880

netSavingsCostnumber (double)

Net savings cost On-Demand equivalent($)

Example: 810.19

netSavingsRatenumber (double)

Savings rate(%)

usedCommitmentCostOnDemandEquivalentnumber (double)

Used Savings Plans commitment cost On-Demand equivalent($)

commitmentIdstring

Commitment ID

Example: "ri-2020-03-27-04-12-02-595"

arnstring

ARN

Example: "arn:aws:rds:ap-northeast-2:216093335544:ri:ri-2020-03-27-04-12-02-595"

linkedAccountIdstring

Linked account ID

Example: "123456789012"

linkedAccountAliasstring

Linked account Name

Example: "Bespinglobal Platform"

productCodestring

Product code

Example: "EC2InstanceSavingsPlans"

productNamestring

Product name

Example: "EC2 Instance"

instanceTypestring

Instance type

Example: "c5.2xlarge"

instanceSizestring

Instance size

Example: "c4.xlarge"

tenancystring

Tenancy

Example: "Shared"

regionCodestring

Region code

Example: "ap-northeast-2"

regionNamestring

Region name

Example: "Asia Pacific (Seoul)"

purchaseOptionstring

Payment option

Example: "All Upfront"

startDatestring

Contract start date

Example: "2019-01-01 23:59:59"

endDatestring

Contract end date

Example: "2011-01-01 23:59:58"

platformstring

Platform(OS)

Example: "Linux/UNIX"

operationNamestring

Operation Name

Example: "RunInstances"

riCountinteger (int32)

Reserved Count

Example: 5

commitmentTypestring

Commitment type

Request

Response

Get utilization summary trends of AWS commitment

Retrieve time-series utilization summary for AWS commitment.

GEThttps://api.opsnow.io/cost/v3/commitment/companies/{companyId}/vendors/aws/services/all/utilizations/time-series/{dateType}

Authorization

Path parameters

companyId*string

Company ID

Example: 1

dateType*string

Date query type

Example: "DAILY"

Query parameters

startDate*string

Start Date

Example: "2020-10-01"

endDate*string

End Date

Example: "2020-10-31"

accountsstring

Linked Account ID

Example: "['123456789011', '123456789012']"

productsstring

Service type

Example: "['EC2InstanceReserved', 'ComputeReserved']"

isExpiredstring

Whether the commitment is expired

Example: false

searchTypestring

Commitment search Type

Example: "All, My, AutoSavings"

Response

Body

statusstring

errorError (object)

Codeinteger (int32)

Messagestring

listarray of AwsUtilizationPaymentModel (object)

utilizationnumber (double)

Utilization(%)

Example: 78.15

commitmentCostnumber (double)

Total commitment cost($)

Example: 3690.19

usedCommitmentCostnumber (double)

Used Savings Plans commitment cost($)

Example: 2880

netSavingsCostnumber (double)

Net savings cost On-Demand equivalent($)

Example: 810.19

netSavingsRatenumber (double)

Savings rate(%)

usedCommitmentCostOnDemandEquivalentnumber (double)

Used Savings Plans commitment cost On-Demand equivalent($)

usageDatestring

사용일

Example: "2020-07-01"

utilizationnumber (double)

Utilization(%)

Example: 78.15

commitmentCostnumber (double)

Total commitment cost($)

Example: 3690.19

usedCommitmentCostnumber (double)

Used Savings Plans commitment cost($)

Example: 2880

netSavingsCostnumber (double)

Net savings cost On-Demand equivalent($)

Example: 810.19

netSavingsRatenumber (double)

Savings rate(%)

usedCommitmentCostOnDemandEquivalentnumber (double)

Used Savings Plans commitment cost On-Demand equivalent($)

Request

Response

Get category list of AWS commitment utilization

Retrieve the categories of AWS commitment utilization. The items within these categories can be used when categorizing the values of commitment related to utilization.

GEThttps://api.opsnow.io/cost/v3/commitment/companies/{companyId}/vendors/aws/services/all/utilizations/categories

Authorization

Path parameters

companyId*string

Company ID

Example: 1

Query parameters

dateTypeenum

Date query type

Example: "DAILY"

{DAILY, MONTHLY}

startDate*string

Start Date

Example: "2020-10-01"

endDate*string

End Date

Example: "2020-10-31"

accountsstring

Linked Account ID

Example: "['123456789011', '123456789012']"

productsstring

Service type

Example: "['EC2InstanceReserved', 'ComputeReserved']"

isExpiredstring

Whether the commitment is expired

Example: false

searchTypestring

Commitment search Type

Example: "All, My, AutoSavings"

Response

Body

statusstring

errorError (object)

Codeinteger (int32)

Messagestring

dataAwsSavingsPlansFilterResultModel (object)

accountsarray of CommonCodeWithParentModel (object)

Linked Account ID

codestring

Code

Example: "ap-northeast-2"

namestring

Code name

Example: "Asia Pacific (Seoul)"

parentCodestring

Parent code(Code for group)

Example: "RGNCONVERT"

codesarray of string

Selected codes

Example: "['t3s','m5','c5']"

itemsstring

Selected codes

Example: "['t3s','m5','c5']"

sortinteger (int32)

정렬

productsarray of CommonCodeWithParentModel (object)

Service types(products)

codestring

Code

Example: "ap-northeast-2"

namestring

Code name

Example: "Asia Pacific (Seoul)"

parentCodestring

Parent code(Code for group)

Example: "RGNCONVERT"

codesarray of string

Selected codes

Example: "['t3s','m5','c5']"

itemsstring

Selected codes

Example: "['t3s','m5','c5']"

sortinteger (int32)

정렬

Request

Response

Get utilization summary of AWS commitment

Retrieve aggregated utilization summary for AWS commitment.

GEThttps://api.opsnow.io/cost/v3/commitment/companies/{companyId}/vendors/aws/services/all/utilizations/aggregated

Authorization

Path parameters

companyId*string

Company ID

Example: 1

Query parameters

dateTypeenum

Date query type

Example: "DAILY"

{DAILY, MONTHLY}

startDate*string

Start Date

Example: "2020-10-01"

endDate*string

End Date

Example: "2020-10-31"

accountsstring

Linked Account ID

Example: "['123456789011', '123456789012']"

productsstring

Service type

Example: "['EC2InstanceReserved', 'ComputeReserved']"

isExpiredstring

Whether the commitment is expired

Example: false

searchTypestring

Commitment search Type

Example: "All, My, AutoSavings"

Response

Body

statusstring

errorError (object)

Codeinteger (int32)

Messagestring

dataAwsUtilizationPaymentModel (object)

utilizationnumber (double)

Utilization(%)

Example: 78.15

commitmentCostnumber (double)

Total commitment cost($)

Example: 3690.19

usedCommitmentCostnumber (double)

Used Savings Plans commitment cost($)

Example: 2880

netSavingsCostnumber (double)

Net savings cost On-Demand equivalent($)

Example: 810.19

netSavingsRatenumber (double)

Savings rate(%)

usedCommitmentCostOnDemandEquivalentnumber (double)

Used Savings Plans commitment cost On-Demand equivalent($)

usageDatestring

사용일

Example: "2020-07-01"

utilizationnumber (double)

Utilization(%)

Example: 78.15

commitmentCostnumber (double)

Total commitment cost($)

Example: 3690.19

usedCommitmentCostnumber (double)

Used Savings Plans commitment cost($)

Example: 2880

netSavingsCostnumber (double)

Net savings cost On-Demand equivalent($)

Example: 810.19

netSavingsRatenumber (double)

Savings rate(%)

usedCommitmentCostOnDemandEquivalentnumber (double)

Used Savings Plans commitment cost On-Demand equivalent($)

Request

Response

Get result list of Azure Reservations recommendation

Retrieve results of Azure Reservations recommendations

GEThttps://api.opsnow.io/cost/v3/commitment/companies/{companyId}/vendors/azure/services/{service}/recommendations

Authorization

Path parameters

companyId*string

Company ID

Example: 1

service*string

Query parameters

toKRWboolean

To convert amount data to Korean Won(₩)

lookbackPeriod*string

Azure Lookback Period

Example: 30

termstring

Commitment term

Example: "P1Y"

Response

Body

statusstring

errorError (object)

Codeinteger (int32)

Messagestring

dataarray of AzureRecommenderInventoryModel (object)

Azure Recommendation list

accountIdstring

Account ID

Example: "123456789012"

accountAliasstring

Name of account

Example: "Bespinglobal Platform"

productstring

Instance type

Example: "c4.xlarge"

startDatestring

Azure RI Analysis Start Date

Example: "2022-01-31"

endDatestring

Azure RI Analysis End Date

Example: "2022-03-01"

subscriptionIdstring

Azure Subscription ID

Example: "daf98eb5-6b7b-432d-a263-8d54aed4679d"

subscriptionAliasstring

Azure Subscription Alias

Example: "BespinGlobal - FinOps"

skustring

Azure Virtual Machine SKU Name

Example: "Standard_DS2_v2"

resourceTypestring

Azure Resource Type

Example: "Microsoft.Consumption/reservationRecommendations"

locationstring

Azure Resource Location

Example: "koreasouth"

instanceFlexibilityGroupstring

Azure Instance Flexibility Group

Example: "DSv2 Series"

instanceFlexibilityRatestring

Azure Instance Flexibility Group

Example: "2"

lookbackPeriodstring

Azure Lookback Period

Example: "Last30Days"

termLengthstring

Azure RI Commitment Term

Example: "P3Y"

commitmentCountstring

Azure RI Recommend Commitment Quantity

Example: "3"

monthSaveCostnumber (double)

Azure RI Expected Net Savings

Example: 3.8589864578035966

monthOnDemandCostnumber (double)

Total Cost Without Azure RI

Example: 8.759077781999997

reservationCostnumber (double)

Total Cost With Azure RI

Example: 4.9000913241964

originCurrencystring

Origin Currency

Example: "$"

Request

Response

Get list of GCP CUD(Committed Use Discount) inventory

Retrieve Reserved Instance inventory(purchased list).

GEThttps://api.opsnow.io/cost/v3/commitment/companies/{companyId}/vendors/gcp/services/cud/inventory

Authorization

Path parameters

companyId*string

Company ID

Example: 1

Query parameters

dateTypeenum

Date query type

Example: "DAILY"

{DAILY, MONTHLY}

startDate*string

Search start Date

Example: "2020-10-01"

endDate*string

Search end Date

Example: "2020-10-31"

projectsstring

Project IDs

Example: "['pjt-sample-1', 'pjt-sample-2']"

committedTypesstring

CUD types

Example: "['compute#commitment', 'cloudSql#commitment']"

regionsstring

Regions

Example: "['1', '2']"

machineTypesstring

Machine types

Example: "['GENERAL_PURPOSE_E2','GENERAL_PURPOSE']"

productsstring

Products

resourceTypesstring

Resource types

Response

Body

statusstring

errorError (object)

Codeinteger (int32)

Messagestring

listarray of GcpCommittedUseDiscountInventoryModel (object)

projectIdstring

Project ID

Example: "sample-project"

projectNamestring

Project name

Example: "OpsNow Sample"

commitmentTypeNamestring

Commitment type name

Example: "Compute Engine"

machineTypestring

Machine Code

Example: "GENERAL_PURPOSE_E2"

machineTypeNamestring

Machine Name

Example: "General-purpose E2"

regionCodestring

Region code

Example: "ap-northeast-2"

regionNamestring

Region name

Example: "Asia Pacific (Seoul)"

remainingDaysinteger (int32)

Contract remaining days

Example: 365

startDatestring

Contract start date

Example: "2019-01-01 23:59:59"

endDatestring

Contract end date

Example: "2011-01-01 23:59:58"

planstring

Billing plan

statusstring

Commitment status

Example: "active"

cpuAmountnumber (double)

Daily CPU(Core) amount

memoryAmountnumber (double)

Daily memory amount(MByte)

storageAmountnumber (double)

Local storage amount

gpuAmountnumber (double)

GPU(Core) amount

Request

Response

Get category list of GCP CUD(Committed Use Discount) inventory

Retrieve the categories of GCP CUD(Committed Use Discount) inventory. The items within these categories can be used when categorizing the Reserved Instance commitments.

GEThttps://api.opsnow.io/cost/v3/commitment/companies/{companyId}/vendors/gcp/services/cud/inventory/categories

Authorization

Path parameters

companyId*string

Company ID

Example: 1

Query parameters

dateTypeenum

Date query type

Example: "DAILY"

{DAILY, MONTHLY}

startDate*string

Search start Date

Example: "2020-10-01"

endDate*string

Search end Date

Example: "2020-10-31"

projectsstring

Project IDs

Example: "['pjt-sample-1', 'pjt-sample-2']"

committedTypesstring

CUD types

Example: "['compute#commitment', 'cloudSql#commitment']"

regionsstring

Regions

Example: "['1', '2']"

machineTypesstring

Machine types

Example: "['GENERAL_PURPOSE_E2','GENERAL_PURPOSE']"

productsstring

Products

resourceTypesstring

Resource types

Response

Body

statusstring

errorError (object)

Codeinteger (int32)

Messagestring

dataGcpCommittedUseDiscountFilterResultModel (object)

data

projectsarray of CommonCodeModel (object)

Projects

codestring

Code

Example: "ap-northeast-2"

namestring

Code name

Example: "Asia Pacific (Seoul)"

commitmentTypesarray of CommonCodeModel (object)

Commitment Types

codestring

Code

Example: "ap-northeast-2"

namestring

Code name

Example: "Asia Pacific (Seoul)"

regionsarray of CommonCodeModel (object)

Regions

codestring

Code

Example: "ap-northeast-2"

namestring

Code name

Example: "Asia Pacific (Seoul)"

machineTypesarray of CommonCodeModel (object)

Machine Types

codestring

Code

Example: "ap-northeast-2"

namestring

Code name

Example: "Asia Pacific (Seoul)"

resourceTypesarray of CommonCodeModel (object)

Resource Types

codestring

Code

Example: "ap-northeast-2"

namestring

Code name

Example: "Asia Pacific (Seoul)"

productsarray of CommonCodeModel (object)

Products

codestring

Code

Example: "ap-northeast-2"

namestring

Code name

Example: "Asia Pacific (Seoul)"

Request

Response

Get utilization data of GCP CUD(Committed Use Discount)

Retrieve utilization data of each GCP CUD(Committed Use Discount).

GEThttps://api.opsnow.io/cost/v3/commitment/companies/{companyId}/vendors/gcp/services/cud/utilizations

Authorization

Path parameters

companyId*string

Company ID

Example: 1

Query parameters

dateTypeenum

Date query type

Example: "DAILY"

{DAILY, MONTHLY}

startDate*string

Search start Date

Example: "2020-10-01"

endDate*string

Search end Date

Example: "2020-10-31"

projectsstring

Project IDs

Example: "['pjt-sample-1', 'pjt-sample-2']"

committedTypesstring

CUD types

Example: "['compute#commitment', 'cloudSql#commitment']"

regionsstring

Regions

Example: "['1', '2']"

machineTypesstring

Machine types

Example: "['GENERAL_PURPOSE_E2','GENERAL_PURPOSE']"

productsstring

Products

resourceTypesstring

Resource types

Response

Body

statusstring

errorError (object)

Codeinteger (int32)

Messagestring

totalCount*integer (int32)

Item counts of the list

Example: 123

listarray of GcpCommittedUseDiscountUtilizationModel (object)

utilizationnumber (double)

사용률(%)

commitmentCapacitynumber (double)

약정 사용량

usedCapacitynumber (double)

사용량

commitmentCostnumber (double)

총결재금액($)

usedCommitmentCostnumber (double)

사용 약정 금액

committedUseDiscountOnDemandCostEquivalentnumber (double)

CUD 온디맨드 환산 비용

netSavingsCostnumber (double)

절감 금액

netSavingsRatenumber (double)

절감률

projectIdstring

Project ID

projectNamestring

Project Name

regionCodestring

리전 코드

Example: "us-central1"

regionNamestring

리전 이름

Example: "us-central1"

productCodestring

서비스 ID

productNamestring

서비스 이름(설명)

Example: "Compute Engine"

machineTypestring

머신 유형

Example: "E2"

commitmentTypeNamestring

약정 유형 이름

Example: "Compute Engine"

resourceTypestring

리소스

Example: "vCPU"

unitstring

사용량 단위

Example: "vCPU"

Request

Response

Get utilization summary trends of GCP CUD(Committed Use Discount)

Retrieve time-series utilization summary for GCP CUD(Committed Use Discount).

GEThttps://api.opsnow.io/cost/v3/commitment/companies/{companyId}/vendors/gcp/services/cud/utilizations/time-series/{dateType}

Authorization

Path parameters

companyId*string

Company ID

Example: 1

dateType*string

Date query type

Example: "DAILY"

Query parameters

startDate*string

Search start Date

Example: "2020-10-01"

endDate*string

Search end Date

Example: "2020-10-31"

projectsstring

Project IDs

Example: "['pjt-sample-1', 'pjt-sample-2']"

committedTypesstring

CUD types

Example: "['compute#commitment', 'cloudSql#commitment']"

regionsstring

Regions

Example: "['1', '2']"

machineTypesstring

Machine types

Example: "['GENERAL_PURPOSE_E2','GENERAL_PURPOSE']"

productsstring

Products

resourceTypesstring

Resource types

Response

Body

statusstring

errorError (object)

Codeinteger (int32)

Messagestring

listarray of GcpCommittedUseDiscountUtilizationPaymentModel (object)

utilizationnumber (double)

사용률(%)

commitmentCapacitynumber (double)

약정 사용량

usedCapacitynumber (double)

사용량

commitmentCostnumber (double)

총결재금액($)

usedCommitmentCostnumber (double)

사용 약정 금액

committedUseDiscountOnDemandCostEquivalentnumber (double)

CUD 온디맨드 환산 비용

netSavingsCostnumber (double)

절감 금액

netSavingsRatenumber (double)

절감률

usageDate*string

사용일

Example: "2020-07-01"

utilizationnumber (double)

사용률(%)

commitmentCapacitynumber (double)

약정 사용량

usedCapacitynumber (double)

사용량

commitmentCostnumber (double)

총결재금액($)

usedCommitmentCostnumber (double)

사용 약정 금액

committedUseDiscountOnDemandCostEquivalentnumber (double)

CUD 온디맨드 환산 비용

netSavingsCostnumber (double)

절감 금액

netSavingsRatenumber (double)

절감률

Request

Response

Get category list of GCP CUD(Committed Use Discount) utilization

Retrieve the categories of GCP CUD(Committed Use Discount) utilization. The items within these categories can be used when categorizing the values of Reserved Instance related to utilization.

GEThttps://api.opsnow.io/cost/v3/commitment/companies/{companyId}/vendors/gcp/services/cud/utilizations/categories

Authorization

Path parameters

companyId*string

Company ID

Example: 1

Query parameters

dateTypeenum

Date query type

Example: "DAILY"

{DAILY, MONTHLY}

startDate*string

Search start Date

Example: "2020-10-01"

endDate*string

Search end Date

Example: "2020-10-31"

projectsstring

Project IDs

Example: "['pjt-sample-1', 'pjt-sample-2']"

committedTypesstring

CUD types

Example: "['compute#commitment', 'cloudSql#commitment']"

regionsstring

Regions

Example: "['1', '2']"

machineTypesstring

Machine types

Example: "['GENERAL_PURPOSE_E2','GENERAL_PURPOSE']"

productsstring

Products

resourceTypesstring

Resource types

Response

Body

statusstring

errorError (object)

Codeinteger (int32)

Messagestring

dataGcpCommittedUseDiscountFilterResultModel (object)

data

projectsarray of CommonCodeModel (object)

Projects

codestring

Code

Example: "ap-northeast-2"

namestring

Code name

Example: "Asia Pacific (Seoul)"

commitmentTypesarray of CommonCodeModel (object)

Commitment Types

codestring

Code

Example: "ap-northeast-2"

namestring

Code name

Example: "Asia Pacific (Seoul)"

regionsarray of CommonCodeModel (object)

Regions

codestring

Code

Example: "ap-northeast-2"

namestring

Code name

Example: "Asia Pacific (Seoul)"

machineTypesarray of CommonCodeModel (object)

Machine Types

codestring

Code

Example: "ap-northeast-2"

namestring

Code name

Example: "Asia Pacific (Seoul)"

resourceTypesarray of CommonCodeModel (object)

Resource Types

codestring

Code

Example: "ap-northeast-2"

namestring

Code name

Example: "Asia Pacific (Seoul)"

productsarray of CommonCodeModel (object)

Products

codestring

Code

Example: "ap-northeast-2"

namestring

Code name

Example: "Asia Pacific (Seoul)"

Request

Response

Get utilization summary of GCP CUD(Committed Use Discount)

Retrieve aggregated utilization summary for GCP CUD(Committed Use Discount).

GEThttps://api.opsnow.io/cost/v3/commitment/companies/{companyId}/vendors/gcp/services/cud/utilizations/aggregated

Authorization

Path parameters

companyId*string

Company ID

Example: 1

Query parameters

dateTypeenum

Date query type

Example: "DAILY"

{DAILY, MONTHLY}

startDate*string

Search start Date

Example: "2020-10-01"

endDate*string

Search end Date

Example: "2020-10-31"

projectsstring

Project IDs

Example: "['pjt-sample-1', 'pjt-sample-2']"

committedTypesstring

CUD types

Example: "['compute#commitment', 'cloudSql#commitment']"

regionsstring

Regions

Example: "['1', '2']"

machineTypesstring

Machine types

Example: "['GENERAL_PURPOSE_E2','GENERAL_PURPOSE']"

productsstring

Products

resourceTypesstring

Resource types

Response

Body

statusstring

errorError (object)

Codeinteger (int32)

Messagestring

dataGcpCommittedUseDiscountUtilizationPaymentModel (object)

utilizationnumber (double)

사용률(%)

commitmentCapacitynumber (double)

약정 사용량

usedCapacitynumber (double)

사용량

commitmentCostnumber (double)

총결재금액($)

usedCommitmentCostnumber (double)

사용 약정 금액

committedUseDiscountOnDemandCostEquivalentnumber (double)

CUD 온디맨드 환산 비용

netSavingsCostnumber (double)

절감 금액

netSavingsRatenumber (double)

절감률

usageDate*string

사용일

Example: "2020-07-01"

utilizationnumber (double)

사용률(%)

commitmentCapacitynumber (double)

약정 사용량

usedCapacitynumber (double)

사용량

commitmentCostnumber (double)

총결재금액($)

usedCommitmentCostnumber (double)

사용 약정 금액

committedUseDiscountOnDemandCostEquivalentnumber (double)

CUD 온디맨드 환산 비용

netSavingsCostnumber (double)

절감 금액

netSavingsRatenumber (double)

절감률

Request

Response

Get coverage data of GCP commitment

Retrieve coverage data of each GCP commitment.

GEThttps://api.opsnow.io/cost/v3/commitment/companies/{companyId}/vendors/gcp/services/cud/coverages

Authorization

Path parameters

companyId*string

Company ID

Example: 1

Query parameters

dateTypeenum

Date query type

Example: "DAILY"

{DAILY, MONTHLY}

startDate*string

Search start Date

Example: "2020-10-01"

endDate*string

Search end Date

Example: "2020-10-31"

projectsstring

Project IDs

Example: "['pjt-sample-1', 'pjt-sample-2']"

committedTypesstring

CUD types

Example: "['compute#commitment', 'cloudSql#commitment']"

regionsstring

Regions

Example: "['1', '2']"

machineTypesstring

Machine types

Example: "['GENERAL_PURPOSE_E2','GENERAL_PURPOSE']"

productsstring

Products

resourceTypesstring

Resource types

Response

Body

statusstring

errorError (object)

Codeinteger (int32)

Messagestring

listarray of GcpCoverageModel (object)

committedUseDiscountCoverageRatenumber (double)

CUD(Committed Use Discount) coverage

totalCostnumber (double)

Total cost

totalOnDemandCostEquivalentnumber (double)

Total usage

totalCreditCostnumber (double)

Total credit cost

totalCommitmentCreditCostnumber (double)

Total commitment credit cost

committedUseDiscountOnDemandCostEquivalentnumber (double)

CUD(Committed Use Discount) applied credit cost

sustainedUseDiscountOnDemandCostEquivalentnumber (double)

SUD(Sustained Use Discount) applied credit cost

etcCreditOnDemandCostEquivalentnumber (double)

Other credit cost

onDemandCostnumber (double)

Cost except Committed Use Discount

projectIdstring

Project ID

projectNamestring

Project name

regionCodestring

Region code

Example: "us-central1"

regionNamestring

Region name

Example: "us-central1"

productCodestring

Product code

productNamestring

Product name

Example: "Compute Engine"

machineTypestring

Machine type

Example: "E2"

commitmentTypeNamestring

Commitment type name

resourceTypestring

Resource type

Example: "vCPU"

Request

Response

Get coverage summary trends of GCP commitment

Retrieve time-series coverage summary for GCP commitment.

GEThttps://api.opsnow.io/cost/v3/commitment/companies/{companyId}/vendors/gcp/services/cud/coverages/time-series/{dateType}

Authorization

Path parameters

companyId*string

Company ID

Example: 1

dateType*string

Date query type

Example: "DAILY"

Query parameters

startDate*string

Search start Date

Example: "2020-10-01"

endDate*string

Search end Date

Example: "2020-10-31"

projectsstring

Project IDs

Example: "['pjt-sample-1', 'pjt-sample-2']"

committedTypesstring

CUD types

Example: "['compute#commitment', 'cloudSql#commitment']"

regionsstring

Regions

Example: "['1', '2']"

machineTypesstring

Machine types

Example: "['GENERAL_PURPOSE_E2','GENERAL_PURPOSE']"

productsstring

Products

resourceTypesstring

Resource types

Response

Body

statusstring

errorError (object)

Codeinteger (int32)

Messagestring

listarray of GcpCoverageTransitionModel (object)

committedUseDiscountCoverageRatenumber (double)

CUD(Committed Use Discount) coverage

totalCostnumber (double)

Total cost

totalOnDemandCostEquivalentnumber (double)

Total usage

totalCreditCostnumber (double)

Total credit cost

totalCommitmentCreditCostnumber (double)

Total commitment credit cost

committedUseDiscountOnDemandCostEquivalentnumber (double)

CUD(Committed Use Discount) applied credit cost

sustainedUseDiscountOnDemandCostEquivalentnumber (double)

SUD(Sustained Use Discount) applied credit cost

etcCreditOnDemandCostEquivalentnumber (double)

Other credit cost

onDemandCostnumber (double)

Cost except Committed Use Discount

usageDate*string

Usage date

Example: "2020-07-01"

Request

Response

Get category list of GCP commitment coverage

Retrieve the categories of GCP commitment coverage. The items within these categories can be used when categorizing the values of commitment related to coverage.

GEThttps://api.opsnow.io/cost/v3/commitment/companies/{companyId}/vendors/gcp/services/cud/coverages/categories

Authorization

Path parameters

companyId*string

Company ID

Example: 1

Query parameters

dateTypeenum

Date query type

Example: "DAILY"

{DAILY, MONTHLY}

startDate*string

Search start Date

Example: "2020-10-01"

endDate*string

Search end Date

Example: "2020-10-31"

projectsstring

Project IDs

Example: "['pjt-sample-1', 'pjt-sample-2']"

committedTypesstring

CUD types

Example: "['compute#commitment', 'cloudSql#commitment']"

regionsstring

Regions

Example: "['1', '2']"

machineTypesstring

Machine types

Example: "['GENERAL_PURPOSE_E2','GENERAL_PURPOSE']"

productsstring

Products

resourceTypesstring

Resource types

Response

Body

statusstring

errorError (object)

Codeinteger (int32)

Messagestring

dataGcpCommittedUseDiscountFilterResultModel (object)

data

projectsarray of CommonCodeModel (object)

Projects

codestring

Code

Example: "ap-northeast-2"

namestring

Code name

Example: "Asia Pacific (Seoul)"

commitmentTypesarray of CommonCodeModel (object)

Commitment Types

codestring

Code

Example: "ap-northeast-2"

namestring

Code name

Example: "Asia Pacific (Seoul)"

regionsarray of CommonCodeModel (object)

Regions

codestring

Code

Example: "ap-northeast-2"

namestring

Code name

Example: "Asia Pacific (Seoul)"

machineTypesarray of CommonCodeModel (object)

Machine Types

codestring

Code

Example: "ap-northeast-2"

namestring

Code name

Example: "Asia Pacific (Seoul)"

resourceTypesarray of CommonCodeModel (object)

Resource Types

codestring

Code

Example: "ap-northeast-2"

namestring

Code name

Example: "Asia Pacific (Seoul)"

productsarray of CommonCodeModel (object)

Products

codestring

Code

Example: "ap-northeast-2"

namestring

Code name

Example: "Asia Pacific (Seoul)"

Request

Response

Get coverage summary of GCP commitment

Retrieve aggregated coverage summary for GCP commitment.

GEThttps://api.opsnow.io/cost/v3/commitment/companies/{companyId}/vendors/gcp/services/cud/coverages/aggregated

Authorization

Path parameters

companyId*string

Company ID

Example: 1

Query parameters

dateTypeenum

Date query type

Example: "DAILY"

{DAILY, MONTHLY}

startDate*string

Search start Date

Example: "2020-10-01"

endDate*string

Search end Date

Example: "2020-10-31"

projectsstring

Project IDs

Example: "['pjt-sample-1', 'pjt-sample-2']"

committedTypesstring

CUD types

Example: "['compute#commitment', 'cloudSql#commitment']"

regionsstring

Regions

Example: "['1', '2']"

machineTypesstring

Machine types

Example: "['GENERAL_PURPOSE_E2','GENERAL_PURPOSE']"

productsstring

Products

resourceTypesstring

Resource types

Response

Body

statusstring

errorError (object)

Codeinteger (int32)

Messagestring

dataGcpCoverageValueModel (object)

committedUseDiscountCoverageRatenumber (double)

CUD(Committed Use Discount) coverage

totalCostnumber (double)

Total cost

totalOnDemandCostEquivalentnumber (double)

Total usage

totalCreditCostnumber (double)

Total credit cost

totalCommitmentCreditCostnumber (double)

Total commitment credit cost

committedUseDiscountOnDemandCostEquivalentnumber (double)

CUD(Committed Use Discount) applied credit cost

sustainedUseDiscountOnDemandCostEquivalentnumber (double)

SUD(Sustained Use Discount) applied credit cost

etcCreditOnDemandCostEquivalentnumber (double)

Other credit cost

onDemandCostnumber (double)

Cost except Committed Use Discount

Request

Response

Get result list of GCP CUD recommendation

Retrieve results of GCP(Google Cloud Platform) CUD(Committed Use Discounts) recommendations

GEThttps://api.opsnow.io/cost/v3/commitment/companies/{companyId}/vendors/gcp/services/{service}/recommendations

Authorization

Path parameters

companyId*string

Company ID

Example: 1

service*string

Response

Body

statusstring

errorError (object)

Codeinteger (int32)

Messagestring

dataarray of GcpRecommenderInventoryModel (object)

GCP Recommendation list

accountIdstring

Account ID

Example: "123456789012"

accountAliasstring

Name of account

Example: "Bespinglobal Platform"

productstring

Instance type

Example: "c4.xlarge"

projectIdstring

Project ID

Example: "opsnow-global-prd"

recommendationIdstring

Recommendation ID

Example: "0a2e6861-fd68-4e2e-8232-1e14e816deec"

recommendTypestring

Recommend Type

Example: "GENERAL_PURPOSE"

recommendAmountnumber (double)

Recommended Resource Amount

Example: 1024

recommendActionstring

Recommended Resource Amount

Example: "1024"

recommendStatusstring

Recommended Status

Example: "ACTIVE"

recommendDescriptionstring

Recommended Description

Example: "Purchase a 1 year RAM commitment for region us-central1"

resourceTypestring

Resource Type

Example: "MEMORY"

expectedCostnumber (double)

Expected Reduction Cost

Example: -0.800516

planstring

Commitment Plan

Example: "TWELVE_MONTH"

termLengthstring

Commitment terms

Example: "1yr"

goalstring

Recommended Commitment Goal

Example: "LOW_WATERMARK"

regionIdstring

Region ID

Example: "us-central1"

regionNamestring

Region name

Example: "Council Bluffs, Iowa"

regionCategorystring

Region category

Example: "North America"

insightIdstring

Insight ID

Example: "1377dfe4-f62d-4074-b52a-93a64a5a1b9d"

monthCommitmentnumber (double)

Monthly commitment cost

monthSaveCostnumber (double)

Monthly net savings cost

onDemandCostnumber (double)

Used On-Demand cost

Request

Response

Get purchase option information of GCP CUD recommendation

Retrieve the cost information based on GCP(Google Cloud Platform) CUD(Committed Use Discounts) purchase options and their corresponding purchase outcomes.

GEThttps://api.opsnow.io/cost/v3/commitment/companies/{companyId}/vendors/gcp/services/{service}/recommendations/purchase-options

Authorization

Path parameters

companyId*string

Company ID

Example: 1

service*string

Response

Body

statusstring

errorError (object)

Codeinteger (int32)

Messagestring

dataarray of GcpRecommenderOptionsModel (object)

Purchase option list

goalstring

Recommended Commitment Goal

Example: "LOW_WATERMARK"

planstring

Commitment Plan

Example: "TWELVE_MONTH"

termLengthstring

Commitment terms

Example: "1yr"

currencystring

Currency

Example: "USD"

expectedCostnumber (double)

Expected Reduction Cost

Example: -0.800516

recommendAmountnumber (double)

Recommended Resource Amount

Example: 1024

monthCommitmentnumber (double)

Monthly commitment cost

monthSaveCostnumber (double)

Monthly net savings cost

onDemandCostnumber (double)

Used On-Demand cost

Request

Response

Optimization Grid View

Grid detail data inquiry according to optimization category and resource type

POSThttps://api.opsnow.io/asset/us-v1/optimization/detail/list/info

Authorization

Body

cmpnId*Company id

Company id

Example: "1"

optimizeCategory*Optimization category

right-sizingunused

accountId*Account Id

Example: "000000000000"

regionId*Region Id

Example: "ap-northeast-2"

instanceId*Instance Id

Example: "vol-00000"

resourceType*Resource type

Example: "ebs"

vendor*Cloud vendor

Example: "aws"

awsazugcpalincpociopenstack

recommend*Recommend Type

Example: "idle"

Response

Body

statusstring

errorErrorModel (object)

codestring

messagestring

Request

const response = await fetch('https://api.opsnow.io/asset/us-v1/optimization/detail/list/info', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer <token>",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "accountId": "000000000000",
      "cmpnId": "1",
      "instanceId": "vol-00000",
      "optimizeCategory": "right-sizing",
      "recommend": "idle",
      "regionId": "ap-northeast-2",
      "resourceType": "ebs",
      "vendor": "aws"
    }),
});
const data = await response.json();

Response

{
  "status": "text",
  "error": {
    "code": "text",
    "message": "text"
  }
}

POSThttps://api.opsnow.io/asset/us-v1/{menu}/{vendor}/grid-headers/{viewType}

Authorization

Path parameters

menu*string

Example: "usage"

vendor*string

vendor

Example: "aws"

viewType*string

view type

Example: "history"

Body

cmpnId*Company id

Company id

Example: "1"

rsrcTypeResource Type

Resource Type

Example: "ec2"

vendorVendor

Vendor

Example: "aws"

viewTypeView Type

View Type(current, history)

Example: "history"

menuMenu

Example: "usage"

Response

Body

statusstring

errorErrorModel (object)

codestring

messagestring

Request

const response = await fetch('https://api.opsnow.io/asset/us-v1/{menu}/{vendor}/grid-headers/{viewType}', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer <token>",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "cmpnId": "1"
    }),
});
const data = await response.json();

Response

{
  "status": "text",
  "error": {
    "code": "text",
    "message": "text"
  }
}

Optimization Grid View

Grid data inquiry according to optimization category and resource type

POSThttps://api.opsnow.io/asset/us-v1/optimization/detail/list

Authorization

Body

cmpnId*Company id

Company id

Example: "1"

optimizeCategory*Optimization category

Optimization category

right-sizingunused

resourceType*Resource type

Resource type

Example: "ec2"

vendor*Cloud vendor

Cloud vendor

awsazugcpalincpociopenstack

accountListList of accounts to filter optimization results for

List of accounts to filter optimization results for

itemsList of accounts to filter optimization results for

List of accounts to filter optimization results for

regionListList of regions to filter optimization results for

List of regions to filter optimization results for

itemsList of regions to filter optimization results for

List of regions to filter optimization results for

serviceGroupListList of serviceGroups to filter optimization results for

List of serviceGroups to filter optimization results for

itemsList of serviceGroups to filter optimization results for

List of serviceGroups to filter optimization results for

tagListList of tags to filter optimization results for

List of tags to filter optimization results for

keyTag Key

Tag Key

Example: "Name"

valueTag Values

Tag Values

itemsTag Values

Tag Values

Response

Body

statusstring

errorErrorModel (object)

codestring

messagestring

Request

const response = await fetch('https://api.opsnow.io/asset/us-v1/optimization/detail/list', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer <token>",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "cmpnId": "1",
      "optimizeCategory": "right-sizing",
      "resourceType": "ec2",
      "vendor": "aws"
    }),
});
const data = await response.json();

Response

{
  "status": "text",
  "error": {
    "code": "text",
    "message": "text"
  }
}

Optimization Chart View

View optimization charts by optimization category and resource type

POSThttps://api.opsnow.io/asset/us-v1/optimization/detail/chart

Authorization

Body

cmpnId*Company id

Company id

Example: "1"

optimizeCategory*Optimization category

Optimization category

right-sizingunused

resourceType*Resource type

Resource type

Example: "ec2"

vendor*Cloud vendor

Cloud vendor

awsazugcpalincpociopenstack

accountListList of accounts to filter optimization results for

List of accounts to filter optimization results for

itemsList of accounts to filter optimization results for

List of accounts to filter optimization results for

regionListList of regions to filter optimization results for

List of regions to filter optimization results for

itemsList of regions to filter optimization results for

List of regions to filter optimization results for

serviceGroupListList of serviceGroups to filter optimization results for

List of serviceGroups to filter optimization results for

itemsList of serviceGroups to filter optimization results for

List of serviceGroups to filter optimization results for

tagListList of tags to filter optimization results for

List of tags to filter optimization results for

keyTag Key

Tag Key

Example: "Name"

valueTag Values

Tag Values

itemsTag Values

Tag Values

Response

Body

statusstring

errorErrorModel (object)

codestring

messagestring

Request

const response = await fetch('https://api.opsnow.io/asset/us-v1/optimization/detail/chart', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer <token>",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "cmpnId": "1",
      "optimizeCategory": "right-sizing",
      "resourceType": "ec2",
      "vendor": "aws"
    }),
});
const data = await response.json();

Response

{
  "status": "text",
  "error": {
    "code": "text",
    "message": "text"
  }
}

Last optimization date lookup

Queries the last time resource optimization was performed.

POSThttps://api.opsnow.io/asset/us-v1/optimization/summary/last-execute

Authorization

Body

cmpnId*Company id

Company id

Example: "1"

optimizeCategory*Optimization category

Optimization category

right-sizingunused

resourceType*Resource type

Resource type

Example: "ec2"

vendor*Cloud vendor

Cloud vendor

awsazugcpalincpociopenstack

accountListList of accounts to filter optimization results for

List of accounts to filter optimization results for

itemsList of accounts to filter optimization results for

List of accounts to filter optimization results for

regionListList of regions to filter optimization results for

List of regions to filter optimization results for

itemsList of regions to filter optimization results for

List of regions to filter optimization results for

serviceGroupListList of serviceGroups to filter optimization results for

List of serviceGroups to filter optimization results for

itemsList of serviceGroups to filter optimization results for

List of serviceGroups to filter optimization results for

tagListList of tags to filter optimization results for

List of tags to filter optimization results for

keyTag Key

Tag Key

Example: "Name"

valueTag Values

Tag Values

itemsTag Values

Tag Values

Response

Body

dataLastExecuteDateResultModel (object)

lastExecuteDatestring (date-time)

statusstring

errorErrorModel (object)

codestring

messagestring

Request

const response = await fetch('https://api.opsnow.io/asset/us-v1/optimization/summary/last-execute', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer <token>",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "cmpnId": "1",
      "optimizeCategory": "right-sizing",
      "resourceType": "ec2",
      "vendor": "aws"
    }),
});
const data = await response.json();

Response

{
  "data": {
    "lastExecuteDate": "2024-12-21T16:24:44.403Z"
  },
  "status": "text",
  "error": {
    "code": "text",
    "message": "text"
  }
}

Usage Current Chart Data

View Current Usage Chart Data

POSThttps://api.opsnow.io/asset/us-v1/usage/{prvrCd}/chart/pie/current

Authorization

Path parameters

prvrCd*enum

Vendor

Example: "aws"

awsazugcpalincpociopenstack

Body

cmpnId*Company id

Company id

Example: "1"

rsrcType*Resource Type

Resource Type

Example: "ec2"

prvrCd*Vendor

Vendor

Example: "aws"

rsrcNmResource Name

Resource Name

Example: "test"

regionsRegions

Regions

itemsRegions

Regions

svcGrpsService Groups

Service Groups

itemsService Groups

Service Groups

accountsAccounts

Accounts

itemsAccounts

Accounts

tagsTags

Tags

keyTag Key

Tag Key

Example: "Name"

valueTag Values

Tag Values

itemsTag Values

Tag Values

reqTypestring

delChkWhether to exclude deleted resources

Whether to exclude deleted resources

Example: "Y"

Response

Body

statusstring

errorErrorModel (object)

codestring

messagestring

Request

const response = await fetch('https://api.opsnow.io/asset/us-v1/usage/{prvrCd}/chart/pie/current', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer <token>",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "cmpnId": "1",
      "prvrCd": "aws",
      "rsrcType": "ec2"
    }),
});
const data = await response.json();

Response

{
  "status": "text",
  "error": {
    "code": "text",
    "message": "text"
  }
}

Usage History Chart Data

View History Usage Chart Data

POSThttps://api.opsnow.io/asset/us-v1/usage/{prvrCd}/chart/history

Authorization

Path parameters

prvrCd*enum

Vendor

Example: "aws"

awsazugcpalincpociopenstack

Body

cmpnId*Company id

Company id

Example: "1"

from*From Date

From Date

Example: "2024-09-11"

to*To Date

To Date

Example: "2024-09-25"

rsrcType*Resource Type

Resource Type

Example: "ec2"

prvrCd*Vendor

Vendor

Example: "aws"

regionsRegions

Regions

itemsRegions

Regions

svcGrpsService Groups

Service Groups

itemsService Groups

Service Groups

accountsAccounts

Accounts

itemsAccounts

Accounts

tagsTags

Tags

keyTag Key

Tag Key

Example: "Name"

valueTag Values

Tag Values

itemsTag Values

Tag Values

viewType*View Type

View Type(hour, day, week, month)

Example: "day"

Response

Body

statusstring

errorErrorModel (object)

codestring

messagestring

Request

const response = await fetch('https://api.opsnow.io/asset/us-v1/usage/{prvrCd}/chart/history', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer <token>",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "cmpnId": "1",
      "from": "2024-09-11",
      "prvrCd": "aws",
      "rsrcType": "ec2",
      "to": "2024-09-25",
      "viewType": "day"
    }),
});
const data = await response.json();

Response

{
  "status": "text",
  "error": {
    "code": "text",
    "message": "text"
  }
}

Filter Data Quick Search For Usage

View Filter Data Quick Search For Usage

PUThttps://api.opsnow.io/asset/us-v1/elastic/filter/{menuId}

Authorization

Path parameters

menuId*string

Menu Id

Example: "usage"

Body

cmpnId*Company id

Company id

Example: "1"

actionType*Action Type

Action Type(current, history)

Example: "current"

keyList*ES Search Key List

ES Search Key List

vndr*Vendor

Vendor

Example: "aws"

key*ES Key

ES Key

Example: "vendors"

value*ES Value

ES Value

Example: "aws"

selectYnSelected or not

Selected or not

Example: "enabled"

Response

Body

resultQuickSearchFilterModel (object)

vendorsarray of ES Search Key List

vndr*Vendor

Vendor

Example: "aws"

key*ES Key

ES Key

Example: "vendors"

value*ES Value

ES Value

Example: "aws"

selectYnSelected or not

Selected or not

Example: "enabled"

accountsarray of ES Search Key List

vndr*Vendor

Vendor

Example: "aws"

key*ES Key

ES Key

Example: "vendors"

value*ES Value

ES Value

Example: "aws"

selectYnSelected or not

Selected or not

Example: "enabled"

regionsarray of ES Search Key List

vndr*Vendor

Vendor

Example: "aws"

key*ES Key

ES Key

Example: "vendors"

value*ES Value

ES Value

Example: "aws"

selectYnSelected or not

Selected or not

Example: "enabled"

productsarray of ES Search Key List

vndr*Vendor

Vendor

Example: "aws"

key*ES Key

ES Key

Example: "vendors"

value*ES Value

ES Value

Example: "aws"

selectYnSelected or not

Selected or not

Example: "enabled"

svcGrpsarray of ES Search Key List

vndr*Vendor

Vendor

Example: "aws"

key*ES Key

ES Key

Example: "vendors"

value*ES Value

ES Value

Example: "aws"

selectYnSelected or not

Selected or not

Example: "enabled"

tagsarray of KeyValueTagModel (object)

vndrVendor

Vendor

Example: "aws"

keyTag Key

Tag Key

Example: "Name"

valueTag Value

Tag Value

Example: "test"

statusstring

errorErrorModel (object)

codestring

messagestring

Request

const response = await fetch('https://api.opsnow.io/asset/us-v1/elastic/filter/{menuId}', {
    method: 'PUT',
    headers: {
      "Authorization": "Bearer <token>",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "actionType": "current",
      "cmpnId": "1",
      "keyList": [
        {
          "key": "vendors",
          "value": "aws",
          "vndr": "aws"
        }
      ]
    }),
});
const data = await response.json();

Response

{
  "result": {
    "vendors": [
      {
        "vndr": "aws",
        "key": "vendors",
        "value": "aws",
        "selectYn": "enabled"
      }
    ],
    "accounts": [
      {
        "vndr": "aws",
        "key": "vendors",
        "value": "aws",
        "selectYn": "enabled"
      }
    ],
    "regions": [
      {
        "vndr": "aws",
        "key": "vendors",
        "value": "aws",
        "selectYn": "enabled"
      }
    ],
    "products": [
      {
        "vndr": "aws",
        "key": "vendors",
        "value": "aws",
        "selectYn": "enabled"
      }
    ],
    "svcGrps": [
      {
        "vndr": "aws",
        "key": "vendors",
        "value": "aws",
        "selectYn": "enabled"
      }
    ],
    "tags": [
      {
        "vndr": "aws",
        "key": "Name",
        "value": "test"
      }
    ]
  },
  "status": "text",
  "error": {
    "code": "text",
    "message": "text"
  }
}

View top card area by optimization category

Search the top card area data for each optimization category.

POSThttps://api.opsnow.io/asset/us-v1/optimization/summary/card

Authorization

Body

cmpnId*Company id

Company id

Example: "1"

optimizeCategory*Optimization category

Optimization category

right-sizingunused

resourceType*Resource type

Resource type

Example: "ec2"

vendor*Cloud vendor

Cloud vendor

awsazugcpalincpociopenstack

accountListList of accounts to filter optimization results for

List of accounts to filter optimization results for

itemsList of accounts to filter optimization results for

List of accounts to filter optimization results for

regionListList of regions to filter optimization results for

List of regions to filter optimization results for

itemsList of regions to filter optimization results for

List of regions to filter optimization results for

serviceGroupListList of serviceGroups to filter optimization results for

List of serviceGroups to filter optimization results for

itemsList of serviceGroups to filter optimization results for

List of serviceGroups to filter optimization results for

tagListList of tags to filter optimization results for

List of tags to filter optimization results for

keyTag Key

Tag Key

Example: "Name"

valueTag Values

Tag Values

itemsTag Values

Tag Values

Response

Body

dataarray of OptimizeSummaryInfoModel (object)

resourceTypestring

expectedSavingCostnumber (double)

expectedSavingCountinteger (int32)

statusstring

errorErrorModel (object)

codestring

messagestring

Request

const response = await fetch('https://api.opsnow.io/asset/us-v1/optimization/summary/card', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer <token>",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "cmpnId": "1",
      "optimizeCategory": "right-sizing",
      "resourceType": "ec2",
      "vendor": "aws"
    }),
});
const data = await response.json();

Response

{
  "data": [
    {
      "resourceType": "text",
      "expectedSavingCost": 0,
      "expectedSavingCount": 0
    }
  ],
  "status": "text",
  "error": {
    "code": "text",
    "message": "text"
  }
}

View top filter area by vendor

Search the top filter area data for each vendor.

PUThttps://api.opsnow.io/asset/us-v1/optimization/summary/filter

Authorization

Body

cmpnId*Company id

Company id

Example: "1"

actionType*Action Type

Action Type(current, history)

Example: "current"

keyList*ES Search Key List

ES Search Key List

vndr*Vendor

Vendor

Example: "aws"

key*ES Key

ES Key

Example: "vendors"

value*ES Value

ES Value

Example: "aws"

selectYnSelected or not

Selected or not

Example: "enabled"

Response

Body

dataQuickSearchFilterModel (object)

vendorsarray of ES Search Key List

vndr*Vendor

Vendor

Example: "aws"

key*ES Key

ES Key

Example: "vendors"

value*ES Value

ES Value

Example: "aws"

selectYnSelected or not

Selected or not

Example: "enabled"

accountsarray of ES Search Key List

vndr*Vendor

Vendor

Example: "aws"

key*ES Key

ES Key

Example: "vendors"

value*ES Value

ES Value

Example: "aws"

selectYnSelected or not

Selected or not

Example: "enabled"

regionsarray of ES Search Key List

vndr*Vendor

Vendor

Example: "aws"

key*ES Key

ES Key

Example: "vendors"

value*ES Value

ES Value

Example: "aws"

selectYnSelected or not

Selected or not

Example: "enabled"

productsarray of ES Search Key List

vndr*Vendor

Vendor

Example: "aws"

key*ES Key

ES Key

Example: "vendors"

value*ES Value

ES Value

Example: "aws"

selectYnSelected or not

Selected or not

Example: "enabled"

svcGrpsarray of ES Search Key List

vndr*Vendor

Vendor

Example: "aws"

key*ES Key

ES Key

Example: "vendors"

value*ES Value

ES Value

Example: "aws"

selectYnSelected or not

Selected or not

Example: "enabled"

tagsarray of KeyValueTagModel (object)

vndrVendor

Vendor

Example: "aws"

keyTag Key

Tag Key

Example: "Name"

valueTag Value

Tag Value

Example: "test"

statusstring

errorErrorModel (object)

codestring

messagestring

Request

const response = await fetch('https://api.opsnow.io/asset/us-v1/optimization/summary/filter', {
    method: 'PUT',
    headers: {
      "Authorization": "Bearer <token>",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "actionType": "current",
      "cmpnId": "1",
      "keyList": [
        {
          "key": "vendors",
          "value": "aws",
          "vndr": "aws"
        }
      ]
    }),
});
const data = await response.json();

Response

{
  "data": {
    "vendors": [
      {
        "vndr": "aws",
        "key": "vendors",
        "value": "aws",
        "selectYn": "enabled"
      }
    ],
    "accounts": [
      {
        "vndr": "aws",
        "key": "vendors",
        "value": "aws",
        "selectYn": "enabled"
      }
    ],
    "regions": [
      {
        "vndr": "aws",
        "key": "vendors",
        "value": "aws",
        "selectYn": "enabled"
      }
    ],
    "products": [
      {
        "vndr": "aws",
        "key": "vendors",
        "value": "aws",
        "selectYn": "enabled"
      }
    ],
    "svcGrps": [
      {
        "vndr": "aws",
        "key": "vendors",
        "value": "aws",
        "selectYn": "enabled"
      }
    ],
    "tags": [
      {
        "vndr": "aws",
        "key": "Name",
        "value": "test"
      }
    ]
  },
  "status": "text",
  "error": {
    "code": "text",
    "message": "text"
  }
}

Usage History Grid Data

View History Usage Grid Data

POSThttps://api.opsnow.io/asset/us-v1/usage/{prvrCd}/grid/history

Authorization

Path parameters

prvrCd*enum

Vendor

Example: "aws"

awsazugcpalincpociopenstack

Body

cmpnId*Company id

Company id

Example: "1"

limitCntPage Limit Count

Page Limit Count

Example: 1

pageNumPage Number Count

Page Number Count

Example: 1

offsetPage Offset

Page Offset

Example: 1

totalCntPage Total Count

Page Total Count

Example: 1

from*From Date

From Date

Example: "2024-09-11"

to*To Date

To Date

Example: "2024-09-25"

sortColId*Sort Column ID

Sort Column ID

Example: "histDt"

sortDirection*Sort Direction

Sort Direction

Example: "desc"

excelYn*Whether to download Excel

Whether to download Excel

Example: "N"

rsrcType*Resource Type

Resource Type

Example: "ec2"

prvrCd*Vendor

Vendor

Example: "aws"

isGetHeaderHeader or not

Header or not

Example: "Y"

viewType*View Type

View Type(hour, day, week, month)

Example: "day"

langCdLanguage Code

Language Code

Example: "en"

hasHistoryViewWhether to check history or not

Whether to check history or not

Example: true

searchTextSearch Text

Search Text

Example: "test"

fieldListField List

Field List

itemsField List

Field List

regionsRegions

Regions

itemsRegions

Regions

svcGrpsService Groups

Service Groups

itemsService Groups

Service Groups

accountsAccounts

Accounts

itemsAccounts

Accounts

tagsTags

Tags

keyTag Key

Tag Key

Example: "Name"

valueTag Values

Tag Values

itemsTag Values

Tag Values

Response

Body

statusstring

errorErrorModel (object)

codestring

messagestring

Request

const response = await fetch('https://api.opsnow.io/asset/us-v1/usage/{prvrCd}/grid/history', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer <token>",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "cmpnId": "1",
      "excelYn": "N",
      "from": "2024-09-11",
      "prvrCd": "aws",
      "rsrcType": "ec2",
      "sortColId": "histDt",
      "sortDirection": "desc",
      "to": "2024-09-25",
      "viewType": "day"
    }),
});
const data = await response.json();

Response

{
  "status": "text",
  "error": {
    "code": "text",
    "message": "text"
  }
}

Usage Current Grid Data

View Current Usage Grid Data

POSThttps://api.opsnow.io/asset/us-v1/usage/{prvrCd}/grid/current

Authorization

Path parameters

prvrCd*enum

Vendor

Example: "aws"

awsazugcpalincpociopenstack

Body

cmpnId*Company id

Company id

Example: "1"

rgnIdRegion Id

Region Id

Example: "ap-northeast-2"

limitCntPage Limit Count

Page Limit Count

Example: 1

pageNumPage Number Count

Page Number Count

Example: 1

offsetPage Offset

Page Offset

Example: 1

totalCntPage Total Count

Page Total Count

Example: 1

sortColIdSort Column ID

Sort Column ID

Example: "seq"

sortDirectionSort Direction

Sort Direction

Example: "desc"

excelYnWhether to download Excel

Whether to download Excel

Example: "N"

rsrcType*Resource Type

Resource Type

Example: "ec2"

prvrCd*Vendor

Vendor

Example: "aws"

viewTypeView Type

View Type(hour, day, week, month)

Example: "day"

fromFrom Date

From Date

Example: "2024-09-11"

toTo Date

To Date

Example: "2024-09-25"

searchTextSearch Text

Search Text

Example: "test"

isGetHeaderHeader or not

Header or not

Example: "Y"

fieldListField List

Field List

itemsField List

Field List

regionsRegions

Regions

itemsRegions

Regions

svcGrpsService Groups

Service Groups

itemsService Groups

Service Groups

accountsAccounts

Accounts

itemsAccounts

Accounts

tagsTags

Tags

keyTag Key

Tag Key

Example: "Name"

valueTag Values

Tag Values

itemsTag Values

Tag Values

svcGrpViewService Group View Id

Service Group View Id

Example: "Default"

langCdLanguage Code

Language Code

Example: "en"

rsrcSeqResource Seq

Resource Seq

Example: "0"

headerTypeHeader Type

Header Type

Example: "single"

isResourceResource or Not

Resource or Not

Example: "N"

rsrcNmResource Name

Resource Name

Example: "test"

hasHistoryViewWhether to check history or not

Whether to check history or not

Example: true

delChkWhether to exclude deleted resources

Whether to exclude deleted resources

Example: "Y"

Response

Body

statusstring

errorErrorModel (object)

codestring

messagestring

Request

const response = await fetch('https://api.opsnow.io/asset/us-v1/usage/{prvrCd}/grid/current', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer <token>",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "cmpnId": "1",
      "prvrCd": "aws",
      "rsrcType": "ec2"
    }),
});
const data = await response.json();

Response

{
  "status": "text",
  "error": {
    "code": "text",
    "message": "text"
  }
}

Cloud account status

View cloud accounts and status from specific vendor

POSThttps://api.opsnow.io/cost/v3/billing/overview/accounts

Authorization

Body

siteCode*site code

site code

Example: "BESPIN"

companyId*company id

company id

Example: "1"

userIduser id

user id

Example: "abcd"

vendor*vendor

vendor

Example: "AWS"

Response

Body

statusAPI Response Status

API Response Status

Example: "success"

errorAPI Response of Error

API Response of Error

codeError Code

Error Code

messageError Message

Error Message

Example: "Error Message"

Request

Response

Anomaly detection history detailed notification result

View abnormal cost detection notification sent history

POSThttps://api.opsnow.io/cost/v3/billing/anomaly/history/detail/sent

Authorization

Body

siteCode*site code

site code

Example: "BESPIN"

companyId*company id

company id

Example: "1"

userIduser id

user id

Example: "abcd"

histSeq*History Seq

History Seq

Example: 0

ruleSeq*Anomaly Rule Seq

Anomaly Rule Seq

Example: 0

Response

Body

statusAPI Response Status

API Response Status

Example: "success"

errorAPI Response of Error

API Response of Error

codeError Code

Error Code

messageError Message

Error Message

Example: "Error Message"

Request

Response

Anomaly detection history detail result and period chart

View abnormal cost detection history details and pie chart data

POSThttps://api.opsnow.io/cost/v3/billing/anomaly/history/detail/result

Authorization

Body

siteCode*site code

site code

Example: "BESPIN"

companyId*company id

company id

Example: "1"

userIduser id

user id

Example: "abcd"

histSeq*History Seq

History Seq

Example: 0

ruleSeq*Anomaly Rule Seq

Anomaly Rule Seq

Example: 0

Response

Body

statusAPI Response Status

API Response Status

Example: "success"

errorAPI Response of Error

API Response of Error

codeError Code

Error Code

messageError Message

Error Message

Example: "Error Message"

Request

Response

Anomaly detection history

View abnormal cost detection history list

POSThttps://api.opsnow.io/cost/v3/billing/anomaly/history/list

Authorization

Body

siteCode*site code

site code

Example: "BESPIN"

companyId*company id

company id

Example: "1"

userIduser id

user id

Example: "abcd"

analyzeBy*analyze by

Abnormal Cost Analysis Type

Example: "account"

analyzeType*analyze type

Abnormal Cost AI/Manual Type

Example: "manual"

Response

Body

statusAPI Response Status

API Response Status

Example: "success"

errorAPI Response of Error

API Response of Error

codeError Code

Error Code

messageError Message

Error Message

Example: "Error Message"

Request

Response

Anomaly detection history detailed total daily grid list

View ai/manual abnormal cost detection daily grid data

POSThttps://api.opsnow.io/cost/v3/billing/anomaly/history/detail/{analyzeType}/grid

Authorization

Path parameters

analyzeType*string

Analyze Type

Example: "ai"

Body

siteCode*site code

site code

Example: "BESPIN"

companyId*company id

company id

Example: "1"

userIduser id

user id

Example: "abcd"

histSeq*History Seq

History Seq

Example: 0

ruleSeq*Anomaly Rule Seq

Anomaly Rule Seq

Example: 0

Response

Body

statusAPI Response Status

API Response Status

Example: "success"

errorAPI Response of Error

API Response of Error

codeError Code

Error Code

messageError Message

Error Message

Example: "Error Message"

Request

Response

Summary of detected anomalies

View the number of triggered alerts and abnormal cost information by cloud vendor and type.

POSThttps://api.opsnow.io/cost/v3/billing/anomaly/vendors/{vendor}/aggregate

Authorization

Path parameters

vendor*string

Vendor

Example: "AWS"

Body

siteCode*site code

site code

Example: "BESPIN"

companyId*company id

company id

Example: "1"

userIduser id

user id

Example: "abcd"

vendors*List of vendors

List of vendors

itemsList of vendors

List of vendors

Example: "[\"AWS\"]"

Response

Body

statusAPI Response Status

API Response Status

Example: "success"

errorAPI Response of Error

API Response of Error

codeError Code

Error Code

messageError Message

Error Message

Example: "Error Message"

Request

Response

Summary of detected anomalies

View the number of triggered alerts and abnormal cost information by cloud vendor and type.

POSThttps://api.opsnow.io/cost/v3/billing/anomaly/vendors/aggregate

Authorization

Body

siteCode*site code

site code

Example: "BESPIN"

companyId*company id

company id

Example: "1"

userIduser id

user id

Example: "abcd"

vendors*List of vendors

List of vendors

itemsList of vendors

List of vendors

Example: "[\"AWS\"]"

Response

Body

statusAPI Response Status

API Response Status

Example: "success"

errorAPI Response of Error

API Response of Error

codeError Code

Error Code

messageError Message

Error Message

Example: "Error Message"

Request

Response

Anomaly detection rules

View the rules for detecting anomalies and sending alerts.

POSThttps://api.opsnow.io/cost/v3/billing/anomaly/vendors/detections/alerts/rule

Authorization

Body

siteCode*site code

site code

Example: "BESPIN"

companyId*company id

company id

Example: "1"

companyNamecompany name

company name

Example: "1"

defaultVendor*default vendor

default vendor

Example: "AWS"

userEmailuser email

user email

Example: "abcd@bespingloba.com"

userIduser id

user id

Example: "abcd"

userNameuser name

user name

Example: "abcd"

vendorvendor

vendor

Example: "AWS"

Response

Body

statusAPI Response Status

API Response Status

Example: "success"

errorAPI Response of Error

API Response of Error

codeError Code

Error Code

messageError Message

Error Message

Example: "Error Message"

Request

Response

Latest cost collection date

View the latest cloud costs collection date of each vendor.

POSThttps://api.opsnow.io/cost/v3/billing/overview/companyMaxDate

Authorization

Body

siteCode*site code

site code

Example: "BESPIN"

companyId*company id

company id

Example: "1"

companyNamecompany name

company name

Example: "1"

defaultVendor*default vendor

default vendor

Example: "AWS"

userEmailuser email

user email

Example: "abcd@bespingloba.com"

userIduser id

user id

Example: "abcd"

userNameuser name

user name

Example: "abcd"

vendorvendor

vendor

Example: "AWS"

Response

Body

statusAPI Response Status

API Response Status

Example: "success"

errorAPI Response of Error

API Response of Error

codeError Code

Error Code

messageError Message

Error Message

Example: "Error Message"

Request

Response

Cloud cost overview

View cloud costs from the previous period and the estimated costs for the current month.

POSThttps://api.opsnow.io/cost/v3/billing/overview/spend

Authorization

Body

siteCode*site code

site code

Example: "BESPIN"

companyId*company id

company id

Example: "1"

companyNamecompany name

company name

Example: "1"

defaultVendor*default vendor

default vendor

Example: "AWS"

userEmailuser email

user email

Example: "abcd@bespingloba.com"

userIduser id

user id

Example: "abcd"

userNameuser name

user name

Example: "abcd"

vendorvendor

vendor

Example: "AWS"

selectedVendor*selected Vendor

selected Vendor

Example: "AWS"

Response

Body

statusAPI Response Status

API Response Status

Example: "success"

errorAPI Response of Error

API Response of Error

codeError Code

Error Code

messageError Message

Error Message

Example: "Error Message"

Request

Response

Manual anomaly detection history detail result and period chart

View manual abnormal cost detection history details and pie chart data inquiry

POSThttps://api.opsnow.io/cost/v3/billing/anomaly/history/detail/manual/period-chart

Authorization

Body

siteCode*site code

site code

Example: "BESPIN"

companyId*company id

company id

Example: "1"

userIduser id

user id

Example: "abcd"

histSeq*History Seq

History Seq

Example: 0

ruleSeq*Anomaly Rule Seq

Anomaly Rule Seq

Example: 0

Response

Body

statusAPI Response Status

API Response Status

Example: "success"

errorAPI Response of Error

API Response of Error

codeError Code

Error Code

messageError Message

Error Message

Example: "Error Message"

Request

Response

Filter of Cost Analytics

View Cost Analytics filter

POSThttps://api.opsnow.io/cost/v3/billing/analytics/filter

Authorization

Body

siteCode*site code

site code

Example: "BESPIN"

companyId*company id

company id

Example: "1"

userIduser id

user id

Example: "abcd"

conditions*Cost Analytics Filters

Cost Analytics Filters

awsAwsCostAnalyticsFilter (object)

linkedAccountIdarray of string

itemsstring

productCodearray of string

itemsstring

regionarray of string

itemsstring

productFamilyarray of string

itemsstring

tagsarray of Tag (object)

tagKeystring

tagValuestring

serviceGrouparray of ServiceGroup (object)

serviceGroupKeystring

serviceGroupValuestring

serviceGroupSetNmstring

serviceGroupSetIdstring

serviceGroupNmstring

serviceGroupIdstring

dfltYnstring

instanceTypearray of string

itemsstring

instanceTypeFamilyarray of string

itemsstring

chargeTypearray of string

itemsstring

osarray of string

itemsstring

databasearray of string

itemsstring

transferTypearray of string

itemsstring

purchaseOptionarray of string

itemsstring

apiOperationarray of string

itemsstring

resourceIdarray of string

itemsstring

usageTypearray of string

itemsstring

invoiceIdarray of string

itemsstring

itemDescriptionarray of string

itemsstring

cacheEnginearray of string

itemsstring

availabilityZonearray of string

itemsstring

platformarray of string

itemsstring

azureAzureCostAnalyticsFilter (object)

linkedAccountIdarray of string

itemsstring

productCodearray of string

itemsstring

regionarray of string

itemsstring

productFamilyarray of string

itemsstring

tagsarray of Tag (object)

tagKeystring

tagValuestring

serviceGrouparray of ServiceGroup (object)

serviceGroupKeystring

serviceGroupValuestring

serviceGroupSetNmstring

serviceGroupSetIdstring

serviceGroupNmstring

serviceGroupIdstring

dfltYnstring

subscriptionNmarray of string

itemsstring

subscriptionIdarray of string

itemsstring

infraTypearray of string

itemsstring

mtCategoryarray of string

itemsstring

mtNamearray of string

itemsstring

usagearray of string

itemsstring

unitPricearray of string

itemsstring

totalCostarray of string

itemsstring

gcpGcpCostAnalyticsFilter (object)

linkedAccountIdarray of string

itemsstring

productCodearray of string

itemsstring

regionarray of string

itemsstring

productFamilyarray of string

itemsstring

tagsarray of Tag (object)

tagKeystring

tagValuestring

serviceGrouparray of ServiceGroup (object)

serviceGroupKeystring

serviceGroupValuestring

serviceGroupSetNmstring

serviceGroupSetIdstring

serviceGroupNmstring

serviceGroupIdstring

dfltYnstring

startDate*Cost Analytics inquiry start date

Cost Analytics inquiry start date

Example: "2024-09-01"

endDate*Cost Analytics inquiry end date

Cost Analytics inquiry end date

Example: "2024-09-30"

viewByView By

View By

Example: "account"

fieldFilter query category

Filter query category

Example: "platform"

selectedKeySelected Key

Selected Key

Example: "test"

searchTextSearch Text

Search Text

Example: "test"

selectedVendors*selected vendors

selected vendors

itemsselected vendors

selected vendors

Example: "[\"AWS\"]"

Response

Body

statusAPI Response Status

API Response Status

Example: "success"

errorAPI Response of Error

API Response of Error

codeError Code

Error Code

messageError Message

Error Message

Example: "Error Message"

Request

Response

Category of cost analytics

View Category of cost analytics

POSThttps://api.opsnow.io/cost/v3/billing/analytics/filter/category

Authorization

Body

siteCode*site code

site code

Example: "BESPIN"

companyId*company id

company id

Example: "1"

userIduser id

user id

Example: "abcd"

conditions*Cost Analytics Filters

Cost Analytics Filters

awsAwsCostAnalyticsFilter (object)

linkedAccountIdarray of string

itemsstring

productCodearray of string

itemsstring

regionarray of string

itemsstring

productFamilyarray of string

itemsstring

tagsarray of Tag (object)

tagKeystring

tagValuestring

serviceGrouparray of ServiceGroup (object)

serviceGroupKeystring

serviceGroupValuestring

serviceGroupSetNmstring

serviceGroupSetIdstring

serviceGroupNmstring

serviceGroupIdstring

dfltYnstring

instanceTypearray of string

itemsstring

instanceTypeFamilyarray of string

itemsstring

chargeTypearray of string

itemsstring

osarray of string

itemsstring

databasearray of string

itemsstring

transferTypearray of string

itemsstring

purchaseOptionarray of string

itemsstring

apiOperationarray of string

itemsstring

resourceIdarray of string

itemsstring

usageTypearray of string

itemsstring

invoiceIdarray of string

itemsstring

itemDescriptionarray of string

itemsstring

cacheEnginearray of string

itemsstring

availabilityZonearray of string

itemsstring

platformarray of string

itemsstring

azureAzureCostAnalyticsFilter (object)

linkedAccountIdarray of string

itemsstring

productCodearray of string

itemsstring

regionarray of string

itemsstring

productFamilyarray of string

itemsstring

tagsarray of Tag (object)

tagKeystring

tagValuestring

serviceGrouparray of ServiceGroup (object)

serviceGroupKeystring

serviceGroupValuestring

serviceGroupSetNmstring

serviceGroupSetIdstring

serviceGroupNmstring

serviceGroupIdstring

dfltYnstring

subscriptionNmarray of string

itemsstring

subscriptionIdarray of string

itemsstring

infraTypearray of string

itemsstring

mtCategoryarray of string

itemsstring

mtNamearray of string

itemsstring

usagearray of string

itemsstring

unitPricearray of string

itemsstring

totalCostarray of string

itemsstring

gcpGcpCostAnalyticsFilter (object)

linkedAccountIdarray of string

itemsstring

productCodearray of string

itemsstring

regionarray of string

itemsstring

productFamilyarray of string

itemsstring

tagsarray of Tag (object)

tagKeystring

tagValuestring

serviceGrouparray of ServiceGroup (object)

serviceGroupKeystring

serviceGroupValuestring

serviceGroupSetNmstring

serviceGroupSetIdstring

serviceGroupNmstring

serviceGroupIdstring

dfltYnstring

startDate*Cost Analytics inquiry start date

Cost Analytics inquiry start date

Example: "2024-09-01"

endDate*Cost Analytics inquiry end date

Cost Analytics inquiry end date

Example: "2024-09-30"

viewByView By

View By

Example: "account"

fieldFilter query category

Filter query category

Example: "platform"

selectedKeySelected Key

Selected Key

Example: "test"

searchTextSearch Text

Search Text

Example: "test"

selectedVendors*selected vendors

selected vendors

itemsselected vendors

selected vendors

Example: "[\"AWS\"]"

Response

Body

statusAPI Response Status

API Response Status

Example: "success"

errorAPI Response of Error

API Response of Error

codeError Code

Error Code

messageError Message

Error Message

Example: "Error Message"

Request

Response

Specific anomaly detection rule

View the specific rule for detecting anomalies and sending alerts.

POSThttps://api.opsnow.io/cost/v3/billing/anomaly/vendors/detections/alerts/rule/{seq}

Authorization

Path parameters

seq*integer (int32)

Rule Seq

Example: 0

Body

siteCode*site code

site code

Example: "BESPIN"

companyId*company id

company id

Example: "1"

companyNamecompany name

company name

Example: "1"

defaultVendor*default vendor

default vendor

Example: "AWS"

userEmailuser email

user email

Example: "abcd@bespingloba.com"

userIduser id

user id

Example: "abcd"

userNameuser name

user name

Example: "abcd"

vendorvendor

vendor

Example: "AWS"

seqAnomaly Rule Seq

Anomaly Rule Seq

Example: 0

Response

Body

statusAPI Response Status

API Response Status

Example: "success"

errorAPI Response of Error

API Response of Error

codeError Code

Error Code

messageError Message

Error Message

Example: "Error Message"

Request

Response

Trend of anomaly detection by AI

View the trend of cost anomalies detected by AI.

POSThttps://api.opsnow.io/cost/v3/billing/anomaly/vendors/{vendor}/detections/ai/trend

Authorization

Path parameters

vendor*string

Vendor

Example: "AWS"

Body

siteCode*site code

site code

Example: "BESPIN"

companyId*company id

company id

Example: "1"

companyNamecompany name

company name

Example: "1"

defaultVendor*default vendor

default vendor

Example: "AWS"

userEmailuser email

user email

Example: "abcd@bespingloba.com"

userIduser id

user id

Example: "abcd"

userNameuser name

user name

Example: "abcd"

vendor*vendor

vendor

Example: "AWS"

sensitivity*Sensitivity

Sensitivity

Example: "M"

forecastDtForecast Date

Forecast Date

Example: "2024-06-02"

Response

Body

statusAPI Response Status

API Response Status

Example: "success"

errorAPI Response of Error

API Response of Error

codeError Code

Error Code

messageError Message

Error Message

Example: "Error Message"

Request

Response

Potential anomalous usage data detected by AI

View the usage data that may lead to ai-predicted anomalous costs

POSThttps://api.opsnow.io/cost/v3/billing/anomaly/vendors/{vendor}/anomaly/aiPossibleCause

Authorization

Path parameters

vendor*string

Vendor

Example: "AWS"

Body

siteCode*site code

site code

Example: "BESPIN"

companyId*company id

company id

Example: "1"

companyNamecompany name

company name

Example: "1"

defaultVendor*default vendor

default vendor

Example: "AWS"

userEmailuser email

user email

Example: "abcd@bespingloba.com"

userIduser id

user id

Example: "abcd"

userNameuser name

user name

Example: "abcd"

vendorvendor

vendor

Example: "AWS"

selectedVendorsByWidget*Selected Vendors by Widget

Selected Vendors by Widget

itemsSelected Vendors by Widget

Selected Vendors by Widget

Example: "[\"AWS\",\"GCP\"]"

sensitivity*Sensitivity

Sensitivity

Example: "M"

forecastDate*Forecast Date

Forecast Date

Example: "2024-09-23"

Response

Body

statusAPI Response Status

API Response Status

Example: "success"

errorAPI Response of Error

API Response of Error

codeError Code

Error Code

messageError Message

Error Message

Example: "Error Message"

Request

Response

Detail of cost analytics

View detailed portion chart data of cost analytics

POSThttps://api.opsnow.io/cost/v3/billing/analytics/daily-portion

Authorization

Body

siteCode*site code

site code

Example: "BESPIN"

companyId*company id

company id

Example: "1"

userIduser id

user id

Example: "abcd"

selectedVendor*selected vendor

Example: "AWS"

costDate*cost date

Example: "2019-08-12"

startDate*start date

Example: "2023-02-01"

endDate*end date

Example: "2024-02-12"

viewBy*view by

Example: "account"

viewByIdviewById

viewByItem*viewByItem

Example: "216093335544"

itemViewId*itemViewId

Example: "216093335544"

filters*Cost Analytics Filters

Cost Analytics Filters

awsAwsCostAnalyticsFilter (object)

linkedAccountIdarray of string

itemsstring

productCodearray of string

itemsstring

regionarray of string

itemsstring

productFamilyarray of string

itemsstring

tagsarray of Tag (object)

tagKeystring

tagValuestring

serviceGrouparray of ServiceGroup (object)

serviceGroupKeystring

serviceGroupValuestring

serviceGroupSetNmstring

serviceGroupSetIdstring

serviceGroupNmstring

serviceGroupIdstring

dfltYnstring

instanceTypearray of string

itemsstring

instanceTypeFamilyarray of string

itemsstring

chargeTypearray of string

itemsstring

osarray of string

itemsstring

databasearray of string

itemsstring

transferTypearray of string

itemsstring

purchaseOptionarray of string

itemsstring

apiOperationarray of string

itemsstring

resourceIdarray of string

itemsstring

usageTypearray of string

itemsstring

invoiceIdarray of string

itemsstring

itemDescriptionarray of string

itemsstring

cacheEnginearray of string

itemsstring

availabilityZonearray of string

itemsstring

platformarray of string

itemsstring

azureAzureCostAnalyticsFilter (object)

linkedAccountIdarray of string

itemsstring

productCodearray of string

itemsstring

regionarray of string

itemsstring

productFamilyarray of string

itemsstring

tagsarray of Tag (object)

tagKeystring

tagValuestring

serviceGrouparray of ServiceGroup (object)

serviceGroupKeystring

serviceGroupValuestring

serviceGroupSetNmstring

serviceGroupSetIdstring

serviceGroupNmstring

serviceGroupIdstring

dfltYnstring

subscriptionNmarray of string

itemsstring

subscriptionIdarray of string

itemsstring

infraTypearray of string

itemsstring

mtCategoryarray of string

itemsstring

mtNamearray of string

itemsstring

usagearray of string

itemsstring

unitPricearray of string

itemsstring

totalCostarray of string

itemsstring

gcpGcpCostAnalyticsFilter (object)

linkedAccountIdarray of string

itemsstring

productCodearray of string

itemsstring

regionarray of string

itemsstring

productFamilyarray of string

itemsstring

tagsarray of Tag (object)

tagKeystring

tagValuestring

serviceGrouparray of ServiceGroup (object)

serviceGroupKeystring

serviceGroupValuestring

serviceGroupSetNmstring

serviceGroupSetIdstring

serviceGroupNmstring

serviceGroupIdstring

dfltYnstring

detailFilters*Detail Filters

Detail Filters

linkedAccountIdarray of string

itemsstring

productCodearray of string

itemsstring

regionarray of string

itemsstring

usageTypearray of string

itemsstring

visibleFields*VisibleFields of detail grid

VisibleFields of detail grid

itemsVisibleFields of detail grid

VisibleFields of detail grid

Example: "[\"vendor\",\"linkedAccountId\",\"productName\",\"region\",\"usage\",\"cost\",\"usageType\"]"

tagsTags Filter

Tags Filter

tagKeystring

tagValuestring

isMonthly*monthly

Example: false

Response

Body

statusAPI Response Status

API Response Status

Example: "success"

errorAPI Response of Error

API Response of Error

codeError Code

Error Code

messageError Message

Error Message

Example: "Error Message"

Request

Response

Summary of cost analytics

View summary of cost analytics

POSThttps://api.opsnow.io/cost/v3/billing/analytics/cost

Authorization

Body

siteCode*site code

site code

Example: "BESPIN"

companyId*company id

company id

Example: "1"

userIduser id

user id

Example: "abcd"

startDate*start date

start date

Example: "2023-02-01"

endDate*end date

end date

Example: "2024-02-12"

itemsPerPage*items per page

items per page

Example: 30

page*page number

page number

Example: 1

userNameuser name

user name

Example: "abcd"

viewBy*view by

view by

Example: "account"

selectedVendors*selected vendors

selected vendors

itemsselected vendors

selected vendors

Example: "[\"AWS\"]"

filters*Cost Analytics Filters

Cost Analytics Filters

awsAwsCostAnalyticsFilter (object)

linkedAccountIdarray of string

itemsstring

productCodearray of string

itemsstring

regionarray of string

itemsstring

productFamilyarray of string

itemsstring

tagsarray of Tag (object)

tagKeystring

tagValuestring

serviceGrouparray of ServiceGroup (object)

serviceGroupKeystring

serviceGroupValuestring

serviceGroupSetNmstring

serviceGroupSetIdstring

serviceGroupNmstring

serviceGroupIdstring

dfltYnstring

instanceTypearray of string

itemsstring

instanceTypeFamilyarray of string

itemsstring

chargeTypearray of string

itemsstring

osarray of string

itemsstring

databasearray of string

itemsstring

transferTypearray of string

itemsstring

purchaseOptionarray of string

itemsstring

apiOperationarray of string

itemsstring

resourceIdarray of string

itemsstring

usageTypearray of string

itemsstring

invoiceIdarray of string

itemsstring

itemDescriptionarray of string

itemsstring

cacheEnginearray of string

itemsstring

availabilityZonearray of string

itemsstring

platformarray of string

itemsstring

azureAzureCostAnalyticsFilter (object)

linkedAccountIdarray of string

itemsstring

productCodearray of string

itemsstring

regionarray of string

itemsstring

productFamilyarray of string

itemsstring

tagsarray of Tag (object)

tagKeystring

tagValuestring

serviceGrouparray of ServiceGroup (object)

serviceGroupKeystring

serviceGroupValuestring

serviceGroupSetNmstring

serviceGroupSetIdstring

serviceGroupNmstring

serviceGroupIdstring

dfltYnstring

subscriptionNmarray of string

itemsstring

subscriptionIdarray of string

itemsstring

infraTypearray of string

itemsstring

mtCategoryarray of string

itemsstring

mtNamearray of string

itemsstring

usagearray of string

itemsstring

unitPricearray of string

itemsstring

totalCostarray of string

itemsstring

gcpGcpCostAnalyticsFilter (object)

linkedAccountIdarray of string

itemsstring

productCodearray of string

itemsstring

regionarray of string

itemsstring

productFamilyarray of string

itemsstring

tagsarray of Tag (object)

tagKeystring

tagValuestring

serviceGrouparray of ServiceGroup (object)

serviceGroupKeystring

serviceGroupValuestring

serviceGroupSetNmstring

serviceGroupSetIdstring

serviceGroupNmstring

serviceGroupIdstring

dfltYnstring

isMonthly*monthly

monthly

Example: false

Response

Body

statusAPI Response Status

API Response Status

Example: "success"

errorAPI Response of Error

API Response of Error

codeError Code

Error Code

messageError Message

Error Message

Example: "Error Message"

Request

Response

Create/Update an anomaly detection rule setting

Create or update the setting of anomaly detection rule.

PUThttps://api.opsnow.io/cost/v3/billing/anomaly/vendors/detections/alerts/rule/setting

Authorization

Body

siteCode*site code

site code

Example: "BESPIN"

companyId*company id

company id

Example: "1"

companyNamecompany name

company name

Example: "1"

defaultVendor*default vendor

default vendor

Example: "AWS"

userEmailuser email

user email

Example: "abcd@bespingloba.com"

userIduser id

user id

Example: "abcd"

userNameuser name

user name

Example: "abcd"

vendorvendor

vendor

Example: "AWS"

seqAnomaly Rule Seq

Anomaly Rule Seq

Example: 0

nameAnomaly Rule Name

Anomaly Rule Name

Example: "Name"

analyzeType*Analyze Type

Abnormal Cost AI/Manual Type

Example: "manual"

analyzeBy*Analyze By

Abnormal Cost Analysis Type

Example: "account"

sensitivity*Sensitivity

Sensitivity

Example: "M"

thValThreshold value

Threshold value

Example: 1

thOptThreshold detection options

Threshold detection options(percentage/amount)

Example: "percentage"

alertStatusAlarm Setting Status

Alarm Setting Status(active/inactive)

Example: "inactive"

alertFreqAlarm Frequency

Alarm Frequency(daily, weekly)

Example: "daily"

alertOptAlarm Option

Alarm Option(only, all)

Example: "only"

receiversAlarm recipients

Alarm recipients

useYnAlarm Enabled

Alarm Enabled

Example: "Y"

forecastDtForecast Date

Forecast Date

Example: "2024-06-02"

analyzedDtAnalysis date

Analysis date

Example: "2024-06-02"

viewByView By

View By

Example: "account"

Response

Body

statusAPI Response Status

API Response Status

Example: "success"

errorAPI Response of Error

API Response of Error

codeError Code

Error Code

messageError Message

Error Message

Example: "Error Message"

Request

Response

Detail of cost analytics

View detailed grid of cost analytics

POSThttps://api.opsnow.io/cost/v3/billing/analytics/daily-cost

Authorization

Body

siteCode*site code

site code

Example: "BESPIN"

companyId*company id

company id

Example: "1"

userIduser id

user id

Example: "abcd"

selectedVendor*selected vendor

Example: "AWS"

costDate*cost date

Example: "2019-08-12"

startDate*start date

Example: "2023-02-01"

endDate*end date

Example: "2024-02-12"

viewBy*view by

Example: "account"

viewByIdviewById

viewByItem*viewByItem

Example: "216093335544"

itemViewId*itemViewId

Example: "216093335544"

filters*Cost Analytics Filters

Cost Analytics Filters

awsAwsCostAnalyticsFilter (object)

linkedAccountIdarray of string

itemsstring

productCodearray of string

itemsstring

regionarray of string

itemsstring

productFamilyarray of string

itemsstring

tagsarray of Tag (object)

tagKeystring

tagValuestring

serviceGrouparray of ServiceGroup (object)

serviceGroupKeystring

serviceGroupValuestring

serviceGroupSetNmstring

serviceGroupSetIdstring

serviceGroupNmstring

serviceGroupIdstring

dfltYnstring

instanceTypearray of string

itemsstring

instanceTypeFamilyarray of string

itemsstring

chargeTypearray of string

itemsstring

osarray of string

itemsstring

databasearray of string

itemsstring

transferTypearray of string

itemsstring

purchaseOptionarray of string

itemsstring

apiOperationarray of string

itemsstring

resourceIdarray of string

itemsstring

usageTypearray of string

itemsstring

invoiceIdarray of string

itemsstring

itemDescriptionarray of string

itemsstring

cacheEnginearray of string

itemsstring

availabilityZonearray of string

itemsstring

platformarray of string

itemsstring

azureAzureCostAnalyticsFilter (object)

linkedAccountIdarray of string

itemsstring

productCodearray of string

itemsstring

regionarray of string

itemsstring

productFamilyarray of string

itemsstring

tagsarray of Tag (object)

tagKeystring

tagValuestring

serviceGrouparray of ServiceGroup (object)

serviceGroupKeystring

serviceGroupValuestring

serviceGroupSetNmstring

serviceGroupSetIdstring

serviceGroupNmstring

serviceGroupIdstring

dfltYnstring

subscriptionNmarray of string

itemsstring

subscriptionIdarray of string

itemsstring

infraTypearray of string

itemsstring

mtCategoryarray of string

itemsstring

mtNamearray of string

itemsstring

usagearray of string

itemsstring

unitPricearray of string

itemsstring

totalCostarray of string

itemsstring

gcpGcpCostAnalyticsFilter (object)

linkedAccountIdarray of string

itemsstring

productCodearray of string

itemsstring

regionarray of string

itemsstring

productFamilyarray of string

itemsstring

tagsarray of Tag (object)

tagKeystring

tagValuestring

serviceGrouparray of ServiceGroup (object)

serviceGroupKeystring

serviceGroupValuestring

serviceGroupSetNmstring

serviceGroupSetIdstring

serviceGroupNmstring

serviceGroupIdstring

dfltYnstring

detailFilters*Detail Filters

Detail Filters

linkedAccountIdarray of string

itemsstring

productCodearray of string

itemsstring

regionarray of string

itemsstring

usageTypearray of string

itemsstring

visibleFields*VisibleFields of detail grid

VisibleFields of detail grid

itemsVisibleFields of detail grid

VisibleFields of detail grid

Example: "[\"vendor\",\"linkedAccountId\",\"productName\",\"region\",\"usage\",\"cost\",\"usageType\"]"

tagsTags Filter

Tags Filter

tagKeystring

tagValuestring

isMonthly*monthly

Example: false

Response

Body

statusAPI Response Status

API Response Status

Example: "success"

errorAPI Response of Error

API Response of Error

codeError Code

Error Code

messageError Message

Error Message

Example: "Error Message"

Request

Response

View Cost Analytics filter

POSThttps://api.opsnow.io/cost/v3/billing/analytics/related

Authorization

Body

siteCode*site code

site code

Example: "BESPIN"

companyId*company id

company id

Example: "1"

userIduser id

user id

Example: "abcd"

conditions*Cost Analytics Filters

Cost Analytics Filters

awsAwsCostAnalyticsFilter (object)

linkedAccountIdarray of string

itemsstring

productCodearray of string

itemsstring

regionarray of string

itemsstring

productFamilyarray of string

itemsstring

tagsarray of Tag (object)

tagKeystring

tagValuestring

serviceGrouparray of ServiceGroup (object)

serviceGroupKeystring

serviceGroupValuestring

serviceGroupSetNmstring

serviceGroupSetIdstring

serviceGroupNmstring

serviceGroupIdstring

dfltYnstring

instanceTypearray of string

itemsstring

instanceTypeFamilyarray of string

itemsstring

chargeTypearray of string

itemsstring

osarray of string

itemsstring

databasearray of string

itemsstring

transferTypearray of string

itemsstring

purchaseOptionarray of string

itemsstring

apiOperationarray of string

itemsstring

resourceIdarray of string

itemsstring

usageTypearray of string

itemsstring

invoiceIdarray of string

itemsstring

itemDescriptionarray of string

itemsstring

cacheEnginearray of string

itemsstring

availabilityZonearray of string

itemsstring

platformarray of string

itemsstring

azureAzureCostAnalyticsFilter (object)

linkedAccountIdarray of string

itemsstring

productCodearray of string

itemsstring

regionarray of string

itemsstring

productFamilyarray of string

itemsstring

tagsarray of Tag (object)

tagKeystring

tagValuestring

serviceGrouparray of ServiceGroup (object)

serviceGroupKeystring

serviceGroupValuestring

serviceGroupSetNmstring

serviceGroupSetIdstring

serviceGroupNmstring

serviceGroupIdstring

dfltYnstring

subscriptionNmarray of string

itemsstring

subscriptionIdarray of string

itemsstring

infraTypearray of string

itemsstring

mtCategoryarray of string

itemsstring

mtNamearray of string

itemsstring

usagearray of string

itemsstring

unitPricearray of string

itemsstring

totalCostarray of string

itemsstring

gcpGcpCostAnalyticsFilter (object)

linkedAccountIdarray of string

itemsstring

productCodearray of string

itemsstring

regionarray of string

itemsstring

productFamilyarray of string

itemsstring

tagsarray of Tag (object)

tagKeystring

tagValuestring

serviceGrouparray of ServiceGroup (object)

serviceGroupKeystring

serviceGroupValuestring

serviceGroupSetNmstring

serviceGroupSetIdstring

serviceGroupNmstring

serviceGroupIdstring

dfltYnstring

startDate*Cost Analytics inquiry start date

Cost Analytics inquiry start date

Example: "2024-09-01"

endDate*Cost Analytics inquiry end date

Cost Analytics inquiry end date

Example: "2024-09-30"

viewByView By

View By

Example: "account"

fieldFilter query category

Filter query category

Example: "platform"

selectedKeySelected Key

Selected Key

Example: "test"

searchTextSearch Text

Search Text

Example: "test"

selectedVendors*selected vendors

selected vendors

itemsselected vendors

selected vendors

Example: "[\"AWS\"]"

Response

Body

statusAPI Response Status

API Response Status

Example: "success"

errorAPI Response of Error

API Response of Error

codeError Code

Error Code

messageError Message

Error Message

Example: "Error Message"

Request

Response

Cost trend of cloud usage

View the cost trend of cloud usage.

POSThttps://api.opsnow.io/cost/v3/billing/anomaly/vendors/{vendor}/dashboard/trend

Authorization

Path parameters

vendor*string

Vendor

Example: "AWS"

Body

siteCode*site code

site code

Example: "BESPIN"

companyId*company id

company id

Example: "1"

companyNamecompany name

company name

Example: "1"

defaultVendor*default vendor

default vendor

Example: "AWS"

userEmailuser email

user email

Example: "abcd@bespingloba.com"

userIduser id

user id

Example: "abcd"

userNameuser name

user name

Example: "abcd"

vendorvendor

vendor

Example: "AWS"

vendorsList of vendors

List of vendors

itemsList of vendors

List of vendors

selectedVendorsByWidget*Selected Vendors by Widget

Selected Vendors by Widget

itemsSelected Vendors by Widget

Selected Vendors by Widget

Example: "[\"AWS\"]"

viewType*View Type

View Type

Example: "account"

widgetType*Component Type

Component Type

Example: "dashboard_compare_cost_trend_widget"

dateTypeWidget Date Type

Widget Date Type

Example: "monthly"

dataTypeWidget Date Type ( Opsnow Console > Cost widget > dataType key value)

Widget Date Type (etc. monthly, weekly, daily)

Example: "monthly, weekly, daily"

timeFrame*Time Frame

Time Frame

Example: "last_3_months"

viewBy*View By

View By(account,product,region)

Example: "account"

filterFilter Type

Filter Type(top_10_by_cost / custom)

Example: "top_10_by_cost"

customFilterCustom Filter

Custom Filter

vendorstring

itemstring

selectedAccountSelected Account Filter

Selected Account Filter

Example: "000000000000"

selectedAccountsSelected Accounts Filter

Selected Accounts Filter

itemsSelected Accounts Filter

Selected Accounts Filter

itemSelected Items Filter

Selected Items Filter

itemsSelected Items Filter

Selected Items Filter

selectedTagKeySelected Tag Key Filter

Selected Tag Key Filter

Example: "Name"

selectedServiceGroupSetSelected Service Group Set Filter

Selected Service Group Set Filter

Example: "00000000-0000-0000-0000-000000000000"

widgetCurrencyWidget Selected Currency

Widget Selected Currency

sensitivitySensitivity value for a specific widget

Sensitivity value for a specific widget

Example: "M"

analyzedDtAnalysis date

Analysis date

Example: "2024-06-02"

Response

Body

statusAPI Response Status

API Response Status

Example: "success"

errorAPI Response of Error

API Response of Error

codeError Code

Error Code

messageError Message

Error Message

Example: "Error Message"

Request

Response

Get AutoSavings Inventory List

GEThttps://api.opsnow.io/cost/v3/autosave/companies/{companyId}/vendors/aws/services/integration/inventory/auto-list

Authorization

Path parameters

companyId*string

Company ID

Example: 1

Query parameters

dateTypeenum

Date query type

Example: "DAILY"

{DAILY, MONTHLY}

startDate*string

Start Date

Example: "2023-10-01"

endDate*string

End Date

Example: "2023-10-31"

accountsstring

Linked Account ID

Example: "['123456789011', '123456789012']"

productsstring

Products

Example: "['EC2InstanceReserved', 'ComputeReserved']"

regionsstring

Regions

Example: "[ {'code':'EC2InstanceReserved', 'value':'EC2 Instance'} ]"

instanceTypesstring

Instance types

Example: "[ 't2.micro', 'm4.xlarge' ]"

opsnowProductCodesstring

OpsNow RI Purchase types

Example: "[ 'AUTO-RI', 'AUTO-SP', 'CLIENT-RI' ]"

searchTypestring

Search type

Example: "All, My, AutoSavings"

Response

Body

statusstring

errorError (object)

Codeinteger (int32)

Messagestring

listarray of AwsIntegrationInventoryModel (object)

inventoryIdstring

Inventory ID

Example: "3118c6a8-7fc3-4b5d-8b53-a82fbe6f3169"

linkedAccountIdstring

Linked account ID

Example: "123456789012"

linkedAccountAliasstring

Linked account Name

Example: "Bespinglobal Platform"

productCodestring

Product type code

Example: "AmazonEC2"

productNamestring

Product type name

Example: "EC2"

instanceTypestring

Instance type

Example: "c4.xlarge"

regionCodestring

Region code

Example: "ap-northeast-2"

regionNamestring

Region name

Example: "Asia Pacific (Seoul)"

purchaseOptionstring

Payment option

Example: "All Upfront"

remainingDaysinteger (int32)

Contract remaining days

Example: 365

startDatestring

Contract start date

Example: "2019-01-01 23:59:59"

endDatestring

Contract end date

Example: "2011-01-01 23:59:58"

durationinteger (int32)

Contract unit(seconds)

Example: 31536000

platformstring

Platform(OS)

Example: "Linux/UNIX"

operationNamestring

Operation Name

Example: "RunInstances"

statusstring

Commitment status

Example: "active"

arnstring

ARN

Example: "arn:aws:rds:ap-northeast-2:249145062117:ri:ri-2020-05-15-05-12-58-377"

hourlyCommitmentCostnumber (double)

Hourly commitment cost

Example: 100

upfrontFeenumber (double)

Upfront fee

Example: 777

recurringFeenumber (double)

Recurring fee

Example: 777

Request

Response

Get My Inventory List

GEThttps://api.opsnow.io/cost/v3/autosave/companies/{companyId}/vendors/aws/services/integration/inventory/my-list

Authorization

Path parameters

companyId*string

Company ID

Example: 1

Query parameters

dateTypeenum

Date query type

Example: "DAILY"

{DAILY, MONTHLY}

startDate*string

Start Date

Example: "2023-10-01"

endDate*string

End Date

Example: "2023-10-31"

accountsstring

Linked Account ID

Example: "['123456789011', '123456789012']"

productsstring

Products

Example: "['EC2InstanceReserved', 'ComputeReserved']"

regionsstring

Regions

Example: "[ {'code':'EC2InstanceReserved', 'value':'EC2 Instance'} ]"

instanceTypesstring

Instance types

Example: "[ 't2.micro', 'm4.xlarge' ]"

opsnowProductCodesstring

OpsNow RI Purchase types

Example: "[ 'AUTO-RI', 'AUTO-SP', 'CLIENT-RI' ]"

searchTypestring

Search type

Example: "All, My, AutoSavings"

Response

Body

statusstring

errorError (object)

Codeinteger (int32)

Messagestring

listarray of AwsIntegrationInventoryModel (object)

inventoryIdstring

Inventory ID

Example: "3118c6a8-7fc3-4b5d-8b53-a82fbe6f3169"

linkedAccountIdstring

Linked account ID

Example: "123456789012"

linkedAccountAliasstring

Linked account Name

Example: "Bespinglobal Platform"

productCodestring

Product type code

Example: "AmazonEC2"

productNamestring

Product type name

Example: "EC2"

instanceTypestring

Instance type

Example: "c4.xlarge"

regionCodestring

Region code

Example: "ap-northeast-2"

regionNamestring

Region name

Example: "Asia Pacific (Seoul)"

purchaseOptionstring

Payment option

Example: "All Upfront"

remainingDaysinteger (int32)

Contract remaining days

Example: 365

startDatestring

Contract start date

Example: "2019-01-01 23:59:59"

endDatestring

Contract end date

Example: "2011-01-01 23:59:58"

durationinteger (int32)

Contract unit(seconds)

Example: 31536000

platformstring

Platform(OS)

Example: "Linux/UNIX"

operationNamestring

Operation Name

Example: "RunInstances"

statusstring

Commitment status

Example: "active"

arnstring

ARN

Example: "arn:aws:rds:ap-northeast-2:249145062117:ri:ri-2020-05-15-05-12-58-377"

hourlyCommitmentCostnumber (double)

Hourly commitment cost

Example: 100

upfrontFeenumber (double)

Upfront fee

Example: 777

recurringFeenumber (double)

Recurring fee

Example: 777

Request

Response

Get AutoSavings account AWS role ARN Info

Retrieve the necessary information for AWS cross-account registration.

GEThttps://api.opsnow.io/cost/v3/autosave/companies/{companyId}/vendors/aws/services/accounts/role-arn

Authorization

Path parameters

companyId*string

Company ID

Example: 1

Query parameters

browserTimeZonestring

Browser Timezone

Example: "+09:00"

linkedAccountIdstring

Linked Account ID

Example: "'123456789011'"

linkedAccountAliasstring

Linked Account Name

Example: "'Alias equals name'"

accessTypestring

AutoSavings AWS account access type

Example: "'role-arn / access-key '"

roleArnstring

roleArn

Example: "'roleArn'"

accessKeystring

secretKeystring

tokenstring

startDatestring

endDatestring

siteRegionstring

siteRegion

Example: "'GLOBAL / CHINA'"

servicesstring

AutoSavings services subscribed to by the account

Example: "'AUTO-RI, AUTO-STORAGE, AUTO-DISK"

encryptKeystring

subscriptionStatusstring

Current AutoSavings subscription status of the account

Example: "'SUBSCRIBED'"

Response

Body

statusstring

errorError (object)

Codeinteger (int32)

Messagestring

listarray of AwsAutoSavingsAccountModel (object)

account list

companyIdstring

Company Id

Example: "1"

linkedAccountIdstring

Linked account ID

Example: "123456789012"

linkedAccountAliasstring

Linked account Name

Example: "Bespinglobal Platform"

accessTypestring

AWS API Access type

Example: "role-arn"

roleArnstring

AWS ARN

Example: "aws:arn:123456:api"

siteRegionstring

AWS site region code

Example: "GLOBAL"

deleteYnstring

AWS account delete sign

Example: "0:false / 1:true"

createDatestring

AWS account create date

Example: "'%Y-%m-%d %H:%i:%s'"

createUserstring

AWS account create user

Example: "user"

updateDatestring

AWS account update date

Example: "'%Y-%m-%d %H:%i:%s'"

updateUserstring

AWS account update user

Example: "user"

roleArnInfoAwsAutoSavingsRoleArnInformationModel (object)

Role ARN Information(Required information for cross-account registration)

cloudFormationTemplateUrlstring

externalIdstring

dataAwsAutoSavingsSiteRegionModel (object)

Site information for the selected company.

siteRegionstring

Request

Response

Get AutoSavings Account Subscription Histories

Retrieve AWS AutoSavings subscription histories

GEThttps://api.opsnow.io/cost/v3/autosave/companies/{companyId}/vendors/aws/services/accounts/subscription/histories

Authorization

Path parameters

companyId*string

Company ID

Example: 1

Query parameters

browserTimeZonestring

Browser Timezone

Example: "+09:00"

linkedAccountIdstring

Linked Account ID

Example: "'123456789011'"

linkedAccountAliasstring

Linked Account Name

Example: "'Alias equals name'"

accessTypestring

AutoSavings AWS account access type

Example: "'role-arn / access-key '"

roleArnstring

roleArn

Example: "'roleArn'"

accessKeystring

secretKeystring

tokenstring

startDatestring

endDatestring

siteRegionstring

siteRegion

Example: "'GLOBAL / CHINA'"

servicesstring

AutoSavings services subscribed to by the account

Example: "'AUTO-RI, AUTO-STORAGE, AUTO-DISK"

encryptKeystring

subscriptionStatusstring

Current AutoSavings subscription status of the account

Example: "'SUBSCRIBED'"

latestboolean

View the latest subscription information by account

Response

Body

listarray of AwsAutoSavingsAccountSubscriptionHistoryModel (object)

AutoSavings account subscription histories

linkedAccountIdstring

payerAccountIdstring

autoSavingsServicestring

subscriptionStatusstring

startDateTimestring

cancelDateTimestring

endDateTimestring

Request

Response

Get AutoSavings account List

Retrieve information about the AWS account registered with the company.

GEThttps://api.opsnow.io/cost/v3/autosave/companies/{companyId}/vendors/aws/services/accounts

Authorization

Path parameters

companyId*string

Company ID

Example: 1

Query parameters

browserTimeZonestring

Browser Timezone

Example: "+09:00"

linkedAccountIdstring

Linked Account ID

Example: "'123456789011'"

linkedAccountAliasstring

Linked Account Name

Example: "'Alias equals name'"

accessTypestring

AutoSavings AWS account access type

Example: "'role-arn / access-key '"

roleArnstring

roleArn

Example: "'roleArn'"

accessKeystring

secretKeystring

tokenstring

startDatestring

endDatestring

siteRegionstring

siteRegion

Example: "'GLOBAL / CHINA'"

servicesstring

AutoSavings services subscribed to by the account

Example: "'AUTO-RI, AUTO-STORAGE, AUTO-DISK"

encryptKeystring

subscriptionStatusstring

Current AutoSavings subscription status of the account

Example: "'SUBSCRIBED'"

Response

Body

statusstring

errorError (object)

Codeinteger (int32)

Messagestring

listarray of AwsAutoSavingsAccountModel (object)

account list

companyIdstring

Company Id

Example: "1"

linkedAccountIdstring

Linked account ID

Example: "123456789012"

linkedAccountAliasstring

Linked account Name

Example: "Bespinglobal Platform"

accessTypestring

AWS API Access type

Example: "role-arn"

roleArnstring

AWS ARN

Example: "aws:arn:123456:api"

siteRegionstring

AWS site region code

Example: "GLOBAL"

deleteYnstring

AWS account delete sign

Example: "0:false / 1:true"

createDatestring

AWS account create date

Example: "'%Y-%m-%d %H:%i:%s'"

createUserstring

AWS account create user

Example: "user"

updateDatestring

AWS account update date

Example: "'%Y-%m-%d %H:%i:%s'"

updateUserstring

AWS account update user

Example: "user"

roleArnInfoAwsAutoSavingsRoleArnInformationModel (object)

Role ARN Information(Required information for cross-account registration)

cloudFormationTemplateUrlstring

externalIdstring

dataAwsAutoSavingsSiteRegionModel (object)

Site information for the selected company.

siteRegionstring

Request

Response

Get total summary

Get Utilization Total summary

GEThttps://api.opsnow.io/cost/v3/autosave/companies/{companyId}/vendors/aws/services/integration/utilizations/aggregated

Authorization

Path parameters

companyId*string

Company ID

Example: 1

Query parameters

dateTypeenum

Date query type

Example: "DAILY"

{DAILY, MONTHLY}

startDate*string

Start Date

Example: "2023-10-01"

endDate*string

End Date

Example: "2023-10-31"

accountsstring

Linked Account ID

Example: "['123456789011', '123456789012']"

productsstring

Products

Example: "['EC2InstanceReserved', 'ComputeReserved']"

regionsstring

Regions

Example: "[ {'code':'EC2InstanceReserved', 'value':'EC2 Instance'} ]"

instanceTypesstring

Instance types

Example: "[ 't2.micro', 'm4.xlarge' ]"

opsnowProductCodesstring

OpsNow RI Purchase types

Example: "[ 'AUTO-RI', 'AUTO-SP', 'CLIENT-RI' ]"

searchTypestring

Search type

Example: "All, My, AutoSavings"

Response

Body

statusstring

errorError (object)

Codeinteger (int32)

Messagestring

dataAwsUtilizationPaymentModel (object)

utilizationnumber (double)

Utilization(%)

Example: 78.15

commitmentCostnumber (double)

Total commitment cost($)

Example: 3690.19

usedCommitmentCostnumber (double)

Used Savings Plans commitment cost($)

Example: 2880

netSavingsCostnumber (double)

Net savings cost On-Demand equivalent($)

Example: 810.19

netSavingsRatenumber (double)

Savings rate(%)

usedCommitmentCostOnDemandEquivalentnumber (double)

Used Savings Plans commitment cost On-Demand equivalent($)

usageDatestring

사용일

Example: "2020-07-01"

utilizationnumber (double)

Utilization(%)

Example: 78.15

commitmentCostnumber (double)

Total commitment cost($)

Example: 2880

usedCommitmentCostnumber (double)

Cost paid by RI($)

Example: 3690.19

netSavingsCostnumber (double)

Net savings cost - On-Demand equivalent($)

Example: 810.19

usedCommitmentCostOnDemandEquivalentnumber (double)

Cost paid by RI - On-Demand equivalent($)

netSavingsRatenumber (double)

Savings rate(%)

Example: 28.13

opsNowProductstring

Applied OpsNow product

Example: "AUTO-RI"

Request

Response

Get Total Transition

Get Utilization Total Transition

GEThttps://api.opsnow.io/cost/v3/autosave/companies/{companyId}/vendors/aws/services/integration/utilizations/time-series/{dateType}

Authorization

Path parameters

companyId*string

Company ID

Example: 1

dateType*string

Date query type

Example: "DAILY"

Query parameters

startDate*string

Start Date

Example: "2023-10-01"

endDate*string

End Date

Example: "2023-10-31"

accountsstring

Linked Account ID

Example: "['123456789011', '123456789012']"

productsstring

Products

Example: "['EC2InstanceReserved', 'ComputeReserved']"

regionsstring

Regions

Example: "[ {'code':'EC2InstanceReserved', 'value':'EC2 Instance'} ]"

instanceTypesstring

Instance types

Example: "[ 't2.micro', 'm4.xlarge' ]"

opsnowProductCodesstring

OpsNow RI Purchase types

Example: "[ 'AUTO-RI', 'AUTO-SP', 'CLIENT-RI' ]"

searchTypestring

Search type

Example: "All, My, AutoSavings"

Response

Body

statusstring

errorError (object)

Codeinteger (int32)

Messagestring

listarray of AwsUtilizationPaymentModel (object)

utilizationnumber (double)

Utilization(%)

Example: 78.15

commitmentCostnumber (double)

Total commitment cost($)

Example: 3690.19

usedCommitmentCostnumber (double)

Used Savings Plans commitment cost($)

Example: 2880

netSavingsCostnumber (double)

Net savings cost On-Demand equivalent($)

Example: 810.19

netSavingsRatenumber (double)

Savings rate(%)

usedCommitmentCostOnDemandEquivalentnumber (double)

Used Savings Plans commitment cost On-Demand equivalent($)

usageDatestring

사용일

Example: "2020-07-01"

utilizationnumber (double)

Utilization(%)

Example: 78.15

commitmentCostnumber (double)

Total commitment cost($)

Example: 2880

usedCommitmentCostnumber (double)

Cost paid by RI($)

Example: 3690.19

netSavingsCostnumber (double)

Net savings cost - On-Demand equivalent($)

Example: 810.19

usedCommitmentCostOnDemandEquivalentnumber (double)

Cost paid by RI - On-Demand equivalent($)

netSavingsRatenumber (double)

Savings rate(%)

Example: 28.13

opsNowProductstring

Applied OpsNow product

Example: "AUTO-RI"

Request

Response

Get AutoSavings Account State

Retrieve registered AWS AutoSavings accounts state

GEThttps://api.opsnow.io/cost/v3/autosave/companies/{companyId}/vendors/aws/services/accounts/state

Authorization

Path parameters

companyId*string

Company ID

Example: 1

Query parameters

browserTimeZonestring

Browser Timezone

Example: "+09:00"

linkedAccountIdstring

Linked Account ID

Example: "'123456789011'"

linkedAccountAliasstring

Linked Account Name

Example: "'Alias equals name'"

accessTypestring

AutoSavings AWS account access type

Example: "'role-arn / access-key '"

roleArnstring

roleArn

Example: "'roleArn'"

accessKeystring

secretKeystring

tokenstring

startDatestring

endDatestring

siteRegionstring

siteRegion

Example: "'GLOBAL / CHINA'"

servicesstring

AutoSavings services subscribed to by the account

Example: "'AUTO-RI, AUTO-STORAGE, AUTO-DISK"

encryptKeystring

subscriptionStatusstring

Current AutoSavings subscription status of the account

Example: "'SUBSCRIBED'"

Response

Body

statusstring

errorError (object)

Codeinteger (int32)

Messagestring

dataAwsAutoSavingsAccountSubscriptionStateModel (object)

The subscription states of AutoSavings for the registered accounts.

totalCountinteger (int32)

전체 계정 수

subscriptionCountinteger (int32)

구독 계정 수

stateenum

구독 상태

NONEPARTIALALL

savingsCostnumber (double)

절감액

monthlyEstimateCostnumber (double)

예상 절감액

accountsarray of AwsAutoSavingsAccountSubscriptionModel (object)

계정 구독 현황 목록

linkedAccountIdstring

linkedAccountNamestring

autoRiSubscribedboolean

autoSpSubscribedboolean

subscribedboolean

purchaseboolean

estimatedCostnumber (double)

accountStatusstring

Request

Response

Get AutoSavings Site Region

Retrieve Information about customer sites utilizing AWS AutoSavings.

GEThttps://api.opsnow.io/cost/v3/autosave/companies/{companyId}/vendors/aws/services/accounts/region

Authorization

Path parameters

companyId*string

Company ID

Example: 1

Query parameters

browserTimeZonestring

Browser Timezone

Example: "+09:00"

linkedAccountIdstring

Linked Account ID

Example: "'123456789011'"

linkedAccountAliasstring

Linked Account Name

Example: "'Alias equals name'"

accessTypestring

AutoSavings AWS account access type

Example: "'role-arn / access-key '"

roleArnstring

roleArn

Example: "'roleArn'"

accessKeystring

secretKeystring

tokenstring

startDatestring

endDatestring

siteRegionstring

siteRegion

Example: "'GLOBAL / CHINA'"

servicesstring

AutoSavings services subscribed to by the account

Example: "'AUTO-RI, AUTO-STORAGE, AUTO-DISK"

encryptKeystring

subscriptionStatusstring

Current AutoSavings subscription status of the account

Example: "'SUBSCRIBED'"

Response

Body

statusstring

errorError (object)

Codeinteger (int32)

Messagestring

listarray of AwsAutoSavingsAccountModel (object)

account list

companyIdstring

Company Id

Example: "1"

linkedAccountIdstring

Linked account ID

Example: "123456789012"

linkedAccountAliasstring

Linked account Name

Example: "Bespinglobal Platform"

accessTypestring

AWS API Access type

Example: "role-arn"

roleArnstring

AWS ARN

Example: "aws:arn:123456:api"

siteRegionstring

AWS site region code

Example: "GLOBAL"

deleteYnstring

AWS account delete sign

Example: "0:false / 1:true"

createDatestring

AWS account create date

Example: "'%Y-%m-%d %H:%i:%s'"

createUserstring

AWS account create user

Example: "user"

updateDatestring

AWS account update date

Example: "'%Y-%m-%d %H:%i:%s'"

updateUserstring

AWS account update user

Example: "user"

roleArnInfoAwsAutoSavingsRoleArnInformationModel (object)

Role ARN Information(Required information for cross-account registration)

cloudFormationTemplateUrlstring

externalIdstring

dataAwsAutoSavingsSiteRegionModel (object)

Site information for the selected company.

siteRegionstring

Request

Response

Get Filter

Get Utilization Filter

GEThttps://api.opsnow.io/cost/v3/autosave/companies/{companyId}/vendors/aws/services/integration/utilizations/categories

Authorization

Path parameters

companyId*string

Company ID

Example: 1

Query parameters

dateTypeenum

Date query type

Example: "DAILY"

{DAILY, MONTHLY}

startDate*string

Start Date

Example: "2023-10-01"

endDate*string

End Date

Example: "2023-10-31"

accountsstring

Linked Account ID

Example: "['123456789011', '123456789012']"

productsstring

Products

Example: "['EC2InstanceReserved', 'ComputeReserved']"

regionsstring

Regions

Example: "[ {'code':'EC2InstanceReserved', 'value':'EC2 Instance'} ]"

instanceTypesstring

Instance types

Example: "[ 't2.micro', 'm4.xlarge' ]"

opsnowProductCodesstring

OpsNow RI Purchase types

Example: "[ 'AUTO-RI', 'AUTO-SP', 'CLIENT-RI' ]"

searchTypestring

Search type

Example: "All, My, AutoSavings"

Response

Body

statusstring

errorError (object)

Codeinteger (int32)

Messagestring

dataAwsCommonFilterResultModel (object)

data

accountsarray of CommonCodeWithParentModel (object)

Linked Account ID

Example: "['123456789011', '123456789012']"

codestring

Code

Example: "ap-northeast-2"

namestring

Code name

Example: "Asia Pacific (Seoul)"

parentCodestring

Parent code(Code for group)

Example: "RGNCONVERT"

codesarray of string

Selected codes

Example: "['t3s','m5','c5']"

itemsstring

Selected codes

Example: "['t3s','m5','c5']"

sortinteger (int32)

정렬

productsarray of CommonCodeWithParentModel (object)

Products

Example: "[ {'code':'EC2InstanceReserved', 'value':'EC2 Instance'} ]"

codestring

Code

Example: "ap-northeast-2"

namestring

Code name

Example: "Asia Pacific (Seoul)"

parentCodestring

Parent code(Code for group)

Example: "RGNCONVERT"

codesarray of string

Selected codes

Example: "['t3s','m5','c5']"

itemsstring

Selected codes

Example: "['t3s','m5','c5']"

sortinteger (int32)

정렬

regionsarray of CommonCodeWithParentModel (object)

Regions

Example: "[ {'code':'EC2InstanceReserved', 'value':'EC2 Instance'} ]"

codestring

Code

Example: "ap-northeast-2"

namestring

Code name

Example: "Asia Pacific (Seoul)"

parentCodestring

Parent code(Code for group)

Example: "RGNCONVERT"

codesarray of string

Selected codes

Example: "['t3s','m5','c5']"

itemsstring

Selected codes

Example: "['t3s','m5','c5']"

sortinteger (int32)

정렬

instanceTypesarray of string

Instance types

Example: "[ 't2.micro', 'm4.xlarge' ]"

itemsstring

Instance types

Example: "[ 't2.micro', 'm4.xlarge' ]"

opsNowProductsarray of string

OpsNow product types

Example: "[ 'SELF', 'AUTO-RI']"

itemsstring

OpsNow product types

Example: "[ 'SELF', 'AUTO-RI']"

Request

Response

Get Savings Plans Filter

Get Coverage Filter

GEThttps://api.opsnow.io/cost/v3/autosave/companies/{companyId}/vendors/aws/services/integration/coverages/categories

Authorization

Path parameters

companyId*string

Company ID

Example: 1

Query parameters

dateTypeenum

Date query type

Example: "DAILY"

{DAILY, MONTHLY}

startDate*string

Start Date

Example: "2020-10-01"

endDate*string

End Date

Example: "2020-10-31"

accountsstring

Linked Account IDs

Example: "['123456789011', '123456789012']"

productsstring

Products

Example: "['EC2InstanceReserved', 'ComputeReserved']"

autoRiYnstring

If retrieve only AutoRI or not

searchTypestring

Search type

Example: "All, My, AutoSavings"

commitmentServicestring

AWS commitment service type

Example: "all, savings-plans, reserved-instance"

Response

Body

statusstring

errorError (object)

Codeinteger (int32)

Messagestring

dataAwsCommonFilterResultModel (object)

data

accountsarray of CommonCodeWithParentModel (object)

Linked Account ID

Example: "['123456789011', '123456789012']"

codestring

Code

Example: "ap-northeast-2"

namestring

Code name

Example: "Asia Pacific (Seoul)"

parentCodestring

Parent code(Code for group)

Example: "RGNCONVERT"

codesarray of string

Selected codes

Example: "['t3s','m5','c5']"

itemsstring

Selected codes

Example: "['t3s','m5','c5']"

sortinteger (int32)

정렬

productsarray of CommonCodeWithParentModel (object)

Products

Example: "[ {'code':'EC2InstanceReserved', 'value':'EC2 Instance'} ]"

codestring

Code

Example: "ap-northeast-2"

namestring

Code name

Example: "Asia Pacific (Seoul)"

parentCodestring

Parent code(Code for group)

Example: "RGNCONVERT"

codesarray of string

Selected codes

Example: "['t3s','m5','c5']"

itemsstring

Selected codes

Example: "['t3s','m5','c5']"

sortinteger (int32)

정렬

regionsarray of CommonCodeWithParentModel (object)

Regions

Example: "[ {'code':'EC2InstanceReserved', 'value':'EC2 Instance'} ]"

codestring

Code

Example: "ap-northeast-2"

namestring

Code name

Example: "Asia Pacific (Seoul)"

parentCodestring

Parent code(Code for group)

Example: "RGNCONVERT"

codesarray of string

Selected codes

Example: "['t3s','m5','c5']"

itemsstring

Selected codes

Example: "['t3s','m5','c5']"

sortinteger (int32)

정렬

instanceTypesarray of string

Instance types

Example: "[ 't2.micro', 'm4.xlarge' ]"

itemsstring

Instance types

Example: "[ 't2.micro', 'm4.xlarge' ]"

opsNowProductsarray of string

OpsNow product types

Example: "[ 'SELF', 'AUTO-RI']"

itemsstring

OpsNow product types

Example: "[ 'SELF', 'AUTO-RI']"

Request

Response

Get Savings Plans Inventory List

GEThttps://api.opsnow.io/cost/v3/autosave/companies/{companyId}/vendors/aws/services/integration/inventory/list

Authorization

Path parameters

companyId*string

Company ID

Example: 1

Query parameters

dateTypeenum

Date query type

Example: "DAILY"

{DAILY, MONTHLY}

startDate*string

Start Date

Example: "2023-10-01"

endDate*string

End Date

Example: "2023-10-31"

accountsstring

Linked Account ID

Example: "['123456789011', '123456789012']"

productsstring

Products

Example: "['EC2InstanceReserved', 'ComputeReserved']"

regionsstring

Regions

Example: "[ {'code':'EC2InstanceReserved', 'value':'EC2 Instance'} ]"

instanceTypesstring

Instance types

Example: "[ 't2.micro', 'm4.xlarge' ]"

opsnowProductCodesstring

OpsNow RI Purchase types

Example: "[ 'AUTO-RI', 'AUTO-SP', 'CLIENT-RI' ]"

searchTypestring

Search type

Example: "All, My, AutoSavings"

Response

Body

statusstring

errorError (object)

Codeinteger (int32)

Messagestring

listarray of AwsIntegrationInventoryModel (object)

inventoryIdstring

Inventory ID

Example: "3118c6a8-7fc3-4b5d-8b53-a82fbe6f3169"

linkedAccountIdstring

Linked account ID

Example: "123456789012"

linkedAccountAliasstring

Linked account Name

Example: "Bespinglobal Platform"

productCodestring

Product type code

Example: "AmazonEC2"

productNamestring

Product type name

Example: "EC2"

instanceTypestring

Instance type

Example: "c4.xlarge"

regionCodestring

Region code

Example: "ap-northeast-2"

regionNamestring

Region name

Example: "Asia Pacific (Seoul)"

purchaseOptionstring

Payment option

Example: "All Upfront"

remainingDaysinteger (int32)

Contract remaining days

Example: 365

startDatestring

Contract start date

Example: "2019-01-01 23:59:59"

endDatestring

Contract end date

Example: "2011-01-01 23:59:58"

durationinteger (int32)

Contract unit(seconds)

Example: 31536000

platformstring

Platform(OS)

Example: "Linux/UNIX"

operationNamestring

Operation Name

Example: "RunInstances"

statusstring

Commitment status

Example: "active"

arnstring

ARN

Example: "arn:aws:rds:ap-northeast-2:249145062117:ri:ri-2020-05-15-05-12-58-377"

hourlyCommitmentCostnumber (double)

Hourly commitment cost

Example: 100

upfrontFeenumber (double)

Upfront fee

Example: 777

recurringFeenumber (double)

Recurring fee

Example: 777

Request

Response

Overview Monthly Overview Savings

GEThttps://api.opsnow.io/cost/v3/autosave/companies/{companyId}/vendors/aws/services/integration/utilizations/overview-savings

Authorization

Path parameters

companyId*string

Company ID

Query parameters

startDatestring

Search start date

endDatestring

Search end date

Response

Body

statusstring

errorError (object)

Codeinteger (int32)

Messagestring

stateAwsAutoSavingsAccountSubscriptionStateModel (object)

The subscription states of AutoSavings for the registered accounts.

totalCountinteger (int32)

전체 계정 수

subscriptionCountinteger (int32)

구독 계정 수

stateenum

구독 상태

NONEPARTIALALL

savingsCostnumber (double)

절감액

monthlyEstimateCostnumber (double)

예상 절감액

accountsarray of AwsAutoSavingsAccountSubscriptionModel (object)

계정 구독 현황 목록

linkedAccountIdstring

linkedAccountNamestring

autoRiSubscribedboolean

autoSpSubscribedboolean

subscribedboolean

purchaseboolean

estimatedCostnumber (double)

accountStatusstring

listarray of AwsMonthlyNetSavingsModel (object)

List of hourly & estimated net savings

yearMonthstring

Year & Month

lastDaystring

Linked Account Name

Example: "Service Platform"

totalSavingCostnumber (double)

Total net savings cost

autoSavingCostnumber (double)

AutoSavings net savings cost

mySavingCostnumber (double)

My Commitment net savings cost

estimatedCostnumber (double)

Estimated net savings cost

estimatedAutoSavingCostnumber (double)

Estimated AutoSavings net savings cost - Added to only estimated future cost information

estimatedMySavingCostnumber (double)

Estimated My Commitment net savings cost - Added to only estimated future cost information

savingsCostComparedPreviousMonthnumber (double)

전월 대비 절감액

savingsRateComparedPreviousMonthnumber (double)

전월 대비 절감률

lastMonthNetSavingsAwsMonthlyNetSavingsModel (object)

Last month's net savings

yearMonthstring

Year & Month

lastDaystring

Linked Account Name

Example: "Service Platform"

totalSavingCostnumber (double)

Total net savings cost

autoSavingCostnumber (double)

AutoSavings net savings cost

mySavingCostnumber (double)

My Commitment net savings cost

estimatedCostnumber (double)

Estimated net savings cost

estimatedAutoSavingCostnumber (double)

Estimated AutoSavings net savings cost - Added to only estimated future cost information

estimatedMySavingCostnumber (double)

Estimated My Commitment net savings cost - Added to only estimated future cost information

savingsCostComparedPreviousMonthnumber (double)

전월 대비 절감액

savingsRateComparedPreviousMonthnumber (double)

전월 대비 절감률

Request

Response

Get Agreement Utilization List

GEThttps://api.opsnow.io/cost/v3/autosave/companies/{companyId}/vendors/aws/services/integration/utilizations

Authorization

Path parameters

companyId*string

Company ID

Example: 1

Query parameters

dateTypeenum

Date query type

Example: "DAILY"

{DAILY, MONTHLY}

startDate*string

Start Date

Example: "2023-10-01"

endDate*string

End Date

Example: "2023-10-31"

accountsstring

Linked Account ID

Example: "['123456789011', '123456789012']"

productsstring

Products

Example: "['EC2InstanceReserved', 'ComputeReserved']"

regionsstring

Regions

Example: "[ {'code':'EC2InstanceReserved', 'value':'EC2 Instance'} ]"

instanceTypesstring

Instance types

Example: "[ 't2.micro', 'm4.xlarge' ]"

opsnowProductCodesstring

OpsNow RI Purchase types

Example: "[ 'AUTO-RI', 'AUTO-SP', 'CLIENT-RI' ]"

searchTypestring

Search type

Example: "All, My, AutoSavings"

Response

Body

statusstring

errorError (object)

Codeinteger (int32)

Messagestring

listarray of AwsIntegrationUtilizationModel (object)

Utilization List

utilizationnumber (double)

Utilization(%)

Example: 78.15

commitmentCostnumber (double)

Total commitment cost($)

Example: 2880

usedCommitmentCostnumber (double)

Cost paid by RI($)

Example: 3690.19

netSavingsCostnumber (double)

Net savings cost - On-Demand equivalent($)

Example: 810.19

usedCommitmentCostOnDemandEquivalentnumber (double)

Cost paid by RI - On-Demand equivalent($)

netSavingsRatenumber (double)

Savings rate(%)

Example: 28.13

opsNowProductstring

Applied OpsNow product

Example: "AUTO-RI"

inventoryIdstring

inventory ID

Example: "ri-2020-03-27-04-12-02-595"

inventoryArnstring

inventory ARN

Example: "arn:aws:rds:ap-northeast-2:216093335544:ri:ri-2020-03-27-04-12-02-595"

linkedAccountIdstring

Linked account ID

Example: "123456789012"

linkedAccountAliasstring

Linked account Name

Example: "Bespinglobal Platform"

productCodestring

Product code

Example: "EC2InstanceSavingsPlans"

productNamestring

Product name

Example: "EC2 Instance"

instanceTypestring

Instance type

Example: "c5.2xlarge"

instanceSizestring

Instance size

Example: "c4.xlarge"

regionCodestring

Region code

Example: "ap-northeast-2"

regionNamestring

Region name

Example: "Asia Pacific (Seoul)"

purchaseOptionstring

Payment option

Example: "All Upfront"

startDatestring (date-time)

Contract start date

endDatestring (date-time)

Contract end date

Request

Response

Get Savings Plans total summary

Get Coverage Total summary

GEThttps://api.opsnow.io/cost/v3/autosave/companies/{companyId}/vendors/aws/services/integration/coverages/aggregated

Authorization

Path parameters

companyId*string

Company ID

Example: 1

Query parameters

dateTypeenum

Date query type

Example: "DAILY"

{DAILY, MONTHLY}

startDate*string

Start Date

Example: "2020-10-01"

endDate*string

End Date

Example: "2020-10-31"

accountsstring

Linked Account IDs

Example: "['123456789011', '123456789012']"

productsstring

Products

Example: "['EC2InstanceReserved', 'ComputeReserved']"

autoRiYnstring

If retrieve only AutoRI or not

searchTypestring

Search type

Example: "All, My, AutoSavings"

commitmentServicestring

AWS commitment service type

Example: "all, savings-plans, reserved-instance"

Response

Body

statusstring

errorError (object)

Codeinteger (int32)

Messagestring

dataAwsCoverageValuesModel (object)

reservedInstanceCoverageRatenumber (double)

Reserved Instance coverage

savingsPlansCoverageRatenumber (double)

Savings Plans coverage

autoRiCoverageRatenumber (double)

AutoRI coverage

autoSpCoverageRatenumber (double)

AutoSP coverage

onDemandCoverageRatenumber (double)

On-Demand coverage

reservedInstanceOnDemandCostEquivalentnumber (double)

Reserved Instance On-Demand equivalent

savingsPlansOnDemandCostEquivalentnumber (double)

Savings Plans On-Demand equivalent

autoRiOnDemandCostEquivalentnumber (double)

AutoRI On-Demand equivalent

autoSpOnDemandCostEquivalentnumber (double)

AutoSP On-Demand equivalent

onDemandCostnumber (double)

On-Demand Cost($)

totalOnDemandCostEquivalentnumber (double)

Total Cost

reservedInstanceNormalizeFactorAmountnumber (double)

Reserved Instance normalized factor amount

savingsPlansNormalizeFactorAmountnumber (double)

Savings Plans normalized factor amount

autoRiNormalizeFactorAmountnumber (double)

AutoRI normalized factor amount

autoSpNormalizeFactorAmountnumber (double)

AutoSP normalized factor amount

onDemandNormalizeFactorAmountnumber (double)

On-Demand normalized factor amount

totalNormalizeFactorAmountnumber (double)

Total normalized factor amount

reservedInstanceAmountnumber (double)

Reserved Instance usage amount

savingsPlansAmountnumber (double)

Savings Plans usage amount

autoRiAmountnumber (double)

AutoRI usage amount

autoSpAmountnumber (double)

AutoSP usage amount

onDemandAmountnumber (double)

On-Demand usage amount

totalAmountnumber (double)

Total usage amount

Request

Response

Get Savings Plans Total Transition

Get Coverage Total Transition

GEThttps://api.opsnow.io/cost/v3/autosave/companies/{companyId}/vendors/aws/services/integration/coverages/time-series/{dateType}

Authorization

Path parameters

companyId*string

Company ID

Example: 1

dateType*string

Date query type

Example: "DAILY"

Query parameters

startDate*string

Start Date

Example: "2020-10-01"

endDate*string

End Date

Example: "2020-10-31"

accountsstring

Linked Account IDs

Example: "['123456789011', '123456789012']"

productsstring

Products

Example: "['EC2InstanceReserved', 'ComputeReserved']"

autoRiYnstring

If retrieve only AutoRI or not

searchTypestring

Search type

Example: "All, My, AutoSavings"

commitmentServicestring

AWS commitment service type

Example: "all, savings-plans, reserved-instance"

Response

Body

statusstring

errorError (object)

Codeinteger (int32)

Messagestring

listarray of AwsCoverageTransitionModel (object)

reservedInstanceCoverageRatenumber (double)

Reserved Instance coverage

savingsPlansCoverageRatenumber (double)

Savings Plans coverage

autoRiCoverageRatenumber (double)

AutoRI coverage

autoSpCoverageRatenumber (double)

AutoSP coverage

onDemandCoverageRatenumber (double)

On-Demand coverage

reservedInstanceOnDemandCostEquivalentnumber (double)

Reserved Instance On-Demand equivalent

savingsPlansOnDemandCostEquivalentnumber (double)

Savings Plans On-Demand equivalent

autoRiOnDemandCostEquivalentnumber (double)

AutoRI On-Demand equivalent

autoSpOnDemandCostEquivalentnumber (double)

AutoSP On-Demand equivalent

onDemandCostnumber (double)

On-Demand Cost($)

totalOnDemandCostEquivalentnumber (double)

Total Cost

reservedInstanceNormalizeFactorAmountnumber (double)

Reserved Instance normalized factor amount

savingsPlansNormalizeFactorAmountnumber (double)

Savings Plans normalized factor amount

autoRiNormalizeFactorAmountnumber (double)

AutoRI normalized factor amount

autoSpNormalizeFactorAmountnumber (double)

AutoSP normalized factor amount

onDemandNormalizeFactorAmountnumber (double)

On-Demand normalized factor amount

totalNormalizeFactorAmountnumber (double)

Total normalized factor amount

reservedInstanceAmountnumber (double)

Reserved Instance usage amount

savingsPlansAmountnumber (double)

Savings Plans usage amount

autoRiAmountnumber (double)

AutoRI usage amount

autoSpAmountnumber (double)

AutoSP usage amount

onDemandAmountnumber (double)

On-Demand usage amount

totalAmountnumber (double)

Total usage amount

usageDate*string

Usage date

Example: "2020-07-01"

Request

Response

Get Savings Plans List

Get Coverage List

GEThttps://api.opsnow.io/cost/v3/autosave/companies/{companyId}/vendors/aws/services/integration/coverages

Authorization

Path parameters

companyId*string

Company ID

Example: 1

Query parameters

dateTypeenum

Date query type

Example: "DAILY"

{DAILY, MONTHLY}

startDate*string

Start Date

Example: "2020-10-01"

endDate*string

End Date

Example: "2020-10-31"

accountsstring

Linked Account IDs

Example: "['123456789011', '123456789012']"

productsstring

Products

Example: "['EC2InstanceReserved', 'ComputeReserved']"

autoRiYnstring

If retrieve only AutoRI or not

searchTypestring

Search type

Example: "All, My, AutoSavings"

commitmentServicestring

AWS commitment service type

Example: "all, savings-plans, reserved-instance"

Response

Body

statusstring

errorError (object)

Codeinteger (int32)

Messagestring

listarray of AwsCoverageModel (object)

reservedInstanceCoverageRatenumber (double)

Reserved Instance coverage

savingsPlansCoverageRatenumber (double)

Savings Plans coverage

autoRiCoverageRatenumber (double)

AutoRI coverage

autoSpCoverageRatenumber (double)

AutoSP coverage

onDemandCoverageRatenumber (double)

On-Demand coverage

reservedInstanceOnDemandCostEquivalentnumber (double)

Reserved Instance On-Demand equivalent

savingsPlansOnDemandCostEquivalentnumber (double)

Savings Plans On-Demand equivalent

autoRiOnDemandCostEquivalentnumber (double)

AutoRI On-Demand equivalent

autoSpOnDemandCostEquivalentnumber (double)

AutoSP On-Demand equivalent

onDemandCostnumber (double)

On-Demand Cost($)

totalOnDemandCostEquivalentnumber (double)

Total Cost

reservedInstanceNormalizeFactorAmountnumber (double)

Reserved Instance normalized factor amount

savingsPlansNormalizeFactorAmountnumber (double)

Savings Plans normalized factor amount

autoRiNormalizeFactorAmountnumber (double)

AutoRI normalized factor amount

autoSpNormalizeFactorAmountnumber (double)

AutoSP normalized factor amount

onDemandNormalizeFactorAmountnumber (double)

On-Demand normalized factor amount

totalNormalizeFactorAmountnumber (double)

Total normalized factor amount

reservedInstanceAmountnumber (double)

Reserved Instance usage amount

savingsPlansAmountnumber (double)

Savings Plans usage amount

autoRiAmountnumber (double)

AutoRI usage amount

autoSpAmountnumber (double)

AutoSP usage amount

onDemandAmountnumber (double)

On-Demand usage amount

totalAmountnumber (double)

Total usage amount

linkedAccountIdstring

Linked Account ID

Example: "123456789011"

linkedAccountAliasstring

Linked Account Name

Example: "Service Platform"

productCodestring

제품코드

Example: "AmazonEC2"

productNamestring

제품명

Example: "EC2"

platformstring

Platform Code

Example: "Linux"

instanceTypestring

인스턴스타입

Example: "c4.xlarge"

instanceSizestring

인스턴스사이즈

Example: "c4.xlarge"

tenancystring

Tenancy

Example: "Shared"

regionCodestring

리전 코드

Example: "ap-northeast-2"

regionNamestring

리전 이름

Example: "Asia Pacific (Seoul)"

Request

Response

Get category list of AWS commitment utilization

Retrieve the categories of AWS commitment utilization. The items within these categories can be used when categorizing the values of commitment related to utilization.

GEThttps://api.opsnow.io/cost/v3/commitment/companies/{companyId}/vendors/aws/services/all/utilizations/categories

Authorization

Path parameters

companyId*string

Company ID

Example: 1

Query parameters

dateTypeenum

Date query type

Example: "DAILY"

{DAILY, MONTHLY}

startDate*string

Start Date

Example: "2020-10-01"

endDate*string

End Date

Example: "2020-10-31"

accountsstring

Linked Account ID

Example: "['123456789011', '123456789012']"

productsstring

Service type

Example: "['EC2InstanceReserved', 'ComputeReserved']"

isExpiredstring

Whether the commitment is expired

Example: false

searchTypestring

Commitment search Type

Example: "All, My, AutoSavings"

Response

Body

statusstring

errorError (object)

Codeinteger (int32)

Messagestring

dataAwsSavingsPlansFilterResultModel (object)

accountsarray of CommonCodeWithParentModel (object)

Linked Account ID

codestring

Code

Example: "ap-northeast-2"

namestring

Code name

Example: "Asia Pacific (Seoul)"

parentCodestring

Parent code(Code for group)

Example: "RGNCONVERT"

codesarray of string

Selected codes

Example: "['t3s','m5','c5']"

itemsstring

Selected codes

Example: "['t3s','m5','c5']"

sortinteger (int32)

정렬

productsarray of CommonCodeWithParentModel (object)

Service types(products)

codestring

Code

Example: "ap-northeast-2"

namestring

Code name

Example: "Asia Pacific (Seoul)"

parentCodestring

Parent code(Code for group)

Example: "RGNCONVERT"

codesarray of string

Selected codes

Example: "['t3s','m5','c5']"

itemsstring

Selected codes

Example: "['t3s','m5','c5']"

sortinteger (int32)

정렬

Request

Response

Get category list of GCP commitment coverage

Retrieve the categories of GCP commitment coverage. The items within these categories can be used when categorizing the values of commitment related to coverage.

GEThttps://api.opsnow.io/cost/v3/commitment/companies/{companyId}/vendors/gcp/services/cud/coverages/categories

Authorization

Path parameters

companyId*string

Company ID

Example: 1

Query parameters

dateTypeenum

Date query type

Example: "DAILY"

{DAILY, MONTHLY}

startDate*string

Search start Date

Example: "2020-10-01"

endDate*string

Search end Date

Example: "2020-10-31"

projectsstring

Project IDs

Example: "['pjt-sample-1', 'pjt-sample-2']"

committedTypesstring

CUD types

Example: "['compute#commitment', 'cloudSql#commitment']"

regionsstring

Regions

Example: "['1', '2']"

machineTypesstring

Machine types

Example: "['GENERAL_PURPOSE_E2','GENERAL_PURPOSE']"

productsstring

Products

resourceTypesstring

Resource types

Response

Body

statusstring

errorError (object)

Codeinteger (int32)

Messagestring

dataGcpCommittedUseDiscountFilterResultModel (object)

data

projectsarray of CommonCodeModel (object)

Projects

codestring

Code

Example: "ap-northeast-2"

namestring

Code name

Example: "Asia Pacific (Seoul)"

commitmentTypesarray of CommonCodeModel (object)

Commitment Types

codestring

Code

Example: "ap-northeast-2"

namestring

Code name

Example: "Asia Pacific (Seoul)"

regionsarray of CommonCodeModel (object)

Regions

codestring

Code

Example: "ap-northeast-2"

namestring

Code name

Example: "Asia Pacific (Seoul)"

machineTypesarray of CommonCodeModel (object)

Machine Types

codestring

Code

Example: "ap-northeast-2"

namestring

Code name

Example: "Asia Pacific (Seoul)"

resourceTypesarray of CommonCodeModel (object)

Resource Types

codestring

Code

Example: "ap-northeast-2"

namestring

Code name

Example: "Asia Pacific (Seoul)"

productsarray of CommonCodeModel (object)

Products

codestring

Code

Example: "ap-northeast-2"

namestring

Code name

Example: "Asia Pacific (Seoul)"

Request

Response

Get category list of user's AWS Reserved Instance utilization

Retrieve the categories of user's AWS Reserved Instance utilization. The items within these categories can be used when categorizing the values of Reserved Instance related to utilization.

GEThttps://api.opsnow.io/cost/v3/commitment/companies/{companyId}/vendors/aws/services/reserved-instance/my-utilizations/categories

Authorization

Path parameters

companyId*string

Company ID

Example: 1

Query parameters

dateTypeenum

Date query type

Example: "DAILY"

{DAILY, MONTHLY}

startDate*string

Start Date

Example: "2020-10-01"

endDate*string

End Date

Example: "2020-10-31"

accountsstring

Linked Account IDs

Example: "['123456789011', '123456789012']"

productsstring

Products

Example: "['EC2InstanceReserved', 'ComputeReserved']"

isExpiredstring

Whether the commitment is expired

searchTypestring

Commitment search type

Example: "All, My, AutoSavings"

Response

Body

statusstring

errorError (object)

Codeinteger (int32)

Messagestring

dataAwsReservedInstanceFilterResultModel (object)

data

accountsarray of CommonCodeWithParentModel (object)

Linked Account ID

codestring

Code

Example: "ap-northeast-2"

namestring

Code name

Example: "Asia Pacific (Seoul)"

parentCodestring

Parent code(Code for group)

Example: "RGNCONVERT"

codesarray of string

Selected codes

Example: "['t3s','m5','c5']"

itemsstring

Selected codes

Example: "['t3s','m5','c5']"

sortinteger (int32)

정렬

productsarray of CommonCodeWithParentModel (object)

서비스 유형(제품)

codestring

Code

Example: "ap-northeast-2"

namestring

Code name

Example: "Asia Pacific (Seoul)"

parentCodestring

Parent code(Code for group)

Example: "RGNCONVERT"

codesarray of string

Selected codes

Example: "['t3s','m5','c5']"

itemsstring

Selected codes

Example: "['t3s','m5','c5']"

sortinteger (int32)

정렬

Request

Response

Get list of AutoSavings AWS Reserved Instance inventory

Retrieve Reserved Instance inventory(purchased by AutoSavings).

GEThttps://api.opsnow.io/cost/v3/commitment/companies/{companyId}/vendors/aws/services/reserved-instance/auto-savings-inventory

Authorization

Path parameters

companyId*string

Company ID

Example: 1

Query parameters

dateTypeenum

Date query type

Example: "DAILY"

{DAILY, MONTHLY}

startDate*string

Start Date

Example: "2020-10-01"

endDate*string

End Date

Example: "2020-10-31"

accountsstring

Linked Account IDs

Example: "['123456789011', '123456789012']"

productsstring

Products

Example: "['EC2InstanceReserved', 'ComputeReserved']"

isExpiredstring

Whether the commitment is expired

searchTypestring

Commitment search type

Example: "All, My, AutoSavings"

Response

Body

statusstring

errorError (object)

Codeinteger (int32)

Messagestring

listarray of AwsReservedInstanceInventoryModel (object)

reservedInstanceIdstring

Reserved ID

Example: "3118c6a8-7fc3-4b5d-8b53-a82fbe6f3169"

linkedAccountIdstring

Linked account ID

Example: "123456789012"

linkedAccountAliasstring

Linked account Name

Example: "Bespinglobal Platform"

productCodestring

Product type code

Example: "AmazonEC2"

productNamestring

Product type name

Example: "EC2"

instanceTypestring

Instance type

Example: "c4.xlarge"

instanceSizestring

Instance size

Example: "xlarge"

regionCodestring

Region code

Example: "ap-northeast-2"

regionNamestring

Region name

Example: "Asia Pacific (Seoul)"

purchaseOptionstring

Payment option

Example: "All Upfront"

remainingDaysinteger (int32)

Contract remaining days

Example: 365

startDatestring

Contract start date

Example: "2019-01-01 23:59:59"

endDatestring

Contract end date

Example: "2011-01-01 23:59:58"

durationinteger (int32)

Contract unit(seconds)

Example: 31536000

platformstring

Platform(OS)

Example: "Linux/UNIX"

useTypestring

Usage Type

Example: "APN2-HeavyUsage:t3.micro"

operationNamestring

Operation Name

Example: "RunInstances"

tenancystring

Tenancy

Example: "Shared"

riCountinteger (int32)

Reserved Count

Example: 5

statusstring

Commitment status

Example: "active"

offerClassstring

Offer Class

Example: "standard"

arnstring

Reserved ARN

Example: "arn:aws:rds:ap-northeast-2:249145062117:ri:ri-2020-05-15-05-12-58-377"

upfrontFeenumber (double)

Upfront fee

Example: 777

recurringFeenumber (double)

Recurring fee

Example: 777

azstring

Availability Zone

Example: "777"

multiAzstring

Multi Availability Zone

Example: "777"

Request

Response

Get list of AutoSavings AWS Savings Plans inventory

Retrieve Savings Plans inventory(purchased by AutoSavings).

GEThttps://api.opsnow.io/cost/v3/commitment/companies/{companyId}/vendors/aws/services/savings-plans/auto-savings-inventory

Authorization

Path parameters

companyId*string

Company ID

Example: 1

Query parameters

dateTypeenum

Date query type

Example: "DAILY"

{DAILY, MONTHLY}

startDate*string

Start Date

Example: "2020-10-01"

endDate*string

End Date

Example: "2020-10-31"

accountsstring

Linked Account ID

Example: "['123456789011', '123456789012']"

productsstring

Service type

Example: "['EC2InstanceReserved', 'ComputeReserved']"

isExpiredstring

Whether the commitment is expired

Example: false

searchTypestring

Commitment search Type

Example: "All, My, AutoSavings"

Response

Body

statusstring

errorError (object)

Codeinteger (int32)

Messagestring

listarray of AwsSavingsPlansInventoryModel (object)

savingsPlansIdstring

Savings plans ID

Example: "3118c6a8-7fc3-4b5d-8b53-a82fbe6f3169"

linkedAccountIdstring

Linked account ID

Example: "123456789012"

linkedAccountAliasstring

Linked account Name

Example: "123456789012"

productCodestring

Product code

Example: "EC2InstanceSavingsPlans"

productNamestring

Product name

Example: "EC2 Instance"

instanceFamilystring

Instance family

Example: "c4"

regionCodestring

Region code

Example: "ap-northeast-2"

regionNamestring

Region name

Example: "Asia Pacific (Seoul)"

purchaseOptionstring

Payment option

Example: "All Upfront"

remainingDaysinteger (int32)

Remaining contract days

Example: 365

startDatestring

Contract start date

Example: "2019-01-01 23:59:59"

endDatestring

Contract end date

Example: "2011-01-01 23:59:58"

durationinteger (int32)

Contract unit(second)

Example: 31536000

useTypestring

operationNamestring

statusstring

Commitment status

Example: "active"

arnstring

Savings Plans ARN

Example: "arn:aws:savingsplans::123456789012:savingsplan/3118c6a8-7fc3-4b5d-8b53-a82fbe6f3169"

hourlyCommitmentCostnumber (double)

Commitment cost(hourly)

Example: 100

upfrontFeenumber (double)

Upfront fee

Example: 100

recurringFeenumber (double)

Recurring fee

Example: 100

Request

Response

Get category list of AWS Reserved Instance inventory

Retrieve the categories of AWS Reserved Instance inventory. The items within these categories can be used when categorizing the Reserved Instance commitments.

GEThttps://api.opsnow.io/cost/v3/commitment/companies/{companyId}/vendors/aws/services/reserved-instance/inventory/categories

Authorization

Path parameters

companyId*string

Company ID

Example: 1

Query parameters

dateTypeenum

Date query type

Example: "DAILY"

{DAILY, MONTHLY}

startDate*string

Start Date

Example: "2020-10-01"

endDate*string

End Date

Example: "2020-10-31"

accountsstring

Linked Account IDs

Example: "['123456789011', '123456789012']"

productsstring

Products

Example: "['EC2InstanceReserved', 'ComputeReserved']"

isExpiredstring

Whether the commitment is expired

searchTypestring

Commitment search type

Example: "All, My, AutoSavings"

Response

Body

statusstring

errorError (object)

Codeinteger (int32)

Messagestring

dataAwsReservedInstanceFilterResultModel (object)

data

accountsarray of CommonCodeWithParentModel (object)

Linked Account ID

codestring

Code

Example: "ap-northeast-2"

namestring

Code name

Example: "Asia Pacific (Seoul)"

parentCodestring

Parent code(Code for group)

Example: "RGNCONVERT"

codesarray of string

Selected codes

Example: "['t3s','m5','c5']"

itemsstring

Selected codes

Example: "['t3s','m5','c5']"

sortinteger (int32)

정렬

productsarray of CommonCodeWithParentModel (object)

서비스 유형(제품)

codestring

Code

Example: "ap-northeast-2"

namestring

Code name

Example: "Asia Pacific (Seoul)"

parentCodestring

Parent code(Code for group)

Example: "RGNCONVERT"

codesarray of string

Selected codes

Example: "['t3s','m5','c5']"

itemsstring

Selected codes

Example: "['t3s','m5','c5']"

sortinteger (int32)

정렬

Request

Response

Get utilization summary of AWS Reserved Instance

Retrieve aggregated utilization summary for AWS Reserved Instance.

GEThttps://api.opsnow.io/cost/v3/commitment/companies/{companyId}/vendors/aws/services/reserved-instance/utilizations/aggregated

Authorization

Path parameters

companyId*string

Company ID

Example: 1

Query parameters

dateTypeenum

Date query type

Example: "DAILY"

{DAILY, MONTHLY}

startDate*string

Start Date

Example: "2020-10-01"

endDate*string

End Date

Example: "2020-10-31"

accountsstring

Linked Account IDs

Example: "['123456789011', '123456789012']"

productsstring

Products

Example: "['EC2InstanceReserved', 'ComputeReserved']"

isExpiredstring

Whether the commitment is expired

searchTypestring

Commitment search type

Example: "All, My, AutoSavings"

Response

Body

statusstring

errorError (object)

Codeinteger (int32)

Messagestring

dataAwsUtilizationPaymentModel (object)

utilizationnumber (double)

Utilization(%)

Example: 78.15

commitmentCostnumber (double)

Total commitment cost($)

Example: 3690.19

usedCommitmentCostnumber (double)

Used Savings Plans commitment cost($)

Example: 2880

netSavingsCostnumber (double)

Net savings cost On-Demand equivalent($)

Example: 810.19

netSavingsRatenumber (double)

Savings rate(%)

usedCommitmentCostOnDemandEquivalentnumber (double)

Used Savings Plans commitment cost On-Demand equivalent($)

usageDatestring

사용일

Example: "2020-07-01"

utilizationnumber (double)

Utilization(%)

Example: 78.15

commitmentCostnumber (double)

Total commitment cost($)

Example: 3690.19

usedCommitmentCostnumber (double)

Used Savings Plans commitment cost($)

Example: 2880

netSavingsCostnumber (double)

Net savings cost On-Demand equivalent($)

Example: 810.19

netSavingsRatenumber (double)

Savings rate(%)

usedCommitmentCostOnDemandEquivalentnumber (double)

Used Savings Plans commitment cost On-Demand equivalent($)

Request

Response

Get category list of AWS Savings Plans inventory

Retrieve the categories of AWS Savings Plans inventory. The items within these categories can be used when categorizing the Savings Plans commitments.

GEThttps://api.opsnow.io/cost/v3/commitment/companies/{companyId}/vendors/aws/services/savings-plans/inventory/categories

Authorization

Path parameters

companyId*string

Company ID

Example: 1

Query parameters

dateTypeenum

Date query type

Example: "DAILY"

{DAILY, MONTHLY}

startDate*string

Start Date

Example: "2020-10-01"

endDate*string

End Date

Example: "2020-10-31"

accountsstring

Linked Account ID

Example: "['123456789011', '123456789012']"

productsstring

Service type

Example: "['EC2InstanceReserved', 'ComputeReserved']"

isExpiredstring

Whether the commitment is expired

Example: false

searchTypestring

Commitment search Type

Example: "All, My, AutoSavings"

Response

Body

statusstring

errorError (object)

Codeinteger (int32)

Messagestring

dataAwsSavingsPlansFilterResultModel (object)

accountsarray of CommonCodeWithParentModel (object)

Linked Account ID

codestring

Code

Example: "ap-northeast-2"

namestring

Code name

Example: "Asia Pacific (Seoul)"

parentCodestring

Parent code(Code for group)

Example: "RGNCONVERT"

codesarray of string

Selected codes

Example: "['t3s','m5','c5']"

itemsstring

Selected codes

Example: "['t3s','m5','c5']"

sortinteger (int32)

정렬

productsarray of CommonCodeWithParentModel (object)

Service types(products)

codestring

Code

Example: "ap-northeast-2"

namestring

Code name

Example: "Asia Pacific (Seoul)"

parentCodestring

Parent code(Code for group)

Example: "RGNCONVERT"

codesarray of string

Selected codes

Example: "['t3s','m5','c5']"

itemsstring

Selected codes

Example: "['t3s','m5','c5']"

sortinteger (int32)

정렬

Request

Response

Get utilization summary of AWS Savings Plans

Retrieve aggregated utilization summary for AWS Savings Plans.

GEThttps://api.opsnow.io/cost/v3/commitment/companies/{companyId}/vendors/aws/services/savings-plans/utilizations/aggregated

Authorization

Path parameters

companyId*string

Company ID

Example: 1

Query parameters

dateTypeenum

Date query type

Example: "DAILY"

{DAILY, MONTHLY}

startDate*string

Start Date

Example: "2020-10-01"

endDate*string

End Date

Example: "2020-10-31"

accountsstring

Linked Account ID

Example: "['123456789011', '123456789012']"

productsstring

Service type

Example: "['EC2InstanceReserved', 'ComputeReserved']"

isExpiredstring

Whether the commitment is expired

Example: false

searchTypestring

Commitment search Type

Example: "All, My, AutoSavings"

Response

Body

statusstring

errorError (object)

Codeinteger (int32)

Messagestring

dataAwsUtilizationPaymentModel (object)

utilizationnumber (double)

Utilization(%)

Example: 78.15

commitmentCostnumber (double)

Total commitment cost($)

Example: 3690.19

usedCommitmentCostnumber (double)

Used Savings Plans commitment cost($)

Example: 2880

netSavingsCostnumber (double)

Net savings cost On-Demand equivalent($)

Example: 810.19

netSavingsRatenumber (double)

Savings rate(%)

usedCommitmentCostOnDemandEquivalentnumber (double)

Used Savings Plans commitment cost On-Demand equivalent($)

usageDatestring

사용일

Example: "2020-07-01"

utilizationnumber (double)

Utilization(%)

Example: 78.15

commitmentCostnumber (double)

Total commitment cost($)

Example: 3690.19

usedCommitmentCostnumber (double)

Used Savings Plans commitment cost($)

Example: 2880

netSavingsCostnumber (double)

Net savings cost On-Demand equivalent($)

Example: 810.19

netSavingsRatenumber (double)

Savings rate(%)

usedCommitmentCostOnDemandEquivalentnumber (double)

Used Savings Plans commitment cost On-Demand equivalent($)

Request

Response

Get category list of GCP CUD(Committed Use Discount) inventory

Retrieve the categories of GCP CUD(Committed Use Discount) inventory. The items within these categories can be used when categorizing the Reserved Instance commitments.

GEThttps://api.opsnow.io/cost/v3/commitment/companies/{companyId}/vendors/gcp/services/cud/inventory/categories

Authorization

Path parameters

companyId*string

Company ID

Example: 1

Query parameters

dateTypeenum

Date query type

Example: "DAILY"

{DAILY, MONTHLY}

startDate*string

Search start Date

Example: "2020-10-01"

endDate*string

Search end Date

Example: "2020-10-31"

projectsstring

Project IDs

Example: "['pjt-sample-1', 'pjt-sample-2']"

committedTypesstring

CUD types

Example: "['compute#commitment', 'cloudSql#commitment']"

regionsstring

Regions

Example: "['1', '2']"

machineTypesstring

Machine types

Example: "['GENERAL_PURPOSE_E2','GENERAL_PURPOSE']"

productsstring

Products

resourceTypesstring

Resource types

Response

Body

statusstring

errorError (object)

Codeinteger (int32)

Messagestring

dataGcpCommittedUseDiscountFilterResultModel (object)

data

projectsarray of CommonCodeModel (object)

Projects

codestring

Code

Example: "ap-northeast-2"

namestring

Code name

Example: "Asia Pacific (Seoul)"

commitmentTypesarray of CommonCodeModel (object)

Commitment Types

codestring

Code

Example: "ap-northeast-2"

namestring

Code name

Example: "Asia Pacific (Seoul)"

regionsarray of CommonCodeModel (object)

Regions

codestring

Code

Example: "ap-northeast-2"

namestring

Code name

Example: "Asia Pacific (Seoul)"

machineTypesarray of CommonCodeModel (object)

Machine Types

codestring

Code

Example: "ap-northeast-2"

namestring

Code name

Example: "Asia Pacific (Seoul)"

resourceTypesarray of CommonCodeModel (object)

Resource Types

codestring

Code

Example: "ap-northeast-2"

namestring

Code name

Example: "Asia Pacific (Seoul)"

productsarray of CommonCodeModel (object)

Products

codestring

Code

Example: "ap-northeast-2"

namestring

Code name

Example: "Asia Pacific (Seoul)"

Request

Response

Get list of user's AWS Reserved Instance inventory

Retrieve Reserved Instance inventory(purchased by user).

GEThttps://api.opsnow.io/cost/v3/commitment/companies/{companyId}/vendors/aws/services/reserved-instance/my-inventory

Authorization

Path parameters

companyId*string

Company ID

Example: 1

Query parameters

dateTypeenum

Date query type

Example: "DAILY"

{DAILY, MONTHLY}

startDate*string

Start Date

Example: "2020-10-01"

endDate*string

End Date

Example: "2020-10-31"

accountsstring

Linked Account IDs

Example: "['123456789011', '123456789012']"

productsstring

Products

Example: "['EC2InstanceReserved', 'ComputeReserved']"

isExpiredstring

Whether the commitment is expired

searchTypestring

Commitment search type

Example: "All, My, AutoSavings"

Response

Body

statusstring

errorError (object)

Codeinteger (int32)

Messagestring

listarray of AwsReservedInstanceInventoryModel (object)

reservedInstanceIdstring

Reserved ID

Example: "3118c6a8-7fc3-4b5d-8b53-a82fbe6f3169"

linkedAccountIdstring

Linked account ID

Example: "123456789012"

linkedAccountAliasstring

Linked account Name

Example: "Bespinglobal Platform"

productCodestring

Product type code

Example: "AmazonEC2"

productNamestring

Product type name

Example: "EC2"

instanceTypestring

Instance type

Example: "c4.xlarge"

instanceSizestring

Instance size

Example: "xlarge"

regionCodestring

Region code

Example: "ap-northeast-2"

regionNamestring

Region name

Example: "Asia Pacific (Seoul)"

purchaseOptionstring

Payment option

Example: "All Upfront"

remainingDaysinteger (int32)

Contract remaining days

Example: 365

startDatestring

Contract start date

Example: "2019-01-01 23:59:59"

endDatestring

Contract end date

Example: "2011-01-01 23:59:58"

durationinteger (int32)

Contract unit(seconds)

Example: 31536000

platformstring

Platform(OS)

Example: "Linux/UNIX"

useTypestring

Usage Type

Example: "APN2-HeavyUsage:t3.micro"

operationNamestring

Operation Name

Example: "RunInstances"

tenancystring

Tenancy

Example: "Shared"

riCountinteger (int32)

Reserved Count

Example: 5

statusstring

Commitment status

Example: "active"

offerClassstring

Offer Class

Example: "standard"

arnstring

Reserved ARN

Example: "arn:aws:rds:ap-northeast-2:249145062117:ri:ri-2020-05-15-05-12-58-377"

upfrontFeenumber (double)

Upfront fee

Example: 777

recurringFeenumber (double)

Recurring fee

Example: 777

azstring

Availability Zone

Example: "777"

multiAzstring

Multi Availability Zone

Example: "777"

Request

Response

Get utilization data of AWS Reserved Instance

Retrieve utilization data of each AWS Reserved Instance.

GEThttps://api.opsnow.io/cost/v3/commitment/companies/{companyId}/vendors/aws/services/reserved-instance/utilizations

Authorization

Path parameters

companyId*string

Company ID

Example: 1

Query parameters

dateTypeenum

Date query type

Example: "DAILY"

{DAILY, MONTHLY}

startDate*string

Start Date

Example: "2020-10-01"

endDate*string

End Date

Example: "2020-10-31"

accountsstring

Linked Account IDs

Example: "['123456789011', '123456789012']"

productsstring

Products

Example: "['EC2InstanceReserved', 'ComputeReserved']"

isExpiredstring

Whether the commitment is expired

searchTypestring

Commitment search type

Example: "All, My, AutoSavings"

Response

Body

statusstring

errorError (object)

Codeinteger (int32)

Messagestring

listarray of AwsReservedInstanceUtilizationModel (object)

utilizationnumber (double)

Utilization(%)

Example: 78.15

commitmentCostnumber (double)

Total commitment cost($)

Example: 3690.19

usedCommitmentCostnumber (double)

Used Savings Plans commitment cost($)

Example: 2880

netSavingsCostnumber (double)

Net savings cost On-Demand equivalent($)

Example: 810.19

netSavingsRatenumber (double)

Savings rate(%)

usedCommitmentCostOnDemandEquivalentnumber (double)

Used Savings Plans commitment cost On-Demand equivalent($)

reservedInstanceIdstring

Reserved ID

Example: "ri-2020-03-27-04-12-02-595"

reservedInstanceArnstring

Reserved ARN

Example: "arn:aws:rds:ap-northeast-2:216093335544:ri:ri-2020-03-27-04-12-02-595"

linkedAccountIdstring

Linked account ID

Example: "123456789012"

linkedAccountAliasstring

Linked account Name

Example: "Bespinglobal Platform"

productCodestring

서비스유형 코드

Example: "EC2InstanceSavingsPlans"

productNamestring

서비스유형 이름

Example: "EC2 Instance"

instanceTypestring

인스턴스 타입

Example: "c5.2xlarge"

instanceSizestring

인스턴스사이즈

Example: "c4.xlarge"

tenancystring

Tenancy

Example: "Shared"

regionCodestring

리전 코드

Example: "ap-northeast-2"

regionNamestring

리전 이름

Example: "Asia Pacific (Seoul)"

purchaseOptionstring

Payment option

Example: "All Upfront"

startDatestring

계약시작일

Example: "2019-01-01 23:59:59"

endDatestring

계약종료일

Example: "2011-01-01 23:59:58"

platformstring

Platform(OS)

Example: "Linux/UNIX"

operationNamestring

Operation Name

Example: "RunInstances"

riCountinteger (int32)

Reserved Count

Example: 5

Request

Response

Get list of user's AWS Savings Plans inventory

Retrieve Savings Plans inventory(purchased by user).

GEThttps://api.opsnow.io/cost/v3/commitment/companies/{companyId}/vendors/aws/services/savings-plans/my-inventory

Authorization

Path parameters

companyId*string

Company ID

Example: 1

Query parameters

dateTypeenum

Date query type

Example: "DAILY"

{DAILY, MONTHLY}

startDate*string

Start Date

Example: "2020-10-01"

endDate*string

End Date

Example: "2020-10-31"

accountsstring

Linked Account ID

Example: "['123456789011', '123456789012']"

productsstring

Service type

Example: "['EC2InstanceReserved', 'ComputeReserved']"

isExpiredstring

Whether the commitment is expired

Example: false

searchTypestring

Commitment search Type

Example: "All, My, AutoSavings"

Response

Body

statusstring

errorError (object)

Codeinteger (int32)

Messagestring

listarray of AwsSavingsPlansInventoryModel (object)

savingsPlansIdstring

Savings plans ID

Example: "3118c6a8-7fc3-4b5d-8b53-a82fbe6f3169"

linkedAccountIdstring

Linked account ID

Example: "123456789012"

linkedAccountAliasstring

Linked account Name

Example: "123456789012"

productCodestring

Product code

Example: "EC2InstanceSavingsPlans"

productNamestring

Product name

Example: "EC2 Instance"

instanceFamilystring

Instance family

Example: "c4"

regionCodestring

Region code

Example: "ap-northeast-2"

regionNamestring

Region name

Example: "Asia Pacific (Seoul)"

purchaseOptionstring

Payment option

Example: "All Upfront"

remainingDaysinteger (int32)

Remaining contract days

Example: 365

startDatestring

Contract start date

Example: "2019-01-01 23:59:59"

endDatestring

Contract end date

Example: "2011-01-01 23:59:58"

durationinteger (int32)

Contract unit(second)

Example: 31536000

useTypestring

operationNamestring

statusstring

Commitment status

Example: "active"

arnstring

Savings Plans ARN

Example: "arn:aws:savingsplans::123456789012:savingsplan/3118c6a8-7fc3-4b5d-8b53-a82fbe6f3169"

hourlyCommitmentCostnumber (double)

Commitment cost(hourly)

Example: 100

upfrontFeenumber (double)

Upfront fee

Example: 100

recurringFeenumber (double)

Recurring fee

Example: 100

Request

Response

Get utilization summary trends of AWS Reserved Instance

Retrieve time-series utilization summary for AWS Reserved Instance.

GEThttps://api.opsnow.io/cost/v3/commitment/companies/{companyId}/vendors/aws/services/reserved-instance/utilizations/time-series/{dateType}

Authorization

Path parameters

companyId*string

Company ID

Example: 1

dateType*string

Date query type

Example: "DAILY"

Query parameters

startDate*string

Start Date

Example: "2020-10-01"

endDate*string

End Date

Example: "2020-10-31"

accountsstring

Linked Account IDs

Example: "['123456789011', '123456789012']"

productsstring

Products

Example: "['EC2InstanceReserved', 'ComputeReserved']"

isExpiredstring

Whether the commitment is expired

searchTypestring

Commitment search type

Example: "All, My, AutoSavings"

Response

Body

statusstring

errorError (object)

Codeinteger (int32)

Messagestring

listarray of AwsUtilizationPaymentModel (object)

utilizationnumber (double)

Utilization(%)

Example: 78.15

commitmentCostnumber (double)

Total commitment cost($)

Example: 3690.19

usedCommitmentCostnumber (double)

Used Savings Plans commitment cost($)

Example: 2880

netSavingsCostnumber (double)

Net savings cost On-Demand equivalent($)

Example: 810.19

netSavingsRatenumber (double)

Savings rate(%)

usedCommitmentCostOnDemandEquivalentnumber (double)

Used Savings Plans commitment cost On-Demand equivalent($)

usageDatestring

사용일

Example: "2020-07-01"

utilizationnumber (double)

Utilization(%)

Example: 78.15

commitmentCostnumber (double)

Total commitment cost($)

Example: 3690.19

usedCommitmentCostnumber (double)

Used Savings Plans commitment cost($)

Example: 2880

netSavingsCostnumber (double)

Net savings cost On-Demand equivalent($)

Example: 810.19

netSavingsRatenumber (double)

Savings rate(%)

usedCommitmentCostOnDemandEquivalentnumber (double)

Used Savings Plans commitment cost On-Demand equivalent($)

Request

Response

Get utilization summary trends of AWS Savings Plans

Retrieve time-series utilization summary for AWS Savings Plans.

GEThttps://api.opsnow.io/cost/v3/commitment/companies/{companyId}/vendors/aws/services/savings-plans/utilizations/time-series/{dateType}

Authorization

Path parameters

companyId*string

Company ID

Example: 1

dateType*string

Date query type

Example: "DAILY"

Query parameters

startDate*string

Start Date

Example: "2020-10-01"

endDate*string

End Date

Example: "2020-10-31"

accountsstring

Linked Account ID

Example: "['123456789011', '123456789012']"

productsstring

Service type

Example: "['EC2InstanceReserved', 'ComputeReserved']"

isExpiredstring

Whether the commitment is expired

Example: false

searchTypestring

Commitment search Type

Example: "All, My, AutoSavings"

Response

Body

statusstring

errorError (object)

Codeinteger (int32)

Messagestring

listarray of AwsUtilizationPaymentModel (object)

utilizationnumber (double)

Utilization(%)

Example: 78.15

commitmentCostnumber (double)

Total commitment cost($)

Example: 3690.19

usedCommitmentCostnumber (double)

Used Savings Plans commitment cost($)

Example: 2880

netSavingsCostnumber (double)

Net savings cost On-Demand equivalent($)

Example: 810.19

netSavingsRatenumber (double)

Savings rate(%)

usedCommitmentCostOnDemandEquivalentnumber (double)

Used Savings Plans commitment cost On-Demand equivalent($)

usageDatestring

사용일

Example: "2020-07-01"

utilizationnumber (double)

Utilization(%)

Example: 78.15

commitmentCostnumber (double)

Total commitment cost($)

Example: 3690.19

usedCommitmentCostnumber (double)

Used Savings Plans commitment cost($)

Example: 2880

netSavingsCostnumber (double)

Net savings cost On-Demand equivalent($)

Example: 810.19

netSavingsRatenumber (double)

Savings rate(%)

usedCommitmentCostOnDemandEquivalentnumber (double)

Used Savings Plans commitment cost On-Demand equivalent($)

Request

Response

Get utilization summary of user's AWS Reserved Instance

Retrieve aggregated utilization summary for user's AWS Reserved Instance.

GEThttps://api.opsnow.io/cost/v3/commitment/companies/{companyId}/vendors/aws/services/reserved-instance/my-utilizations/aggregated

Authorization

Path parameters

companyId*string

Company ID

Example: 1

Query parameters

dateTypeenum

Date query type

Example: "DAILY"

{DAILY, MONTHLY}

startDate*string

Start Date

Example: "2020-10-01"

endDate*string

End Date

Example: "2020-10-31"

accountsstring

Linked Account IDs

Example: "['123456789011', '123456789012']"

productsstring

Products

Example: "['EC2InstanceReserved', 'ComputeReserved']"

isExpiredstring

Whether the commitment is expired

searchTypestring

Commitment search type

Example: "All, My, AutoSavings"

Response

Body

statusstring

errorError (object)

Codeinteger (int32)

Messagestring

dataAwsUtilizationPaymentModel (object)

utilizationnumber (double)

Utilization(%)

Example: 78.15

commitmentCostnumber (double)

Total commitment cost($)

Example: 3690.19

usedCommitmentCostnumber (double)

Used Savings Plans commitment cost($)

Example: 2880

netSavingsCostnumber (double)

Net savings cost On-Demand equivalent($)

Example: 810.19

netSavingsRatenumber (double)

Savings rate(%)

usedCommitmentCostOnDemandEquivalentnumber (double)

Used Savings Plans commitment cost On-Demand equivalent($)

usageDatestring

사용일

Example: "2020-07-01"

utilizationnumber (double)

Utilization(%)

Example: 78.15

commitmentCostnumber (double)

Total commitment cost($)

Example: 3690.19

usedCommitmentCostnumber (double)

Used Savings Plans commitment cost($)

Example: 2880

netSavingsCostnumber (double)

Net savings cost On-Demand equivalent($)

Example: 810.19

netSavingsRatenumber (double)

Savings rate(%)

usedCommitmentCostOnDemandEquivalentnumber (double)

Used Savings Plans commitment cost On-Demand equivalent($)

Request

Response

Get utilization summary trends of AWS commitment

Retrieve time-series utilization summary for AWS commitment.

GEThttps://api.opsnow.io/cost/v3/commitment/companies/{companyId}/vendors/aws/services/all/utilizations/time-series/{dateType}

Authorization

Path parameters

companyId*string

Company ID

Example: 1

dateType*string

Date query type

Example: "DAILY"

Query parameters

startDate*string

Start Date

Example: "2020-10-01"

endDate*string

End Date

Example: "2020-10-31"

accountsstring

Linked Account ID

Example: "['123456789011', '123456789012']"

productsstring

Service type

Example: "['EC2InstanceReserved', 'ComputeReserved']"

isExpiredstring

Whether the commitment is expired

Example: false

searchTypestring

Commitment search Type

Example: "All, My, AutoSavings"

Response

Body

statusstring

errorError (object)

Codeinteger (int32)

Messagestring

listarray of AwsUtilizationPaymentModel (object)

utilizationnumber (double)

Utilization(%)

Example: 78.15

commitmentCostnumber (double)

Total commitment cost($)

Example: 3690.19

usedCommitmentCostnumber (double)

Used Savings Plans commitment cost($)

Example: 2880

netSavingsCostnumber (double)

Net savings cost On-Demand equivalent($)

Example: 810.19

netSavingsRatenumber (double)

Savings rate(%)

usedCommitmentCostOnDemandEquivalentnumber (double)

Used Savings Plans commitment cost On-Demand equivalent($)

usageDatestring

사용일

Example: "2020-07-01"

utilizationnumber (double)

Utilization(%)

Example: 78.15

commitmentCostnumber (double)

Total commitment cost($)

Example: 3690.19

usedCommitmentCostnumber (double)

Used Savings Plans commitment cost($)

Example: 2880

netSavingsCostnumber (double)

Net savings cost On-Demand equivalent($)

Example: 810.19

netSavingsRatenumber (double)

Savings rate(%)

usedCommitmentCostOnDemandEquivalentnumber (double)

Used Savings Plans commitment cost On-Demand equivalent($)

Request

Response

Get utilization summary of AWS commitment

Retrieve aggregated utilization summary for AWS commitment.

GEThttps://api.opsnow.io/cost/v3/commitment/companies/{companyId}/vendors/aws/services/all/utilizations/aggregated

Authorization

Path parameters

companyId*string

Company ID

Example: 1

Query parameters

dateTypeenum

Date query type

Example: "DAILY"

{DAILY, MONTHLY}

startDate*string

Start Date

Example: "2020-10-01"

endDate*string

End Date

Example: "2020-10-31"

accountsstring

Linked Account ID

Example: "['123456789011', '123456789012']"

productsstring

Service type

Example: "['EC2InstanceReserved', 'ComputeReserved']"

isExpiredstring

Whether the commitment is expired

Example: false

searchTypestring

Commitment search Type

Example: "All, My, AutoSavings"

Response

Body

statusstring

errorError (object)

Codeinteger (int32)

Messagestring

dataAwsUtilizationPaymentModel (object)

utilizationnumber (double)

Utilization(%)

Example: 78.15

commitmentCostnumber (double)

Total commitment cost($)

Example: 3690.19

usedCommitmentCostnumber (double)

Used Savings Plans commitment cost($)

Example: 2880

netSavingsCostnumber (double)

Net savings cost On-Demand equivalent($)

Example: 810.19

netSavingsRatenumber (double)

Savings rate(%)

usedCommitmentCostOnDemandEquivalentnumber (double)

Used Savings Plans commitment cost On-Demand equivalent($)

usageDatestring

사용일

Example: "2020-07-01"

utilizationnumber (double)

Utilization(%)

Example: 78.15

commitmentCostnumber (double)

Total commitment cost($)

Example: 3690.19

usedCommitmentCostnumber (double)

Used Savings Plans commitment cost($)

Example: 2880

netSavingsCostnumber (double)

Net savings cost On-Demand equivalent($)

Example: 810.19

netSavingsRatenumber (double)

Savings rate(%)

usedCommitmentCostOnDemandEquivalentnumber (double)

Used Savings Plans commitment cost On-Demand equivalent($)

Request

Response

Get utilization summary trends of user's AWS Reserved Instance

Retrieve time-series utilization summary for user's AWS Reserved Instance.

GEThttps://api.opsnow.io/cost/v3/commitment/companies/{companyId}/vendors/aws/services/reserved-instance/my-utilizations/time-series/{dateType}

Authorization

Path parameters

companyId*string

Company ID

Example: 1

dateType*string

Date query type

Example: "DAILY"

Query parameters

startDate*string

Start Date

Example: "2020-10-01"

endDate*string

End Date

Example: "2020-10-31"

accountsstring

Linked Account IDs

Example: "['123456789011', '123456789012']"

productsstring

Products

Example: "['EC2InstanceReserved', 'ComputeReserved']"

isExpiredstring

Whether the commitment is expired

searchTypestring

Commitment search type

Example: "All, My, AutoSavings"

Response

Body

statusstring

errorError (object)

Codeinteger (int32)

Messagestring

listarray of AwsUtilizationPaymentModel (object)

utilizationnumber (double)

Utilization(%)

Example: 78.15

commitmentCostnumber (double)

Total commitment cost($)

Example: 3690.19

usedCommitmentCostnumber (double)

Used Savings Plans commitment cost($)

Example: 2880

netSavingsCostnumber (double)

Net savings cost On-Demand equivalent($)

Example: 810.19

netSavingsRatenumber (double)

Savings rate(%)

usedCommitmentCostOnDemandEquivalentnumber (double)

Used Savings Plans commitment cost On-Demand equivalent($)

usageDatestring

사용일

Example: "2020-07-01"

utilizationnumber (double)

Utilization(%)

Example: 78.15

commitmentCostnumber (double)

Total commitment cost($)

Example: 3690.19

usedCommitmentCostnumber (double)

Used Savings Plans commitment cost($)

Example: 2880

netSavingsCostnumber (double)

Net savings cost On-Demand equivalent($)

Example: 810.19

netSavingsRatenumber (double)

Savings rate(%)

usedCommitmentCostOnDemandEquivalentnumber (double)

Used Savings Plans commitment cost On-Demand equivalent($)

Request

Response

Get category list of AWS Savings Plans utilization

Retrieve the categories of AWS Savings Plans utilization. The items within these categories can be used when categorizing the values of Savings Plans related to utilization.

GEThttps://api.opsnow.io/cost/v3/commitment/companies/{companyId}/vendors/aws/services/savings-plans/utilizations/categories

Authorization

Path parameters

companyId*string

Company ID

Example: 1

Query parameters

dateTypeenum

Date query type

Example: "DAILY"

{DAILY, MONTHLY}

startDate*string

Start Date

Example: "2020-10-01"

endDate*string

End Date

Example: "2020-10-31"

accountsstring

Linked Account ID

Example: "['123456789011', '123456789012']"

productsstring

Service type

Example: "['EC2InstanceReserved', 'ComputeReserved']"

isExpiredstring

Whether the commitment is expired

Example: false

searchTypestring

Commitment search Type

Example: "All, My, AutoSavings"

Response

Body

statusstring

errorError (object)

Codeinteger (int32)

Messagestring

dataAwsSavingsPlansFilterResultModel (object)

accountsarray of CommonCodeWithParentModel (object)

Linked Account ID

codestring

Code

Example: "ap-northeast-2"

namestring

Code name

Example: "Asia Pacific (Seoul)"

parentCodestring

Parent code(Code for group)

Example: "RGNCONVERT"

codesarray of string

Selected codes

Example: "['t3s','m5','c5']"

itemsstring

Selected codes

Example: "['t3s','m5','c5']"

sortinteger (int32)

정렬

productsarray of CommonCodeWithParentModel (object)

Service types(products)

codestring

Code

Example: "ap-northeast-2"

namestring

Code name

Example: "Asia Pacific (Seoul)"

parentCodestring

Parent code(Code for group)

Example: "RGNCONVERT"

codesarray of string

Selected codes

Example: "['t3s','m5','c5']"

itemsstring

Selected codes

Example: "['t3s','m5','c5']"

sortinteger (int32)

정렬

Request

Response

Get utilization summary trends of GCP CUD(Committed Use Discount)

Retrieve time-series utilization summary for GCP CUD(Committed Use Discount).

GEThttps://api.opsnow.io/cost/v3/commitment/companies/{companyId}/vendors/gcp/services/cud/utilizations/time-series/{dateType}

Authorization

Path parameters

companyId*string

Company ID

Example: 1

dateType*string

Date query type

Example: "DAILY"

Query parameters

startDate*string

Search start Date

Example: "2020-10-01"

endDate*string

Search end Date

Example: "2020-10-31"

projectsstring

Project IDs

Example: "['pjt-sample-1', 'pjt-sample-2']"

committedTypesstring

CUD types

Example: "['compute#commitment', 'cloudSql#commitment']"

regionsstring

Regions

Example: "['1', '2']"

machineTypesstring

Machine types

Example: "['GENERAL_PURPOSE_E2','GENERAL_PURPOSE']"

productsstring

Products

resourceTypesstring

Resource types

Response

Body

statusstring

errorError (object)

Codeinteger (int32)

Messagestring

listarray of GcpCommittedUseDiscountUtilizationPaymentModel (object)

utilizationnumber (double)

사용률(%)

commitmentCapacitynumber (double)

약정 사용량

usedCapacitynumber (double)

사용량

commitmentCostnumber (double)

총결재금액($)

usedCommitmentCostnumber (double)

사용 약정 금액

committedUseDiscountOnDemandCostEquivalentnumber (double)

CUD 온디맨드 환산 비용

netSavingsCostnumber (double)

절감 금액

netSavingsRatenumber (double)

절감률

usageDate*string

사용일

Example: "2020-07-01"

utilizationnumber (double)

사용률(%)

commitmentCapacitynumber (double)

약정 사용량

usedCapacitynumber (double)

사용량

commitmentCostnumber (double)

총결재금액($)

usedCommitmentCostnumber (double)

사용 약정 금액

committedUseDiscountOnDemandCostEquivalentnumber (double)

CUD 온디맨드 환산 비용

netSavingsCostnumber (double)

절감 금액

netSavingsRatenumber (double)

절감률

Request

Response

Get category list of AWS Reserved Instance utilization

Retrieve the categories of AWS Reserved Instance utilization. The items within these categories can be used when categorizing the values of Reserved Instance related to utilization.

GEThttps://api.opsnow.io/cost/v3/commitment/companies/{companyId}/vendors/aws/services/reserved-instance/utilizations/categories

Authorization

Path parameters

companyId*string

Company ID

Example: 1

Query parameters

dateTypeenum

Date query type

Example: "DAILY"

{DAILY, MONTHLY}

startDate*string

Start Date

Example: "2020-10-01"

endDate*string

End Date

Example: "2020-10-31"

accountsstring

Linked Account IDs

Example: "['123456789011', '123456789012']"

productsstring

Products

Example: "['EC2InstanceReserved', 'ComputeReserved']"

isExpiredstring

Whether the commitment is expired

searchTypestring

Commitment search type

Example: "All, My, AutoSavings"

Response

Body

statusstring

errorError (object)

Codeinteger (int32)

Messagestring

dataAwsReservedInstanceFilterResultModel (object)

data

accountsarray of CommonCodeWithParentModel (object)

Linked Account ID

codestring

Code

Example: "ap-northeast-2"

namestring

Code name

Example: "Asia Pacific (Seoul)"

parentCodestring

Parent code(Code for group)

Example: "RGNCONVERT"

codesarray of string

Selected codes

Example: "['t3s','m5','c5']"

itemsstring

Selected codes

Example: "['t3s','m5','c5']"

sortinteger (int32)

정렬

productsarray of CommonCodeWithParentModel (object)

서비스 유형(제품)

codestring

Code

Example: "ap-northeast-2"

namestring

Code name

Example: "Asia Pacific (Seoul)"

parentCodestring

Parent code(Code for group)

Example: "RGNCONVERT"

codesarray of string

Selected codes

Example: "['t3s','m5','c5']"

itemsstring

Selected codes

Example: "['t3s','m5','c5']"

sortinteger (int32)

정렬

Request

Response

Get coverage summary of GCP commitment

Retrieve aggregated coverage summary for GCP commitment.

GEThttps://api.opsnow.io/cost/v3/commitment/companies/{companyId}/vendors/gcp/services/cud/coverages/aggregated

Authorization

Path parameters

companyId*string

Company ID

Example: 1

Query parameters

dateTypeenum

Date query type

Example: "DAILY"

{DAILY, MONTHLY}

startDate*string

Search start Date

Example: "2020-10-01"

endDate*string

Search end Date

Example: "2020-10-31"

projectsstring

Project IDs

Example: "['pjt-sample-1', 'pjt-sample-2']"

committedTypesstring

CUD types

Example: "['compute#commitment', 'cloudSql#commitment']"

regionsstring

Regions

Example: "['1', '2']"

machineTypesstring

Machine types

Example: "['GENERAL_PURPOSE_E2','GENERAL_PURPOSE']"

productsstring

Products

resourceTypesstring

Resource types

Response

Body

statusstring

errorError (object)

Codeinteger (int32)

Messagestring

dataGcpCoverageValueModel (object)

committedUseDiscountCoverageRatenumber (double)

CUD(Committed Use Discount) coverage

totalCostnumber (double)

Total cost

totalOnDemandCostEquivalentnumber (double)

Total usage

totalCreditCostnumber (double)

Total credit cost

totalCommitmentCreditCostnumber (double)

Total commitment credit cost

committedUseDiscountOnDemandCostEquivalentnumber (double)

CUD(Committed Use Discount) applied credit cost

sustainedUseDiscountOnDemandCostEquivalentnumber (double)

SUD(Sustained Use Discount) applied credit cost

etcCreditOnDemandCostEquivalentnumber (double)

Other credit cost

onDemandCostnumber (double)

Cost except Committed Use Discount

Request

Response

Get purchase option information of GCP CUD recommendation

Retrieve the cost information based on GCP(Google Cloud Platform) CUD(Committed Use Discounts) purchase options and their corresponding purchase outcomes.

GEThttps://api.opsnow.io/cost/v3/commitment/companies/{companyId}/vendors/gcp/services/{service}/recommendations/purchase-options

Authorization

Path parameters

companyId*string

Company ID

Example: 1

service*string

Response

Body

statusstring

errorError (object)

Codeinteger (int32)

Messagestring

dataarray of GcpRecommenderOptionsModel (object)

Purchase option list

goalstring

Recommended Commitment Goal

Example: "LOW_WATERMARK"

planstring

Commitment Plan

Example: "TWELVE_MONTH"

termLengthstring

Commitment terms

Example: "1yr"

currencystring

Currency

Example: "USD"

expectedCostnumber (double)

Expected Reduction Cost

Example: -0.800516

recommendAmountnumber (double)

Recommended Resource Amount

Example: 1024

monthCommitmentnumber (double)

Monthly commitment cost

monthSaveCostnumber (double)

Monthly net savings cost

onDemandCostnumber (double)

Used On-Demand cost

Request

Response

Get utilization summary of GCP CUD(Committed Use Discount)

Retrieve aggregated utilization summary for GCP CUD(Committed Use Discount).

GEThttps://api.opsnow.io/cost/v3/commitment/companies/{companyId}/vendors/gcp/services/cud/utilizations/aggregated

Authorization

Path parameters

companyId*string

Company ID

Example: 1

Query parameters

dateTypeenum

Date query type

Example: "DAILY"

{DAILY, MONTHLY}

startDate*string

Search start Date

Example: "2020-10-01"

endDate*string

Search end Date

Example: "2020-10-31"

projectsstring

Project IDs

Example: "['pjt-sample-1', 'pjt-sample-2']"

committedTypesstring

CUD types

Example: "['compute#commitment', 'cloudSql#commitment']"

regionsstring

Regions

Example: "['1', '2']"

machineTypesstring

Machine types

Example: "['GENERAL_PURPOSE_E2','GENERAL_PURPOSE']"

productsstring

Products

resourceTypesstring

Resource types

Response

Body

statusstring

errorError (object)

Codeinteger (int32)

Messagestring

dataGcpCommittedUseDiscountUtilizationPaymentModel (object)

utilizationnumber (double)

사용률(%)

commitmentCapacitynumber (double)

약정 사용량

usedCapacitynumber (double)

사용량

commitmentCostnumber (double)

총결재금액($)

usedCommitmentCostnumber (double)

사용 약정 금액

committedUseDiscountOnDemandCostEquivalentnumber (double)

CUD 온디맨드 환산 비용

netSavingsCostnumber (double)

절감 금액

netSavingsRatenumber (double)

절감률

usageDate*string

사용일

Example: "2020-07-01"

utilizationnumber (double)

사용률(%)

commitmentCapacitynumber (double)

약정 사용량

usedCapacitynumber (double)

사용량

commitmentCostnumber (double)

총결재금액($)

usedCommitmentCostnumber (double)

사용 약정 금액

committedUseDiscountOnDemandCostEquivalentnumber (double)

CUD 온디맨드 환산 비용

netSavingsCostnumber (double)

절감 금액

netSavingsRatenumber (double)

절감률

Request

Response

Get coverage summary trends of GCP commitment

Retrieve time-series coverage summary for GCP commitment.

GEThttps://api.opsnow.io/cost/v3/commitment/companies/{companyId}/vendors/gcp/services/cud/coverages/time-series/{dateType}

Authorization

Path parameters

companyId*string

Company ID

Example: 1

dateType*string

Date query type

Example: "DAILY"

Query parameters

startDate*string

Search start Date

Example: "2020-10-01"

endDate*string

Search end Date

Example: "2020-10-31"

projectsstring

Project IDs

Example: "['pjt-sample-1', 'pjt-sample-2']"

committedTypesstring

CUD types

Example: "['compute#commitment', 'cloudSql#commitment']"

regionsstring

Regions

Example: "['1', '2']"

machineTypesstring

Machine types

Example: "['GENERAL_PURPOSE_E2','GENERAL_PURPOSE']"

productsstring

Products

resourceTypesstring

Resource types

Response

Body

statusstring

errorError (object)

Codeinteger (int32)

Messagestring

listarray of GcpCoverageTransitionModel (object)

committedUseDiscountCoverageRatenumber (double)

CUD(Committed Use Discount) coverage

totalCostnumber (double)

Total cost

totalOnDemandCostEquivalentnumber (double)

Total usage

totalCreditCostnumber (double)

Total credit cost

totalCommitmentCreditCostnumber (double)

Total commitment credit cost

committedUseDiscountOnDemandCostEquivalentnumber (double)

CUD(Committed Use Discount) applied credit cost

sustainedUseDiscountOnDemandCostEquivalentnumber (double)

SUD(Sustained Use Discount) applied credit cost

etcCreditOnDemandCostEquivalentnumber (double)

Other credit cost

onDemandCostnumber (double)

Cost except Committed Use Discount

usageDate*string

Usage date

Example: "2020-07-01"

Request

Response

Get category list of GCP CUD(Committed Use Discount) utilization

Retrieve the categories of GCP CUD(Committed Use Discount) utilization. The items within these categories can be used when categorizing the values of Reserved Instance related to utilization.

GEThttps://api.opsnow.io/cost/v3/commitment/companies/{companyId}/vendors/gcp/services/cud/utilizations/categories

Authorization

Path parameters

companyId*string

Company ID

Example: 1

Query parameters

dateTypeenum

Date query type

Example: "DAILY"

{DAILY, MONTHLY}

startDate*string

Search start Date

Example: "2020-10-01"

endDate*string

Search end Date

Example: "2020-10-31"

projectsstring

Project IDs

Example: "['pjt-sample-1', 'pjt-sample-2']"

committedTypesstring

CUD types

Example: "['compute#commitment', 'cloudSql#commitment']"

regionsstring

Regions

Example: "['1', '2']"

machineTypesstring

Machine types

Example: "['GENERAL_PURPOSE_E2','GENERAL_PURPOSE']"

productsstring

Products

resourceTypesstring

Resource types

Response

Body

statusstring

errorError (object)

Codeinteger (int32)

Messagestring

dataGcpCommittedUseDiscountFilterResultModel (object)

data

projectsarray of CommonCodeModel (object)

Projects

codestring

Code

Example: "ap-northeast-2"

namestring

Code name

Example: "Asia Pacific (Seoul)"

commitmentTypesarray of CommonCodeModel (object)

Commitment Types

codestring

Code

Example: "ap-northeast-2"

namestring

Code name

Example: "Asia Pacific (Seoul)"

regionsarray of CommonCodeModel (object)

Regions

codestring

Code

Example: "ap-northeast-2"

namestring

Code name

Example: "Asia Pacific (Seoul)"

machineTypesarray of CommonCodeModel (object)

Machine Types

codestring

Code

Example: "ap-northeast-2"

namestring

Code name

Example: "Asia Pacific (Seoul)"

resourceTypesarray of CommonCodeModel (object)

Resource Types

codestring

Code

Example: "ap-northeast-2"

namestring

Code name

Example: "Asia Pacific (Seoul)"

productsarray of CommonCodeModel (object)

Products

codestring

Code

Example: "ap-northeast-2"

namestring

Code name

Example: "Asia Pacific (Seoul)"

Request

Response

Get utilization data of AWS Savings Plans

Retrieve utilization data of each AWS Savings Plans.

GEThttps://api.opsnow.io/cost/v3/commitment/companies/{companyId}/vendors/aws/services/savings-plans/utilizations

Authorization

Path parameters

companyId*string

Company ID

Example: 1

Query parameters

dateTypeenum

Date query type

Example: "DAILY"

{DAILY, MONTHLY}

startDate*string

Start Date

Example: "2020-10-01"

endDate*string

End Date

Example: "2020-10-31"

accountsstring

Linked Account ID

Example: "['123456789011', '123456789012']"

productsstring

Service type

Example: "['EC2InstanceReserved', 'ComputeReserved']"

isExpiredstring

Whether the commitment is expired

Example: false

searchTypestring

Commitment search Type

Example: "All, My, AutoSavings"

Response

Body

statusstring

errorError (object)

Codeinteger (int32)

Messagestring

listarray of AwsSavingsPlansUtilizationModel (object)

utilizationnumber (double)

Utilization(%)

Example: 78.15

commitmentCostnumber (double)

Total commitment cost($)

Example: 3690.19

usedCommitmentCostnumber (double)

Used Savings Plans commitment cost($)

Example: 2880

netSavingsCostnumber (double)

Net savings cost On-Demand equivalent($)

Example: 810.19

netSavingsRatenumber (double)

Savings rate(%)

usedCommitmentCostOnDemandEquivalentnumber (double)

Used Savings Plans commitment cost On-Demand equivalent($)

savingsPlansIdstring

Savings plans ID

Example: "3118c6a8-7fc3-4b5d-8b53-a82fbe6f3169"

linkedAccountIdstring

Linked account ID

Example: "123456789012"

linkedAccountAliasstring

Linked account Name

Example: "Bespin"

productCodestring

서비스유형 코드

Example: "EC2InstanceSavingsPlans"

productNamestring

서비스유형 이름

Example: "EC2 Instance"

instanceFamilystring

인스턴스패밀리

Example: "c4"

regionCodestring

리전 코드

Example: "ap-northeast-2"

regionNamestring

리전 이름

Example: "Asia Pacific (Seoul)"

Request

Response

Get list of GCP CUD(Committed Use Discount) inventory

Retrieve Reserved Instance inventory(purchased list).

GEThttps://api.opsnow.io/cost/v3/commitment/companies/{companyId}/vendors/gcp/services/cud/inventory

Authorization

Path parameters

companyId*string

Company ID

Example: 1

Query parameters

dateTypeenum

Date query type

Example: "DAILY"

{DAILY, MONTHLY}

startDate*string

Search start Date

Example: "2020-10-01"

endDate*string

Search end Date

Example: "2020-10-31"

projectsstring

Project IDs

Example: "['pjt-sample-1', 'pjt-sample-2']"

committedTypesstring

CUD types

Example: "['compute#commitment', 'cloudSql#commitment']"

regionsstring

Regions

Example: "['1', '2']"

machineTypesstring

Machine types

Example: "['GENERAL_PURPOSE_E2','GENERAL_PURPOSE']"

productsstring

Products

resourceTypesstring

Resource types

Response

Body

statusstring

errorError (object)

Codeinteger (int32)

Messagestring

listarray of GcpCommittedUseDiscountInventoryModel (object)

projectIdstring

Project ID

Example: "sample-project"

projectNamestring

Project name

Example: "OpsNow Sample"

commitmentTypeNamestring

Commitment type name

Example: "Compute Engine"

machineTypestring

Machine Code

Example: "GENERAL_PURPOSE_E2"

machineTypeNamestring

Machine Name

Example: "General-purpose E2"

regionCodestring

Region code

Example: "ap-northeast-2"

regionNamestring

Region name

Example: "Asia Pacific (Seoul)"

remainingDaysinteger (int32)

Contract remaining days

Example: 365

startDatestring

Contract start date

Example: "2019-01-01 23:59:59"

endDatestring

Contract end date

Example: "2011-01-01 23:59:58"

planstring

Billing plan

statusstring

Commitment status

Example: "active"

cpuAmountnumber (double)

Daily CPU(Core) amount

memoryAmountnumber (double)

Daily memory amount(MByte)

storageAmountnumber (double)

Local storage amount

gpuAmountnumber (double)

GPU(Core) amount

Request

Response

Get coverage data of GCP commitment

Retrieve coverage data of each GCP commitment.

GEThttps://api.opsnow.io/cost/v3/commitment/companies/{companyId}/vendors/gcp/services/cud/coverages

Authorization

Path parameters

companyId*string

Company ID

Example: 1

Query parameters

dateTypeenum

Date query type

Example: "DAILY"

{DAILY, MONTHLY}

startDate*string

Search start Date

Example: "2020-10-01"

endDate*string

Search end Date

Example: "2020-10-31"

projectsstring

Project IDs

Example: "['pjt-sample-1', 'pjt-sample-2']"

committedTypesstring

CUD types

Example: "['compute#commitment', 'cloudSql#commitment']"

regionsstring

Regions

Example: "['1', '2']"

machineTypesstring

Machine types

Example: "['GENERAL_PURPOSE_E2','GENERAL_PURPOSE']"

productsstring

Products

resourceTypesstring

Resource types

Response

Body

statusstring

errorError (object)

Codeinteger (int32)

Messagestring

listarray of GcpCoverageModel (object)

committedUseDiscountCoverageRatenumber (double)

CUD(Committed Use Discount) coverage

totalCostnumber (double)

Total cost

totalOnDemandCostEquivalentnumber (double)

Total usage

totalCreditCostnumber (double)

Total credit cost

totalCommitmentCreditCostnumber (double)

Total commitment credit cost

committedUseDiscountOnDemandCostEquivalentnumber (double)

CUD(Committed Use Discount) applied credit cost

sustainedUseDiscountOnDemandCostEquivalentnumber (double)

SUD(Sustained Use Discount) applied credit cost

etcCreditOnDemandCostEquivalentnumber (double)

Other credit cost

onDemandCostnumber (double)

Cost except Committed Use Discount

projectIdstring

Project ID

projectNamestring

Project name

regionCodestring

Region code

Example: "us-central1"

regionNamestring

Region name

Example: "us-central1"

productCodestring

Product code

productNamestring

Product name

Example: "Compute Engine"

machineTypestring

Machine type

Example: "E2"

commitmentTypeNamestring

Commitment type name

resourceTypestring

Resource type

Example: "vCPU"

Request

Response

Get list of AWS Savings Plans inventory

Retrieve Savings Plans inventory(purchased list).

GEThttps://api.opsnow.io/cost/v3/commitment/companies/{companyId}/vendors/aws/services/savings-plans/inventory

Authorization

Path parameters

companyId*string

Company ID

Example: 1

Query parameters

dateTypeenum

Date query type

Example: "DAILY"

{DAILY, MONTHLY}

startDate*string

Start Date

Example: "2020-10-01"

endDate*string

End Date

Example: "2020-10-31"

accountsstring

Linked Account ID

Example: "['123456789011', '123456789012']"

productsstring

Service type

Example: "['EC2InstanceReserved', 'ComputeReserved']"

isExpiredstring

Whether the commitment is expired

Example: false

searchTypestring

Commitment search Type

Example: "All, My, AutoSavings"

Response

Body

statusstring

errorError (object)

Codeinteger (int32)

Messagestring

listarray of AwsSavingsPlansInventoryModel (object)

savingsPlansIdstring

Savings plans ID

Example: "3118c6a8-7fc3-4b5d-8b53-a82fbe6f3169"

linkedAccountIdstring

Linked account ID

Example: "123456789012"

linkedAccountAliasstring

Linked account Name

Example: "123456789012"

productCodestring

Product code

Example: "EC2InstanceSavingsPlans"

productNamestring

Product name

Example: "EC2 Instance"

instanceFamilystring

Instance family

Example: "c4"

regionCodestring

Region code

Example: "ap-northeast-2"

regionNamestring

Region name

Example: "Asia Pacific (Seoul)"

purchaseOptionstring

Payment option

Example: "All Upfront"

remainingDaysinteger (int32)

Remaining contract days

Example: 365

startDatestring

Contract start date

Example: "2019-01-01 23:59:59"

endDatestring

Contract end date

Example: "2011-01-01 23:59:58"

durationinteger (int32)

Contract unit(second)

Example: 31536000

useTypestring

operationNamestring

statusstring

Commitment status

Example: "active"

arnstring

Savings Plans ARN

Example: "arn:aws:savingsplans::123456789012:savingsplan/3118c6a8-7fc3-4b5d-8b53-a82fbe6f3169"

hourlyCommitmentCostnumber (double)

Commitment cost(hourly)

Example: 100

upfrontFeenumber (double)

Upfront fee

Example: 100

recurringFeenumber (double)

Recurring fee

Example: 100

Request

Response

Get utilization data of GCP CUD(Committed Use Discount)

Retrieve utilization data of each GCP CUD(Committed Use Discount).

GEThttps://api.opsnow.io/cost/v3/commitment/companies/{companyId}/vendors/gcp/services/cud/utilizations

Authorization

Path parameters

companyId*string

Company ID

Example: 1

Query parameters

dateTypeenum

Date query type

Example: "DAILY"

{DAILY, MONTHLY}

startDate*string

Search start Date

Example: "2020-10-01"

endDate*string

Search end Date

Example: "2020-10-31"

projectsstring

Project IDs

Example: "['pjt-sample-1', 'pjt-sample-2']"

committedTypesstring

CUD types

Example: "['compute#commitment', 'cloudSql#commitment']"

regionsstring

Regions

Example: "['1', '2']"

machineTypesstring

Machine types

Example: "['GENERAL_PURPOSE_E2','GENERAL_PURPOSE']"

productsstring

Products

resourceTypesstring

Resource types

Response

Body

statusstring

errorError (object)

Codeinteger (int32)

Messagestring

totalCount*integer (int32)

Item counts of the list

Example: 123

listarray of GcpCommittedUseDiscountUtilizationModel (object)

utilizationnumber (double)

사용률(%)

commitmentCapacitynumber (double)

약정 사용량

usedCapacitynumber (double)

사용량

commitmentCostnumber (double)

총결재금액($)

usedCommitmentCostnumber (double)

사용 약정 금액

committedUseDiscountOnDemandCostEquivalentnumber (double)

CUD 온디맨드 환산 비용

netSavingsCostnumber (double)

절감 금액

netSavingsRatenumber (double)

절감률

projectIdstring

Project ID

projectNamestring

Project Name

regionCodestring

리전 코드

Example: "us-central1"

regionNamestring

리전 이름

Example: "us-central1"

productCodestring

서비스 ID

productNamestring

서비스 이름(설명)

Example: "Compute Engine"

machineTypestring

머신 유형

Example: "E2"

commitmentTypeNamestring

약정 유형 이름

Example: "Compute Engine"

resourceTypestring

리소스

Example: "vCPU"

unitstring

사용량 단위

Example: "vCPU"

Request

Response

Get result list of Azure Reservations recommendation

Retrieve results of Azure Reservations recommendations

GEThttps://api.opsnow.io/cost/v3/commitment/companies/{companyId}/vendors/azure/services/{service}/recommendations

Authorization

Path parameters

companyId*string

Company ID

Example: 1

service*string

Query parameters

toKRWboolean

To convert amount data to Korean Won(₩)

lookbackPeriod*string

Azure Lookback Period

Example: 30

termstring

Commitment term

Example: "P1Y"

Response

Body

statusstring

errorError (object)

Codeinteger (int32)

Messagestring

dataarray of AzureRecommenderInventoryModel (object)

Azure Recommendation list

accountIdstring

Account ID

Example: "123456789012"

accountAliasstring

Name of account

Example: "Bespinglobal Platform"

productstring

Instance type

Example: "c4.xlarge"

startDatestring

Azure RI Analysis Start Date

Example: "2022-01-31"

endDatestring

Azure RI Analysis End Date

Example: "2022-03-01"

subscriptionIdstring

Azure Subscription ID

Example: "daf98eb5-6b7b-432d-a263-8d54aed4679d"

subscriptionAliasstring

Azure Subscription Alias

Example: "BespinGlobal - FinOps"

skustring

Azure Virtual Machine SKU Name

Example: "Standard_DS2_v2"

resourceTypestring

Azure Resource Type

Example: "Microsoft.Consumption/reservationRecommendations"

locationstring

Azure Resource Location

Example: "koreasouth"

instanceFlexibilityGroupstring

Azure Instance Flexibility Group

Example: "DSv2 Series"

instanceFlexibilityRatestring

Azure Instance Flexibility Group

Example: "2"

lookbackPeriodstring

Azure Lookback Period

Example: "Last30Days"

termLengthstring

Azure RI Commitment Term

Example: "P3Y"

commitmentCountstring

Azure RI Recommend Commitment Quantity

Example: "3"

monthSaveCostnumber (double)

Azure RI Expected Net Savings

Example: 3.8589864578035966

monthOnDemandCostnumber (double)

Total Cost Without Azure RI

Example: 8.759077781999997

reservationCostnumber (double)

Total Cost With Azure RI

Example: 4.9000913241964

originCurrencystring

Origin Currency

Example: "$"

Request

Response

Get utilization data of user's AWS Reserved Instance

Retrieve utilization data of user's each AWS Reserved Instance.

GEThttps://api.opsnow.io/cost/v3/commitment/companies/{companyId}/vendors/aws/services/reserved-instance/my-utilizations

Authorization

Path parameters

companyId*string

Company ID

Example: 1

Query parameters

dateTypeenum

Date query type

Example: "DAILY"

{DAILY, MONTHLY}

startDate*string

Start Date

Example: "2020-10-01"

endDate*string

End Date

Example: "2020-10-31"

accountsstring

Linked Account IDs

Example: "['123456789011', '123456789012']"

productsstring

Products

Example: "['EC2InstanceReserved', 'ComputeReserved']"

isExpiredstring

Whether the commitment is expired

searchTypestring

Commitment search type

Example: "All, My, AutoSavings"

Response

Body

statusstring

errorError (object)

Codeinteger (int32)

Messagestring

listarray of AwsReservedInstanceUtilizationModel (object)

utilizationnumber (double)

Utilization(%)

Example: 78.15

commitmentCostnumber (double)

Total commitment cost($)

Example: 3690.19

usedCommitmentCostnumber (double)

Used Savings Plans commitment cost($)

Example: 2880

netSavingsCostnumber (double)

Net savings cost On-Demand equivalent($)

Example: 810.19

netSavingsRatenumber (double)

Savings rate(%)

usedCommitmentCostOnDemandEquivalentnumber (double)

Used Savings Plans commitment cost On-Demand equivalent($)

reservedInstanceIdstring

Reserved ID

Example: "ri-2020-03-27-04-12-02-595"

reservedInstanceArnstring

Reserved ARN

Example: "arn:aws:rds:ap-northeast-2:216093335544:ri:ri-2020-03-27-04-12-02-595"

linkedAccountIdstring

Linked account ID

Example: "123456789012"

linkedAccountAliasstring

Linked account Name

Example: "Bespinglobal Platform"

productCodestring

서비스유형 코드

Example: "EC2InstanceSavingsPlans"

productNamestring

서비스유형 이름

Example: "EC2 Instance"

instanceTypestring

인스턴스 타입

Example: "c5.2xlarge"

instanceSizestring

인스턴스사이즈

Example: "c4.xlarge"

tenancystring

Tenancy

Example: "Shared"

regionCodestring

리전 코드

Example: "ap-northeast-2"

regionNamestring

리전 이름

Example: "Asia Pacific (Seoul)"

purchaseOptionstring

Payment option

Example: "All Upfront"

startDatestring

계약시작일

Example: "2019-01-01 23:59:59"

endDatestring

계약종료일

Example: "2011-01-01 23:59:58"

platformstring

Platform(OS)

Example: "Linux/UNIX"

operationNamestring

Operation Name

Example: "RunInstances"

riCountinteger (int32)

Reserved Count

Example: 5

Request

Response

Get result list of GCP CUD recommendation

Retrieve results of GCP(Google Cloud Platform) CUD(Committed Use Discounts) recommendations

GEThttps://api.opsnow.io/cost/v3/commitment/companies/{companyId}/vendors/gcp/services/{service}/recommendations

Authorization

Path parameters

companyId*string

Company ID

Example: 1

service*string

Response

Body

statusstring

errorError (object)

Codeinteger (int32)

Messagestring

dataarray of GcpRecommenderInventoryModel (object)

GCP Recommendation list

accountIdstring

Account ID

Example: "123456789012"

accountAliasstring

Name of account

Example: "Bespinglobal Platform"

productstring

Instance type

Example: "c4.xlarge"

projectIdstring

Project ID

Example: "opsnow-global-prd"

recommendationIdstring

Recommendation ID

Example: "0a2e6861-fd68-4e2e-8232-1e14e816deec"

recommendTypestring

Recommend Type

Example: "GENERAL_PURPOSE"

recommendAmountnumber (double)

Recommended Resource Amount

Example: 1024

recommendActionstring

Recommended Resource Amount

Example: "1024"

recommendStatusstring

Recommended Status

Example: "ACTIVE"

recommendDescriptionstring

Recommended Description

Example: "Purchase a 1 year RAM commitment for region us-central1"

resourceTypestring

Resource Type

Example: "MEMORY"

expectedCostnumber (double)

Expected Reduction Cost

Example: -0.800516

planstring

Commitment Plan

Example: "TWELVE_MONTH"

termLengthstring

Commitment terms

Example: "1yr"

goalstring

Recommended Commitment Goal

Example: "LOW_WATERMARK"

regionIdstring

Region ID

Example: "us-central1"

regionNamestring

Region name

Example: "Council Bluffs, Iowa"

regionCategorystring

Region category

Example: "North America"

insightIdstring

Insight ID

Example: "1377dfe4-f62d-4074-b52a-93a64a5a1b9d"

monthCommitmentnumber (double)

Monthly commitment cost

monthSaveCostnumber (double)

Monthly net savings cost

onDemandCostnumber (double)

Used On-Demand cost

Request

Response

Get utilization data of AWS commitment

Retrieve utilization data of each AWS commitment.

GEThttps://api.opsnow.io/cost/v3/commitment/companies/{companyId}/vendors/aws/services/all/utilizations

Authorization

Path parameters

companyId*string

Company ID

Example: 1

Query parameters

dateTypeenum

Date query type

Example: "DAILY"

{DAILY, MONTHLY}

startDate*string

Start Date

Example: "2020-10-01"

endDate*string

End Date

Example: "2020-10-31"

accountsstring

Linked Account ID

Example: "['123456789011', '123456789012']"

productsstring

Service type

Example: "['EC2InstanceReserved', 'ComputeReserved']"

isExpiredstring

Whether the commitment is expired

Example: false

searchTypestring

Commitment search Type

Example: "All, My, AutoSavings"

Response

Body

statusstring

errorError (object)

Codeinteger (int32)

Messagestring

listarray of AwsUtilizationModel (object)

utilizationnumber (double)

Utilization(%)

Example: 78.15

commitmentCostnumber (double)

Total commitment cost($)

Example: 3690.19

usedCommitmentCostnumber (double)

Used Savings Plans commitment cost($)

Example: 2880

netSavingsCostnumber (double)

Net savings cost On-Demand equivalent($)

Example: 810.19

netSavingsRatenumber (double)

Savings rate(%)

usedCommitmentCostOnDemandEquivalentnumber (double)

Used Savings Plans commitment cost On-Demand equivalent($)

commitmentIdstring

Commitment ID

Example: "ri-2020-03-27-04-12-02-595"

arnstring

ARN

Example: "arn:aws:rds:ap-northeast-2:216093335544:ri:ri-2020-03-27-04-12-02-595"

linkedAccountIdstring

Linked account ID

Example: "123456789012"

linkedAccountAliasstring

Linked account Name

Example: "Bespinglobal Platform"

productCodestring

Product code

Example: "EC2InstanceSavingsPlans"

productNamestring

Product name

Example: "EC2 Instance"

instanceTypestring

Instance type

Example: "c5.2xlarge"

instanceSizestring

Instance size

Example: "c4.xlarge"

tenancystring

Tenancy

Example: "Shared"

regionCodestring

Region code

Example: "ap-northeast-2"

regionNamestring

Region name

Example: "Asia Pacific (Seoul)"

purchaseOptionstring

Payment option

Example: "All Upfront"

startDatestring

Contract start date

Example: "2019-01-01 23:59:59"

endDatestring

Contract end date

Example: "2011-01-01 23:59:58"

platformstring

Platform(OS)

Example: "Linux/UNIX"

operationNamestring

Operation Name

Example: "RunInstances"

riCountinteger (int32)

Reserved Count

Example: 5

commitmentTypestring

Commitment type

Request

Response

Get list of AWS Reserved Instance inventory

Retrieve Reserved Instance inventory(purchased list).

GEThttps://api.opsnow.io/cost/v3/commitment/companies/{companyId}/vendors/aws/services/reserved-instance/inventory

Authorization

Path parameters

companyId*string

Company ID

Example: 1

Query parameters

dateTypeenum

Date query type

Example: "DAILY"

{DAILY, MONTHLY}

startDate*string

Start Date

Example: "2020-10-01"

endDate*string

End Date

Example: "2020-10-31"

accountsstring

Linked Account IDs

Example: "['123456789011', '123456789012']"

productsstring

Products

Example: "['EC2InstanceReserved', 'ComputeReserved']"

isExpiredstring

Whether the commitment is expired

searchTypestring

Commitment search type

Example: "All, My, AutoSavings"

Response

Body

statusstring

errorError (object)

Codeinteger (int32)

Messagestring

listarray of AwsReservedInstanceInventoryModel (object)

reservedInstanceIdstring

Reserved ID

Example: "3118c6a8-7fc3-4b5d-8b53-a82fbe6f3169"

linkedAccountIdstring

Linked account ID

Example: "123456789012"

linkedAccountAliasstring

Linked account Name

Example: "Bespinglobal Platform"

productCodestring

Product type code

Example: "AmazonEC2"

productNamestring

Product type name

Example: "EC2"

instanceTypestring

Instance type

Example: "c4.xlarge"

instanceSizestring

Instance size

Example: "xlarge"

regionCodestring

Region code

Example: "ap-northeast-2"

regionNamestring

Region name

Example: "Asia Pacific (Seoul)"

purchaseOptionstring

Payment option

Example: "All Upfront"

remainingDaysinteger (int32)

Contract remaining days

Example: 365

startDatestring

Contract start date

Example: "2019-01-01 23:59:59"

endDatestring

Contract end date

Example: "2011-01-01 23:59:58"

durationinteger (int32)

Contract unit(seconds)

Example: 31536000

platformstring

Platform(OS)

Example: "Linux/UNIX"

useTypestring

Usage Type

Example: "APN2-HeavyUsage:t3.micro"

operationNamestring

Operation Name

Example: "RunInstances"

tenancystring

Tenancy

Example: "Shared"

riCountinteger (int32)

Reserved Count

Example: 5

statusstring

Commitment status

Example: "active"

offerClassstring

Offer Class

Example: "standard"

arnstring

Reserved ARN

Example: "arn:aws:rds:ap-northeast-2:249145062117:ri:ri-2020-05-15-05-12-58-377"

upfrontFeenumber (double)

Upfront fee

Example: 777

recurringFeenumber (double)

Recurring fee

Example: 777

azstring

Availability Zone

Example: "777"

multiAzstring

Multi Availability Zone

Example: "777"

Request

Response

Get result list of AWS commitment recommendation

Retrieve results of AWS commitment recommendation

GEThttps://api.opsnow.io/cost/v3/commitment/companies/{companyId}/vendors/aws/services/{service}/recommendations

Authorization

Path parameters

companyId*string

Company ID

service*string

Query parameters

product*string

Recommendation target product

purchase*string

Service

term*string

Analysis terms

Example: 14

linkedAccountsstring

Linked accounts

purchaseOptionstring

Purchase option

leasContractLengthstring

Commitment terms

offerClassstring

Offer Class

analyzeTypeCodestring

Savings Plan analysis type code

Response

Body

statusstring

errorError (object)

Codeinteger (int32)

Messagestring

dataarray of AwsRecommenderInventoryModel (object)

AWS Recommendation list

accountIdstring

Account ID

Example: "123456789012"

accountAliasstring

Name of account

Example: "Bespinglobal Platform"

productstring

Instance type

Example: "c4.xlarge"

linkedAccountIdstring

Linked account ID

Example: "123456789012"

linkedAccountAliasstring

Linked account Name

Example: "Bespinglobal Platform"

startDatestring

Contract start date

Example: "2019-01-01 23:59:59"

endDatestring

Contract end date

Example: "2011-01-01 23:59:58"

operationCodestring

Platform(OS) code

osstring

Platform(OS) name

Example: "Linux/UNIX"

regionstring

Region code

Example: "ap-northeast-2"

instanceTypestring

Instance type

Example: "c4.xlarge"

familyTypestring

Instance family

Example: "c4"

savingsPlanTypestring

Savings Plan purchase type

analyzeTypeCodestring

Savings Plan analysis type code

analyzeTypeNamestring

Savings Plan analysis type name

paymentOptionsstring

Payment option(Upfront)

Example: "All Upfront"

termLengthstring

Commitment terms

Example: "1yr"

offerClassstring

Offer Class(RI, EC2)

Example: "standard"

flexibilitystring

Size Flexibility

Example: "Flexible"

azstring

Multi-AZ Option

Example: "Single-AZ"

commitmentnumber (double)

Hourly commitment cost

monthCommitmentnumber (double)

Monthly commitment cost

monthOnDemandCostnumber (double)

Monthly On-Demand cost

monthSaveCostnumber (double)

Monthly net savings cost

residualOnDemandCostnumber (double)

Residual On-Demand cost after purchasing recommendation

onDemandCostnumber (double)

Used On-Demand cost

onDemandCostOnlyEC2number (double)

Used On-Demand cost (Only for EC2)

reservedInstanceOnDemandCostnumber (double)

Reserved Instance cost On-Demand Equivalent

savingsPlansOnDemandCostnumber (double)

Savings Plan cost On-Demand Equivalent

savingsPlansOnDemandCostOnlyEC2number (double)

Savings Plan cost On-Demand Equivalent (Only for EC2)

coverageRatenumber (double)

Current coverage for this linked account ID before purchasing recommendation

expectancyCoverageRatenumber (double)

Expected coverage for this linked account ID after purchasing recommendation

Request

Response

Get purchase option information of AWS commitment recommendation

Retrieve the cost information based on AWS commitment purchase options and their corresponding purchase outcomes.

GEThttps://api.opsnow.io/cost/v3/commitment/companies/{companyId}/vendors/aws/services/{service}/recommendations/purchase-options

Authorization

Path parameters

companyId*string

Company ID

service*string

Query parameters

product*string

Recommendation target product

purchase*string

Service

term*string

Analysis terms

Example: 14

linkedAccountsstring

Linked accounts

purchaseOptionstring

Purchase option

leasContractLengthstring

Commitment terms

offerClassstring

Offer Class

analyzeTypeCodestring

Savings Plan analysis type code

Response

Body

statusstring

errorError (object)

Codeinteger (int32)

Messagestring

dataarray of AwsRecommenderOptionModel (object)

Purchase option list

paymentOptionsstring

Payment option(Upfront)

Example: "All Upfront"

termLengthstring

Commitment terms

Example: "1yr"

offerClassstring

Offer Class(RI, EC2)

Example: "standard"

analyzeTypeCodestring

Savings Plan analysis type code

analyzeTypeNamestring

Savings Plan analysis type name

residualOnDemandCostnumber (double)

Residual On-Demand cost after purchasing recommendation

onDemandCostBeforePurchasenumber (double)

On-Demand cost before purchasing recommendation

monthCommitmentnumber (double)

Monthly commitment cost

monthSaveCostnumber (double)

Monthly net savings cost

onDemandCostnumber (double)

Used On-Demand cost

onDemandCostOnlyEC2number (double)

Used On-Demand cost (Only for EC2)

reservedInstanceOnDemandCostnumber (double)

Reserved Instance cost On-Demand Equivalent

savingsPlansOnDemandCostnumber (double)

Savings Plan cost On-Demand Equivalent

savingsPlansOnDemandCostOnlyEC2number (double)

Savings Plan cost On-Demand Equivalent (Only for EC2)

coverageRatenumber (double)

Current coverage rate

expectancyCoverageRatenumber (double)

Expected coverage rate after purchasing recommendation

linkedAccountIdstring

Linked account id

accountsarray of AwsRecommenderOptionModel (object)

Purchase option data for each linked account

paymentOptionsstring

Payment option(Upfront)

Example: "All Upfront"

termLengthstring

Commitment terms

Example: "1yr"

offerClassstring

Offer Class(RI, EC2)

Example: "standard"

analyzeTypeCodestring

Savings Plan analysis type code

analyzeTypeNamestring

Savings Plan analysis type name

residualOnDemandCostnumber (double)

Residual On-Demand cost after purchasing recommendation

onDemandCostBeforePurchasenumber (double)

On-Demand cost before purchasing recommendation

monthCommitmentnumber (double)

Monthly commitment cost

monthSaveCostnumber (double)

Monthly net savings cost

onDemandCostnumber (double)

Used On-Demand cost

onDemandCostOnlyEC2number (double)

Used On-Demand cost (Only for EC2)

reservedInstanceOnDemandCostnumber (double)

Reserved Instance cost On-Demand Equivalent

savingsPlansOnDemandCostnumber (double)

Savings Plan cost On-Demand Equivalent

savingsPlansOnDemandCostOnlyEC2number (double)

Savings Plan cost On-Demand Equivalent (Only for EC2)

coverageRatenumber (double)

Current coverage rate

expectancyCoverageRatenumber (double)

Expected coverage rate after purchasing recommendation

linkedAccountIdstring

Linked account id

accountsarray of AwsRecommenderOptionModel (object)

Purchase option data for each linked account

Circular reference to array of AwsRecommenderOptionModel (object) ↩

Request

Response

listGcpProjects

Retrieves a list of GCP projects with the given company ID.

GEThttps://api.opsnow.io/platform/v2/companies/{companyId}/vendors/gcp/projects

Authorization

Path parameters

companyId*string

The ID of the organization, obtainable through 'listCompanies'.

Example: "f23a80d2-2077-4e0a-aa85-e7b08a379be7"

Response

Body

statusstring

The status attribute indicates the state of the request, with "success" meaning the request was processed successfully and "error" indicating an error occurred during processing.

Example: "success"

dataListGcpProjectsResponseModel (object)

listarray of ListGcpProjectWithCompanyEntity (object)

projectIdstring

A unique identifier for a Google Cloud Platform project, used to organize and manage GCP resources, services, and billing.

Example: "cloud-platform-1234"

projectAliasstring

A user-friendly name or alias for a GCP project, used for easier identification and management.

Example: "My Cloud Project"

projectTypestring

The type of the GCP project, indicating whether it's used for billing purposes or resource management.

Example: "BILLING"

companyNamestring

The name of the company(organization).

Example: "opsnow"

serviceAccountIdstring

A unique identifier used to identify a Google Cloud service account. It is used to distinguish the service account that interacts with Google Cloud resources and services.

Example: "106821279384347983826"

datasetIdstring

A unique identifier for a BigQuery dataset, which is a collection of tables and views in Google Cloud Platform.

Example: "my_dataset"

bigqueryTableNamestring

The name of a specific table within a BigQuery dataset, used to store and query large datasets.

Example: "users_table"

statusstring

The current status of the GCP project, indicating its operational state.

Example: "active"

Request

Response

deleteAzureSubscription

Deletes a specific Azure subscription linked to the specified tenant ID.

DELETEhttps://api.opsnow.io/platform/v2/companies/{companyId}/vendors/azure/tenants/{tenantId}/subscriptions/{subscriptionId}

Authorization

Path parameters

companyId*string

The ID of the organization, obtainable through 'listCompanies'.

Example: "f23a80d2-2077-4e0a-aa85-e7b08a379be7"

tenantId*string

A unique identifier used to identify an Azure Active Directory (AAD) tenant. It is used to distinguish the tenant to which all the organization's Azure resources and services belong.

Example: "6a05a771-d671-440a-9d64-087df0c16d6a"

subscriptionId*string

A unique identifier for an Azure subscription, used to manage and bill for a set of Azure resources and services.

Example: "c925a595-81d2-470c-a8cd-f7bd56fa8e95"

Response

Body

statusstring

The status attribute indicates the state of the request, with "success" meaning the request was processed successfully and "error" indicating an error occurred during processing.

Example: "success"

dataDeleteAzureSubscriptionResponseModel (object)

subscriptionIdstring

A unique identifier for an Azure subscription, used to manage and bill for a set of Azure resources and services.

Example: "c925a595-81d2-470c-a8cd-f7bd56fa8e95"

tenantIdstring

A unique identifier used to identify an Azure Active Directory (AAD) tenant. It is used to distinguish the tenant to which all the organization's Azure resources and services belong.

Example: "6a05a771-d671-440a-9d64-087df0c16d6a"

Request

Response

updateGcpProject

Updates the information of a specific GCP project with the given project ID.

PUThttps://api.opsnow.io/platform/v2/companies/{companyId}/vendors/gcp/projects/{projectId}

Authorization

Path parameters

companyId*string

The ID of the organization, obtainable through 'listCompanies'.

Example: "f23a80d2-2077-4e0a-aa85-e7b08a379be7"

projectId*string

A unique identifier for a Google Cloud Platform project, used to organize and manage GCP resources, services, and billing.

Example: "cloud-platform-1234"

Body

projectAliasstring

A user-friendly name or alias for a GCP project, used for easier identification and management.

Example: "My Cloud Project"

datasetIdstring

A unique identifier for a BigQuery dataset, which is a collection of tables and views in Google Cloud Platform.

Example: "my_dataset"

Response

Body

statusstring

The status attribute indicates the state of the request, with "success" meaning the request was processed successfully and "error" indicating an error occurred during processing.

Example: "success"

dataUpdateGcpProjectResponseModel (object)

projectIdstring

A unique identifier for a Google Cloud Platform project, used to organize and manage GCP resources, services, and billing.

Example: "cloud-platform-1234"

Request

Response

updateAzureTenant

Updates the information of a specific Azure tenant associated with the given company ID.

PUThttps://api.opsnow.io/platform/v2/companies/{companyId}/vendors/azure/tenants/{tenantId}

Authorization

Path parameters

companyId*string

The ID of the organization, obtainable through 'listCompanies'.

Example: "f23a80d2-2077-4e0a-aa85-e7b08a379be7"

tenantId*string

A unique identifier used to identify an Azure Active Directory (AAD) tenant. It is used to distinguish the tenant to which all the organization's Azure resources and services belong.

Example: "6a05a771-d671-440a-9d64-087df0c16d6a"

Body

tenantAlias*string

The alias name of the Azure tenant.

Example: "First Tenant"

Response

Body

statusstring

The status attribute indicates the state of the request, with "success" meaning the request was processed successfully and "error" indicating an error occurred during processing.

Example: "success"

dataUpdateAzureTenantResponseModel (object)

tenantIdstring

A unique identifier used to identify an Azure Active Directory (AAD) tenant. It is used to distinguish the tenant to which all the organization's Azure resources and services belong.

Example: "6a05a771-d671-440a-9d64-087df0c16d6a"

subscriptionIdstring

A unique identifier for an Azure subscription, used to manage and bill for a set of Azure resources and services.

Example: "c925a595-81d2-470c-a8cd-f7bd56fa8e95"

Request

Response

updateAzureSubscription

Updates the information of a specific Azure subscription associated with the given tenant ID.

PUThttps://api.opsnow.io/platform/v2/companies/{companyId}/vendors/azure/tenants/{tenantId}/subscriptions/{subscriptionId}

Authorization

Path parameters

companyId*string

The ID of the organization, obtainable through 'listCompanies'.

Example: "f23a80d2-2077-4e0a-aa85-e7b08a379be7"

tenantId*string

A unique identifier used to identify an Azure Active Directory (AAD) tenant. It is used to distinguish the tenant to which all the organization's Azure resources and services belong.

Example: "6a05a771-d671-440a-9d64-087df0c16d6a"

subscriptionId*string

A unique identifier for an Azure subscription, used to manage and bill for a set of Azure resources and services.

Example: "c925a595-81d2-470c-a8cd-f7bd56fa8e95"

Body

subscriptionAlias*string

The alias name of the Azure subscription.

Example: "First Subscription"

Response

Body

statusstring

The status attribute indicates the state of the request, with "success" meaning the request was processed successfully and "error" indicating an error occurred during processing.

Example: "success"

dataUpdateAzureSubscriptionResponseModel (object)

subscriptionIdstring

A unique identifier for an Azure subscription, used to manage and bill for a set of Azure resources and services.

Example: "c925a595-81d2-470c-a8cd-f7bd56fa8e95"

tenantIdstring

A unique identifier used to identify an Azure Active Directory (AAD) tenant. It is used to distinguish the tenant to which all the organization's Azure resources and services belong.

Example: "6a05a771-d671-440a-9d64-087df0c16d6a"

Request

Response

getAzureSubscription

Obtains the details of a specific Azure subscription linked to the given tenant ID.

GEThttps://api.opsnow.io/platform/v2/companies/{companyId}/vendors/azure/tenants/{tenantId}/subscriptions/{subscriptionId}

Authorization

Path parameters

companyId*string

The ID of the organization, obtainable through 'listCompanies'.

Example: "f23a80d2-2077-4e0a-aa85-e7b08a379be7"

tenantId*string

A unique identifier used to identify an Azure Active Directory (AAD) tenant. It is used to distinguish the tenant to which all the organization's Azure resources and services belong.

Example: "6a05a771-d671-440a-9d64-087df0c16d6a"

subscriptionId*string

A unique identifier for an Azure subscription, used to manage and bill for a set of Azure resources and services.

Example: "c925a595-81d2-470c-a8cd-f7bd56fa8e95"

Response

Body

statusstring

The status attribute indicates the state of the request, with "success" meaning the request was processed successfully and "error" indicating an error occurred during processing.

Example: "success"

dataGetAzureSubscriptionResponseModel (object)

tenantIdstring

A unique identifier used to identify an Azure Active Directory (AAD) tenant. It is used to distinguish the tenant to which all the organization's Azure resources and services belong.

Example: "6a05a771-d671-440a-9d64-087df0c16d6a"

subscriptionIdstring

A unique identifier for an Azure subscription, used to manage and bill for a set of Azure resources and services.

Example: "c925a595-81d2-470c-a8cd-f7bd56fa8e95"

subscriptionAliasstring

The alias name of the Azure subscription.

Example: "First Subscription"

statusenum

The current status of the Azure tenant(subscription).

Example: "healthy"

healthyin-progresserrorinactiveto-be-deletedready-to-startdisabledEnabled-

createdDatestring

The date and time when the Azure tenant was registered.

Example: "2023-07-10T14:48:00.000Z"

updatedDatestring

The date and time when the Azure tenant was last updated.

Example: "2023-07-10T14:48:00.000Z"

Request

Response

createAzureSubscription

Creates a new Azure subscription for the specified tenant ID.

POSThttps://api.opsnow.io/platform/v2/companies/{companyId}/vendors/azure/tenants/{tenantId}/subscriptions

Authorization

Path parameters

companyId*string

The ID of the organization, obtainable through 'listCompanies'.

Example: "f23a80d2-2077-4e0a-aa85-e7b08a379be7"

tenantId*string

A unique identifier used to identify an Azure Active Directory (AAD) tenant. It is used to distinguish the tenant to which all the organization's Azure resources and services belong.

Example: "6a05a771-d671-440a-9d64-087df0c16d6a"

Body

subscriptionId*string

A unique identifier for an Azure subscription, used to manage and bill for a set of Azure resources and services.

Example: "c925a595-81d2-470c-a8cd-f7bd56fa8e95"

subscriptionAlias*string

The alias name of the Azure subscription.

Example: "First Subscription"

Response

Body

statusstring

The status attribute indicates the state of the request, with "success" meaning the request was processed successfully and "error" indicating an error occurred during processing.

Example: "success"

dataCreateAzureSubscriptionResponseModel (object)

subscriptionIdstring

A unique identifier for an Azure subscription, used to manage and bill for a set of Azure resources and services.

Example: "c925a595-81d2-470c-a8cd-f7bd56fa8e95"

tenantIdstring

A unique identifier used to identify an Azure Active Directory (AAD) tenant. It is used to distinguish the tenant to which all the organization's Azure resources and services belong.

Example: "6a05a771-d671-440a-9d64-087df0c16d6a"

Request

Response

listAzureSubscriptions

Retrieves a list of Azure subscriptions associated with the specified tenant ID.

GEThttps://api.opsnow.io/platform/v2/companies/{companyId}/vendors/azure/tenants/{tenantId}/subscriptions

Authorization

Path parameters

companyId*string

The ID of the organization, obtainable through 'listCompanies'.

Example: "f23a80d2-2077-4e0a-aa85-e7b08a379be7"

tenantId*string

A unique identifier used to identify an Azure Active Directory (AAD) tenant. It is used to distinguish the tenant to which all the organization's Azure resources and services belong.

Example: "6a05a771-d671-440a-9d64-087df0c16d6a"

Response

Body

statusstring

The status attribute indicates the state of the request, with "success" meaning the request was processed successfully and "error" indicating an error occurred during processing.

Example: "success"

dataListAzureSubscriptionsResponseModel (object)

listarray of ListAzureSubscriptionsEntity (object)

companyIdstring

The unique identifier of the company(organization).

Example: "123e4567-e89b-12d3-a456-426614174000"

subscriptionIdstring

A unique identifier for an Azure subscription, used to manage and bill for a set of Azure resources and services.

Example: "c925a595-81d2-470c-a8cd-f7bd56fa8e95"

subscriptionAliasstring

The alias name of the Azure subscription.

Example: "First Subscription"

tenantIdstring

A unique identifier used to identify an Azure Active Directory (AAD) tenant. It is used to distinguish the tenant to which all the organization's Azure resources and services belong.

Example: "6a05a771-d671-440a-9d64-087df0c16d6a"

statusenum

The current status of the Azure tenant(subscription).

Example: "healthy"

healthyin-progresserrorinactiveto-be-deletedready-to-startdisabledEnabled-

Request

Response

createGcpProject

Creates a new gcp project for the specified company ID.

POSThttps://api.opsnow.io/platform/v2/companies/{companyId}/vendors/gcp/projects

Authorization

Path parameters

companyId*string

The ID of the organization, obtainable through 'listCompanies'.

Example: "f23a80d2-2077-4e0a-aa85-e7b08a379be7"

Body

serviceAccountId*string

A unique identifier used to identify a Google Cloud service account. It is used to distinguish the service account that interacts with Google Cloud resources and services.

Example: "106821279384347983826"

projectId*string

A unique identifier for a Google Cloud Platform project, used to organize and manage GCP resources, services, and billing.

Example: "cloud-platform-1234"

projectAlias*string

A user-friendly name or alias for a GCP project, used for easier identification and management.

Example: "My Cloud Project"

datasetIdstring

A unique identifier for a BigQuery dataset, which is a collection of tables and views in Google Cloud Platform.

Example: "my_dataset"

Response

Body

statusstring

The status attribute indicates the state of the request, with "success" meaning the request was processed successfully and "error" indicating an error occurred during processing.

Example: "success"

dataCreateGcpProjectResponseModel (object)

projectIdstring

A unique identifier for a Google Cloud Platform project, used to organize and manage GCP resources, services, and billing.

Example: "cloud-platform-1234"

Request

Response

listAzureRegistrableSubscriptions

List registrable Azure subscriptions for the specified tenant ID.

POSThttps://api.opsnow.io/platform/v2/companies/{companyId}/vendors/azure/tenants/registrable-subscriptions

Authorization

Path parameters

companyId*string

The ID of the organization, obtainable through 'listCompanies'.

Example: "f23a80d2-2077-4e0a-aa85-e7b08a379be7"

Body

tenantId*string

A unique identifier used to identify an Azure Active Directory (AAD) tenant. It is used to distinguish the tenant to which all the organization's Azure resources and services belong.

Example: "6a05a771-d671-440a-9d64-087df0c16d6a"

applicationId*string

Example: "993a65dd-691f-44f7-ba1d-21e7b4c60d38"

clientSecret*string

Example: "your-client-secret"

tenantType*string

Example: "PAY-AS-YOU-GO"

Pattern: PAY-AS-YOU-GO|EA|AZURE-PLAN|CSP

Response

Body

statusstring

The status attribute indicates the state of the request, with "success" meaning the request was processed successfully and "error" indicating an error occurred during processing.

Example: "success"

dataListAzureRegistrableSubscriptionsResponseModel (object)

listarray of ListAzureSubscriptionsEntity (object)

companyIdstring

The unique identifier of the company(organization).

Example: "123e4567-e89b-12d3-a456-426614174000"

subscriptionIdstring

A unique identifier for an Azure subscription, used to manage and bill for a set of Azure resources and services.

Example: "c925a595-81d2-470c-a8cd-f7bd56fa8e95"

subscriptionAliasstring

The alias name of the Azure subscription.

Example: "First Subscription"

tenantIdstring

A unique identifier used to identify an Azure Active Directory (AAD) tenant. It is used to distinguish the tenant to which all the organization's Azure resources and services belong.

Example: "6a05a771-d671-440a-9d64-087df0c16d6a"

statusenum

The current status of the Azure tenant(subscription).

Example: "healthy"

healthyin-progresserrorinactiveto-be-deletedready-to-startdisabledEnabled-

Request

Response

listGcpServiceAccounts

Retrieves a list of GCP service accounts with the given company ID.

GEThttps://api.opsnow.io/platform/v2/companies/{companyId}/vendors/gcp/service-accounts

Authorization

Path parameters

companyId*string

The ID of the organization, obtainable through 'listCompanies'.

Example: "f23a80d2-2077-4e0a-aa85-e7b08a379be7"

Response

Body

statusstring

The status attribute indicates the state of the request, with "success" meaning the request was processed successfully and "error" indicating an error occurred during processing.

Example: "success"

dataListGcpServiceAccountsResponseModel (object)

listarray of ListGcpServiceAccountEntity (object)

serviceAccountIdstring

A unique identifier used to identify a Google Cloud service account. It is used to distinguish the service account that interacts with Google Cloud resources and services.

Example: "106821279384347983826"

serviceAccountAliasstring

The alias name of the GCP service account.

Example: "my-service-account"

serviceAccountEmailstring

The email address associated with the GCP service account. This email is used to identify the service account and is in the format of [NAME]@[PROJECT_ID].iam.gserviceaccount.com.

Example: "my-service-account@my-project.iam.gserviceaccount.com"

statusenum

The current status of the GCP service account, indicating its operational state.

Example: "healthy"

healthyin-progresserrorinactiveto-be-deletedready-to-startdisabledEnabled-

createdDatestring

The date and time when the GCP project or resource was created.

Example: "2023-07-10T14:48:00.000Z"

updatedDatestring

The date and time when the GCP project or resource was last updated.

Example: "2023-07-10T14:48:00.000Z"

Request

Response

getAzureTenant

Obtains the details of a specific Azure tenant linked to the given company ID.

GEThttps://api.opsnow.io/platform/v2/companies/{companyId}/vendors/azure/tenants/{tenantId}

Authorization

Path parameters

companyId*string

The ID of the organization, obtainable through 'listCompanies'.

Example: "f23a80d2-2077-4e0a-aa85-e7b08a379be7"

tenantId*string

A unique identifier used to identify an Azure Active Directory (AAD) tenant. It is used to distinguish the tenant to which all the organization's Azure resources and services belong.

Example: "6a05a771-d671-440a-9d64-087df0c16d6a"

Response

Body

statusstring

The status attribute indicates the state of the request, with "success" meaning the request was processed successfully and "error" indicating an error occurred during processing.

Example: "success"

dataGetAzureTenantResponseModel (object)

tenantIdstring

A unique identifier used to identify an Azure Active Directory (AAD) tenant. It is used to distinguish the tenant to which all the organization's Azure resources and services belong.

Example: "6a05a771-d671-440a-9d64-087df0c16d6a"

tenantAliasstring

The alias name of the Azure tenant.

Example: "First Tenant"

tenantTypestring

Example: "PAY-AS-YOU-GO"

applicationIdstring

Example: "993a65dd-691f-44f7-ba1d-21e7b4c60d38"

enrollmentNumberstring

Example: "123456"

statusenum

The current status of the Azure tenant(subscription).

Example: "healthy"

healthyin-progresserrorinactiveto-be-deletedready-to-startdisabledEnabled-

createdDatestring

The date and time when the Azure tenant was registered.

Example: "2023-07-10T14:48:00.000Z"

updatedDatestring

The date and time when the Azure tenant was last updated.

Example: "2023-07-10T14:48:00.000Z"

Request

Response

listGcpServiceAccountProjects

Retrieves a list of GCP projects with the given Service Account ID.

GEThttps://api.opsnow.io/platform/v2/companies/{companyId}/vendors/gcp/service-accounts/{serviceAccountId}/projects

Authorization

Path parameters

companyId*string

The ID of the organization, obtainable through 'listCompanies'.

Example: "f23a80d2-2077-4e0a-aa85-e7b08a379be7"

serviceAccountId*string

A unique identifier used to identify a Google Cloud service account. It is used to distinguish the service account that interacts with Google Cloud resources and services.

Example: 106821279384347980000

Response

Body

statusstring

The status attribute indicates the state of the request, with "success" meaning the request was processed successfully and "error" indicating an error occurred during processing.

Example: "success"

dataListGcpProjectsResponseModel (object)

listarray of ListGcpProjectWithCompanyEntity (object)

projectIdstring

A unique identifier for a Google Cloud Platform project, used to organize and manage GCP resources, services, and billing.

Example: "cloud-platform-1234"

projectAliasstring

A user-friendly name or alias for a GCP project, used for easier identification and management.

Example: "My Cloud Project"

projectTypestring

The type of the GCP project, indicating whether it's used for billing purposes or resource management.

Example: "BILLING"

companyNamestring

The name of the company(organization).

Example: "opsnow"

serviceAccountIdstring

A unique identifier used to identify a Google Cloud service account. It is used to distinguish the service account that interacts with Google Cloud resources and services.

Example: "106821279384347983826"

datasetIdstring

A unique identifier for a BigQuery dataset, which is a collection of tables and views in Google Cloud Platform.

Example: "my_dataset"

bigqueryTableNamestring

The name of a specific table within a BigQuery dataset, used to store and query large datasets.

Example: "users_table"

statusstring

The current status of the GCP project, indicating its operational state.

Example: "active"

Request

Response

getGcpProject

Retrieves detailed information about a specific GCP project linked to the given company ID and project ID.

GEThttps://api.opsnow.io/platform/v2/companies/{companyId}/vendors/gcp/projects/{projectId}

Authorization

Path parameters

companyId*string

The ID of the organization, obtainable through 'listCompanies'.

Example: "f23a80d2-2077-4e0a-aa85-e7b08a379be7"

projectId*string

A unique identifier for a Google Cloud Platform project, used to organize and manage GCP resources, services, and billing.

Example: "cloud-platform-1234"

Response

Body

statusstring

The status attribute indicates the state of the request, with "success" meaning the request was processed successfully and "error" indicating an error occurred during processing.

Example: "success"

dataGetGcpProjectResponseModel (object)

projectIdstring

A unique identifier for a Google Cloud Platform project, used to organize and manage GCP resources, services, and billing.

Example: "cloud-platform-1234"

projectAliasstring

A user-friendly name or alias for a GCP project, used for easier identification and management.

Example: "My Cloud Project"

companyNamestring

The name of the company(organization).

Example: "opsnow"

serviceAccountIdstring

A unique identifier used to identify a Google Cloud service account. It is used to distinguish the service account that interacts with Google Cloud resources and services.

Example: "106821279384347983826"

projectTypestring

The type of the GCP project, indicating whether it's used for billing purposes or resource management.

Example: "BILLING"

datasetIdstring

A unique identifier for a BigQuery dataset, which is a collection of tables and views in Google Cloud Platform.

Example: "my_dataset"

bigQueryTableNamestring

The name of a specific table within a BigQuery dataset, used to store and query large datasets.

Example: "users_table"

statusstring

The current status of the GCP project, indicating its operational state.

Example: "active"

createdDatestring

The date and time when the GCP project or resource was created.

Example: "2023-07-10T14:48:00.000Z"

updatedDatestring

The date and time when the GCP project or resource was last updated.

Example: "2023-07-10T14:48:00.000Z"

Request

Response

listAzureTenants

Retrieves a list of Azure tenants associated with the specified company ID.

GEThttps://api.opsnow.io/platform/v2/companies/{companyId}/vendors/azure/tenants

Authorization

Path parameters

companyId*string

The ID of the organization, obtainable through 'listCompanies'.

Example: "f23a80d2-2077-4e0a-aa85-e7b08a379be7"

Response

Body

statusstring

The status attribute indicates the state of the request, with "success" meaning the request was processed successfully and "error" indicating an error occurred during processing.

Example: "success"

dataListAzureTenantsResponseModel (object)

listarray of ListAzureTenantsEntity (object)

tenantIdstring

A unique identifier used to identify an Azure Active Directory (AAD) tenant. It is used to distinguish the tenant to which all the organization's Azure resources and services belong.

Example: "6a05a771-d671-440a-9d64-087df0c16d6a"

applicationIdstring

Example: "993a65dd-691f-44f7-ba1d-21e7b4c60d38"

tenantAliasstring

The alias name of the Azure tenant.

Example: "First Tenant"

tenantTypestring

Example: "PAY-AS-YOU-GO"

statusenum

The current status of the Azure tenant(subscription).

Example: "healthy"

healthyin-progresserrorinactiveto-be-deletedready-to-startdisabledEnabled-

subscriptionCountinteger (int32)

Indicates the number of Azure subscriptions registered to the organization. This shows the total count of currently active Azure subscriptions for the organization.

Example: 5

createdDatestring (date-time)

The date and time when the Azure tenant was registered.

Example: "2023-07-10T14:48:00.000Z"

updatedDatestring (date-time)

The date and time when the Azure tenant was last updated.

Example: "2023-07-10T14:48:00.000Z"

Request

Response

createAzureTenant

Creates a new Azure tenant for the specified company ID.

POSThttps://api.opsnow.io/platform/v2/companies/{companyId}/vendors/azure/tenants

Authorization

Path parameters

companyId*string

The ID of the organization, obtainable through 'listCompanies'.

Example: "f23a80d2-2077-4e0a-aa85-e7b08a379be7"

Body

tenantId*string

A unique identifier used to identify an Azure Active Directory (AAD) tenant. It is used to distinguish the tenant to which all the organization's Azure resources and services belong.

Example: "6a05a771-d671-440a-9d64-087df0c16d6a"

tenantAlias*string

The alias name of the Azure tenant.

Example: "First Tenant"

applicationId*string

Example: "993a65dd-691f-44f7-ba1d-21e7b4c60d38"

clientSecret*string

Example: "your-client-secret"

tenantType*string

Example: "PAY-AS-YOU-GO"

Pattern: PAY-AS-YOU-GO|EA|AZURE-PLAN|CSP

enrollmentNumberstring

Example: "123456"

primaryKeystring

Example: "jwt-token-format"

Response

Body

statusstring

The status attribute indicates the state of the request, with "success" meaning the request was processed successfully and "error" indicating an error occurred during processing.

Example: "success"

dataCreateAzureTenantResponseModel (object)

tenantIdstring

A unique identifier used to identify an Azure Active Directory (AAD) tenant. It is used to distinguish the tenant to which all the organization's Azure resources and services belong.

Example: "6a05a771-d671-440a-9d64-087df0c16d6a"

Request

Response

listCompanyUsers

Retrieves a list of all users associated with a company.

GEThttps://api.opsnow.io/platform/v2/companies/{companyId}/users

Authorization

Path parameters

companyId*string

The ID of the organization, obtainable through 'listCompanies'.

Example: "f23a80d2-2077-4e0a-aa85-e7b08a379be7"

Response

Body

statusstring

The status attribute indicates the state of the request, with "success" meaning the request was processed successfully and "error" indicating an error occurred during processing.

Example: "success"

dataListCompanyUsersResponseModel (object)

listarray of ListCompanyUsersEntity (object)

userIdstring

The unique identifier of the user.

Example: "123e4567-e89b-12d3-a456-426614174000"

emailstring

The email address of the user.

Example: "user@example.com"

displayNamestring

The display name of the user.

Example: "John Doe"

masterCompanyIdstring

The unique identifier of the master company.

Example: "65dd4cbf-b412-4f83-8476-97a3f1e161b2"

userStatCdenum

The status code of the user.

Example: "ACTIVATED"

UNKNOWNPENDINGACTIVATEDDEACTIVATEDWILL_DORMANTDORMANTDESTROYEDWITHDRAWAL

userRoleenum

The role of the user.

Example: "ADMIN"

ADMINMEMBER

masterUserRoleenum

The role of the user in the master company.

Example: "OWNER"

OWNERMASTER_USER

enabledenum

Indicates if the user account is enabled.

Example: true

truefalse

createdDatestring (date-time)

The date and time when the user account was created.

Example: "2023-01-01T12:00:00.000Z"

Request

Response

listAwsAccounts

Retrieves a list of AWS accounts associated with the specified company ID.

GEThttps://api.opsnow.io/platform/v2/companies/{companyId}/vendors/aws/accounts

Authorization

Path parameters

companyId*string

The ID of the organization, obtainable through 'listCompanies'.

Example: "f23a80d2-2077-4e0a-aa85-e7b08a379be7"

Query parameters

isAddReadyToStartboolean

Specifies whether additional Member Accounts can be registered when isAddReadyToStart is set to true.

Example: true

accountTypestring

Example: "master"

Response

Body

statusstring

The status attribute indicates the state of the request, with "success" meaning the request was processed successfully and "error" indicating an error occurred during processing.

Example: "success"

dataListAwsAccountsResponseModel (object)

listarray of ListAwsAccountEntity (object)

accountIdstring

The unique identifier of the AWS account.

Example: "123456789012"

accountAliasstring

The alias of the AWS account, used for easy identification.

Example: "AWS 1st DEV Infra Account"

accountTypestring

Example: "master"

isCostAvailablestring

Indicates whether cost data is available for the AWS account.

Example: "true"

statusenum

The current status of the AWS account (in-progress, healthy, error, ready-to-start, -).

Example: "healthy"

healthyin-progresserrorinactiveto-be-deletedready-to-startdisabledEnabled-

contractStatusenum

The contract status of the AWS account, indicating its compliance or agreement state.

Example: "SUBSCRIBED"

SUBSCRIBEDTO_BE_CANCELEDPAYMENT_WAITNONE-

isSpPurchaseAccountboolean

A property that indicates whether the account is an SP purchase account. It returns true if the account is using AutoSP and is an AutoSP account. Example: true.

Example: true

errorDescriptionstring

A description of any errors associated with the AWS account, if applicable.

Example:

"Error occurred during stack creation. You can identify the cause of the error in AWS Console > CloudFormation > Events tab. Please take necessary actions and retry."

createdDatestring (date-time)

The date when the AWS account was created.

Example: "2024-05-20T07:06:47.253Z"

updatedDatestring (date-time)

The date when the AWS account information was last updated.

Example: "2024-05-20T07:06:47.253Z"

Request

Response

getAwsAccountSetup

Obtains the setup information for an AWS account linked to the given company ID.

GEThttps://api.opsnow.io/platform/v2/companies/{companyId}/vendors/aws/accounts/setup

Authorization

Path parameters

companyId*string

The ID of the organization, obtainable through 'listCompanies'.

Example: "f23a80d2-2077-4e0a-aa85-e7b08a379be7"

Query parameters

registrationTypestring

Used to determine how to register AWS accounts. If the value is 'single', it registers a single account. If the value is 'bulk', it provides information to register multiple accounts at once.

Example: "single"

excludeAccountsarray of string

Example: "123456789012, 234567890123"

itemsstring

Response

Body

statusstring

The status attribute indicates the state of the request, with "success" meaning the request was processed successfully and "error" indicating an error occurred during processing.

Example: "success"

dataGetAwsAccountSetupResponseModel (object)

stackCreateConsoleLinkstring

The console link for creating the AWS CloudFormation stack.

Example:

"https://console.aws.amazon.com/cloudformation/home?region=us-east-1#/stacks/create/review?templateURL=https://s3-data-dev-cloudformation.s3.ap-northeast-2.amazonaws.com/v1.2/opsnow-template-v1.2.yml&stackName=opsnow-stack-d442326f-878e-4500-8f82-d7c868f275bb&param_CostUsageReportBucketName=opsnow-cur-d442326f-878e-4500-8f82-d7c868f275bb&param_CrossAccountExternalID=ae06161e-8d5b-4c34-80c1-26f2cf00fff5&param_CrossLinkedAccountID=370166107047&param_Domain=opsnow360.io&param_Profile=us2&param_UserId=0f27a2-ae56-4a2f-8544-68ecb8674639&param_ResourceId=d442326f-878e-4500-8f82-d7c868f275bb"

stackCreateCliCommandstring

The CLI command for creating the AWS CloudFormation stack.

Example:

"aws cloudformation create-stack --stack-name opsnow-stack-d442326f-878e-4500-8f82-d7c868f275bb --region us-east-1 --template-url https://s3-data-dev-cloudformation.s3.ap-northeast-2.amazonaws.com/v1.2/opsnow-template-v1.2.yml --parameters ParameterKey=CrossAccountExternalID,ParameterValue=ae06161e-8d5b-4c34-80c1-26f2cf00fff5 ParameterKey=CrossLinkedAccountID,ParameterValue=370166107047 ParameterKey=CostUsageReportBucketName,ParameterValue=opsnow-cur-d442326f-878e-4500-8f82-d7c868f275bb ParameterKey=Domain,ParameterValue=opsnow360.io ParameterKey=Profile,ParameterValue=us2 ParameterKey=UserId,ParameterValue=0a0f27a2-ae56-4a2f-8544-68ecb8674639 ParameterKey=ResourceId,ParameterValue=d442326f-878e-4500-8f82-d7c868f275bb --capabilities CAPABILITY_NAMED_IAM"

stackDeleteCliCommandstring

The CLI command for deleting the AWS CloudFormation stack.

Example:

"aws cloudformation delete-stack-set --stack-name opsnow-stack-d442326f-878e-4500-8f82-d7c868f275bb --region us-east-1 \\\\ && \\\\aws cloudformation delete-stack --stack-name opsnow-stack-d442326f-878e-4500-8f82-d7c868f275bb --region us-east-1 "

stackNamestring

The name of the AWS CloudFormation stack associated with this account.

Example: "opsnow-stack-7bfe7be4-b423-4e92-b6ad-b685ce2fb2e2"

templateUrlstring

The URL of the AWS CloudFormation template.

Example: "3f50b07a-df54-4a7e-8db7-75a5406e970d"

crossAccountExternalIdstring

The external ID used for cross-account linking.

Example: "ae06161e-8d5b-4c34-80c1-26f2cf00fff5"

crossLinkedAccountIdstring

The ID of the linked cross-account.

Example: "123123123123"

costUsageReportBucketNamestring

The name of the S3 bucket where the cost usage report is stored.

Example: "opsnow-cur-d442326f-878e-4500-8f82-d7c868f275bb"

domainstring

Information about the domain.

Example: "opsnow.io"

profilestring

Profile information.

Example: "us2"

userIdstring

The user ID.

Example: "a6e1e5f8-924d-4a8f-9f78-61c0879c9243"

resourceIdstring

The resource ID.

Example: "3f50b07a-df54-4a7e-8db7-75a5406e970d"

organizationIdstring

The ID of the organization, obtainable through 'listCompanies'.

Example: "f23a80d2-2077-4e0a-aa85-e7b08a379be7"

Request

Response

getAwsAccount

Fetches detailed information for a specific AWS account using the provided company and account IDs.

GEThttps://api.opsnow.io/platform/v2/companies/{companyId}/vendors/aws/accounts/{accountId}

Authorization

Path parameters

companyId*string

The ID of the organization, obtainable through 'listCompanies'.

Example: "f23a80d2-2077-4e0a-aa85-e7b08a379be7"

accountId*string

The unique identifier of the AWS account.

Example: 123456789012

Response

Body

statusstring

The status attribute indicates the state of the request, with "success" meaning the request was processed successfully and "error" indicating an error occurred during processing.

Example: "success"

dataGetAwsAccountResponseModel (object)

accountIdstring

The unique identifier of the AWS account.

Example: "123456789012"

accountAliasstring

The alias of the AWS account, used for easy identification.

Example: "AWS 1st DEV Infra Account"

accountTypestring

Example: "master"

managementAccountIdstring

The identifier of the management account associated with this AWS account.

Example: "987654321987"

statusenum

The current status of the AWS account (in-progress, healthy, error, ready-to-start, -).

Example: "healthy"

healthyin-progresserrorinactiveto-be-deletedready-to-startdisabledEnabled-

roleArnstring

The Amazon Resource Name (ARN) of the role associated with this AWS account.

Example: "arn:aws:iam::123456789012:role/role-name"

stackNamestring

The name of the AWS CloudFormation stack associated with this account.

Example: "opsnow-stack-7bfe7be4-b423-4e92-b6ad-b685ce2fb2e2"

stackTemplateVersionstring

The version of the AWS CloudFormation template used by the stack.

Example: "1.0"

curBucketNamestring

The name of the current S3 bucket associated with this AWS account.

Example: "bucket-name"

curBucketRegionstring

The AWS region where the current S3 bucket is located.

Example: "us-east-1"

curBucketPrefixstring

The prefix used for objects stored in the current S3 bucket.

Example: "cur"

contractStatusenum

The AWS region where the current S3 bucket is located.

Example: "us-east-1"

SUBSCRIBEDTO_BE_CANCELEDPAYMENT_WAITNONE-

createdDatestring (date-time)

The date when the AWS account was created.

Example: "2024-05-20T07:06:47.253Z"

updatedDatestring (date-time)

The date when the AWS account information was last updated.

Example: "2024-05-20T07:06:47.253Z"

Request

Response

getGcpServiceAccount

Retrieves detailed information about a specific GCP service account and its associated project

GEThttps://api.opsnow.io/platform/v2/companies/{companyId}/vendors/gcp/service-accounts/{serviceAccountId}

Authorization

Path parameters

companyId*string

The ID of the organization, obtainable through 'listCompanies'.

Example: "f23a80d2-2077-4e0a-aa85-e7b08a379be7"

serviceAccountId*string

A unique identifier used to identify a Google Cloud service account. It is used to distinguish the service account that interacts with Google Cloud resources and services.

Example: 106821279384347980000

Response

Body

statusstring

The status attribute indicates the state of the request, with "success" meaning the request was processed successfully and "error" indicating an error occurred during processing.

Example: "success"

dataGetGcpServiceAccountResponseModel (object)

serviceAccountIdstring

A unique identifier used to identify a Google Cloud service account. It is used to distinguish the service account that interacts with Google Cloud resources and services.

Example: "106821279384347983826"

serviceAccountAliasstring

The alias name of the GCP service account.

Example: "my-service-account"

serviceAccountProjectIdstring

A unique identifier for a Google Cloud Platform project, used to organize and manage GCP resources, services, and billing.

Example: "cloud-platform-1234"

serviceAccountEmailstring

The email address associated with the GCP service account. This email is used to identify the service account and is in the format of [NAME]@[PROJECT_ID].iam.gserviceaccount.com.

Example: "my-service-account@my-project.iam.gserviceaccount.com"

createdDatestring

The date and time when the GCP project or resource was created.

Example: "2023-07-10T14:48:00.000Z"

updatedDatestring

The date and time when the GCP project or resource was last updated.

Example: "2023-07-10T14:48:00.000Z"

projectsarray of GetGcpProjectResponseModel (object)

projectIdstring

A unique identifier for a Google Cloud Platform project, used to organize and manage GCP resources, services, and billing.

Example: "cloud-platform-1234"

projectAliasstring

A user-friendly name or alias for a GCP project, used for easier identification and management.

Example: "My Cloud Project"

companyNamestring

The name of the company(organization).

Example: "opsnow"

serviceAccountIdstring

A unique identifier used to identify a Google Cloud service account. It is used to distinguish the service account that interacts with Google Cloud resources and services.

Example: "106821279384347983826"

projectTypestring

The type of the GCP project, indicating whether it's used for billing purposes or resource management.

Example: "BILLING"

datasetIdstring

A unique identifier for a BigQuery dataset, which is a collection of tables and views in Google Cloud Platform.

Example: "my_dataset"

bigQueryTableNamestring

The name of a specific table within a BigQuery dataset, used to store and query large datasets.

Example: "users_table"

statusstring

The current status of the GCP project, indicating its operational state.

Example: "active"

createdDatestring

The date and time when the GCP project or resource was created.

Example: "2023-07-10T14:48:00.000Z"

updatedDatestring

The date and time when the GCP project or resource was last updated.

Example: "2023-07-10T14:48:00.000Z"

Request

Response

{
  "status": "success",
  "data": {
    "stackCreateConsoleLink": "https://console.aws.amazon.com/cloudformation/home?region=us-east-1#/stacks/create/review?templateURL=https://s3-data-dev-cloudformation.s3.ap-northeast-2.amazonaws.com/v1.2/opsnow-template-v1.2.yml&stackName=opsnow-stack-d442326f-878e-4500-8f82-d7c868f275bb&param_CostUsageReportBucketName=opsnow-cur-d442326f-878e-4500-8f82-d7c868f275bb&param_CrossAccountExternalID=ae06161e-8d5b-4c34-80c1-26f2cf00fff5&param_CrossLinkedAccountID=370166107047&param_Domain=opsnow360.io&param_Profile=us2&param_UserId=0f27a2-ae56-4a2f-8544-68ecb8674639&param_ResourceId=d442326f-878e-4500-8f82-d7c868f275bb",
    "stackCreateCliCommand": "aws cloudformation create-stack --stack-name opsnow-stack-d442326f-878e-4500-8f82-d7c868f275bb --region us-east-1 --template-url https://s3-data-dev-cloudformation.s3.ap-northeast-2.amazonaws.com/v1.2/opsnow-template-v1.2.yml --parameters ParameterKey=CrossAccountExternalID,ParameterValue=ae06161e-8d5b-4c34-80c1-26f2cf00fff5 ParameterKey=CrossLinkedAccountID,ParameterValue=370166107047 ParameterKey=CostUsageReportBucketName,ParameterValue=opsnow-cur-d442326f-878e-4500-8f82-d7c868f275bb ParameterKey=Domain,ParameterValue=opsnow360.io ParameterKey=Profile,ParameterValue=us2 ParameterKey=UserId,ParameterValue=0a0f27a2-ae56-4a2f-8544-68ecb8674639 ParameterKey=ResourceId,ParameterValue=d442326f-878e-4500-8f82-d7c868f275bb --capabilities CAPABILITY_NAMED_IAM",
    "stackDeleteCliCommand": "aws cloudformation delete-stack-set --stack-name opsnow-stack-d442326f-878e-4500-8f82-d7c868f275bb --region us-east-1 \\\\ && \\\\aws cloudformation delete-stack --stack-name opsnow-stack-d442326f-878e-4500-8f82-d7c868f275bb --region us-east-1 ",
    "stackName": "opsnow-stack-7bfe7be4-b423-4e92-b6ad-b685ce2fb2e2",
    "templateUrl": "3f50b07a-df54-4a7e-8db7-75a5406e970d",
    "crossAccountExternalId": "ae06161e-8d5b-4c34-80c1-26f2cf00fff5",
    "crossLinkedAccountId": "123123123123",
    "costUsageReportBucketName": "opsnow-cur-d442326f-878e-4500-8f82-d7c868f275bb",
    "domain": "opsnow.io",
    "profile": "us2",
    "userId": "a6e1e5f8-924d-4a8f-9f78-61c0879c9243",
    "resourceId": "3f50b07a-df54-4a7e-8db7-75a5406e970d",
    "organizationId": "f23a80d2-2077-4e0a-aa85-e7b08a379be7"
  }
}