Commitment

AWS Recommendation APIs

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

Response

Body

statusstring

errorError (object)

dataarray of AwsRecommenderInventoryModel (object)

AWS Recommendation list

Request

const response = await fetch('https://api.opsnow.io/cost/v3/commitment/companies/{companyId}/vendors/aws/services/{service}/recommendations?product=text&purchase=text&term=14', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Response

{
  "status": "text",
  "error": {
    "Message": "text"
  },
  "data": [
    {
      "accountId": "123456789012",
      "accountAlias": "Bespinglobal Platform",
      "product": "c4.xlarge",
      "linkedAccountId": "123456789012",
      "linkedAccountAlias": "Bespinglobal Platform",
      "startDate": "2019-01-01 23:59:59",
      "endDate": "2011-01-01 23:59:58",
      "operationCode": "text",
      "os": "Linux/UNIX",
      "region": "ap-northeast-2",
      "instanceType": "c4.xlarge",
      "familyType": "c4",
      "savingsPlanType": "text",
      "analyzeTypeCode": "text",
      "analyzeTypeName": "text",
      "paymentOptions": "All Upfront",
      "termLength": "1yr",
      "commitment": 0,
      "offerClass": "standard",
      "flexibility": "Flexible",
      "az": "text",
      "purchasingStrategy": "text",
      "monthCommitment": 0,
      "monthOnDemandCost": 0,
      "monthSaveCost": 0,
      "residualOnDemandCost": 0
    }
  ]
}

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

Response

Body

statusstring

errorError (object)

dataarray of AwsRecommenderOptionModel (object)

Purchase option list

Request

const response = await fetch('https://api.opsnow.io/cost/v3/commitment/companies/{companyId}/vendors/aws/services/{service}/recommendations/purchase-options?product=text&purchase=text&term=14', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Response

{
  "status": "text",
  "error": {
    "Message": "text"
  },
  "data": [
    {
      "paymentOptions": "All Upfront",
      "termLength": "1yr",
      "offerClass": "standard",
      "analyzeTypeCode": "text",
      "analyzeTypeName": "text",
      "residualOnDemandCost": 0,
      "onDemandCostBeforePurchase": 0,
      "monthCommitment": 0,
      "monthSaveCost": 0,
      "onDemandCost": 0,
      "onDemandCostOnlyEC2": 0,
      "reservedInstanceOnDemandCost": 0,
      "savingsPlansOnDemandCost": 0,
      "savingsPlansOnDemandCostOnlyEC2": 0,
      "expectancyCoverageRate": 0,
      "coverageRate": 0,
      "linkedAccountId": "text",
      "accounts": []
    }
  ]
}

Get product type list of AWS commitment recommendation

Retrieve product types targeted by AWS commitment recommendation

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

Authorization

Path parameters

companyId*string

service*string

Response

Body

statusstring

errorError (object)

dataarray of CommonCodeWithParentModel (object)

AWS Recommendation product list

Request

const response = await fetch('https://api.opsnow.io/cost/v3/commitment/companies/{companyId}/vendors/aws/services/{service}/recommendations/products', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Response

{
  "status": "text",
  "error": {
    "Message": "text"
  },
  "data": [
    {
      "code": "ap-northeast-2",
      "name": "Asia Pacific (Seoul)",
      "parentCode": "RGNCONVERT",
      "codes": "['t3s','m5','c5']"
    }
  ]
}

AWS Reserved Instance Inventory APIs

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

Response

Body

statusstring

errorError (object)

listarray of AwsReservedInstanceInventoryModel (object)

Request

const response = await fetch('https://api.opsnow.io/cost/v3/commitment/companies/{companyId}/vendors/aws/services/reserved-instance/my-inventory?startDate=2020-10-01&endDate=2020-10-31', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Response

{
  "status": "text",
  "error": {
    "Message": "text"
  },
  "list": [
    {
      "reservedInstanceId": "3118c6a8-7fc3-4b5d-8b53-a82fbe6f3169",
      "linkedAccountId": "123456789012",
      "linkedAccountAlias": "Bespinglobal Platform",
      "productCode": "AmazonEC2",
      "productName": "EC2",
      "instanceType": "c4.xlarge",
      "instanceSize": "xlarge",
      "regionCode": "ap-northeast-2",
      "regionName": "Asia Pacific (Seoul)",
      "purchaseOption": "All Upfront",
      "remainingDays": 365,
      "startDate": "2019-01-01 23:59:59",
      "endDate": "2011-01-01 23:59:58",
      "duration": 31536000,
      "platform": "Linux/UNIX",
      "useType": "APN2-HeavyUsage:t3.micro",
      "operationName": "RunInstances",
      "tenancy": "Shared",
      "riCount": 5,
      "status": "active",
      "offerClass": "standard",
      "arn": "arn:aws:rds:ap-northeast-2:249145062117:ri:ri-2020-05-15-05-12-58-377",
      "upfrontFee": 777,
      "recurringFee": 777,
      "az": "777",
      "multiAz": "777"
    }
  ]
}

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

Response

Body

statusstring

errorError (object)

listarray of AwsReservedInstanceInventoryModel (object)

Request

const response = await fetch('https://api.opsnow.io/cost/v3/commitment/companies/{companyId}/vendors/aws/services/reserved-instance/inventory?startDate=2020-10-01&endDate=2020-10-31', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Response

{
  "status": "text",
  "error": {
    "Message": "text"
  },
  "list": [
    {
      "reservedInstanceId": "3118c6a8-7fc3-4b5d-8b53-a82fbe6f3169",
      "linkedAccountId": "123456789012",
      "linkedAccountAlias": "Bespinglobal Platform",
      "productCode": "AmazonEC2",
      "productName": "EC2",
      "instanceType": "c4.xlarge",
      "instanceSize": "xlarge",
      "regionCode": "ap-northeast-2",
      "regionName": "Asia Pacific (Seoul)",
      "purchaseOption": "All Upfront",
      "remainingDays": 365,
      "startDate": "2019-01-01 23:59:59",
      "endDate": "2011-01-01 23:59:58",
      "duration": 31536000,
      "platform": "Linux/UNIX",
      "useType": "APN2-HeavyUsage:t3.micro",
      "operationName": "RunInstances",
      "tenancy": "Shared",
      "riCount": 5,
      "status": "active",
      "offerClass": "standard",
      "arn": "arn:aws:rds:ap-northeast-2:249145062117:ri:ri-2020-05-15-05-12-58-377",
      "upfrontFee": 777,
      "recurringFee": 777,
      "az": "777",
      "multiAz": "777"
    }
  ]
}

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

Response

Body

statusstring

errorError (object)

dataAwsReservedInstanceFilterResultModel (object)

data

Request

const response = await fetch('https://api.opsnow.io/cost/v3/commitment/companies/{companyId}/vendors/aws/services/reserved-instance/inventory/categories?startDate=2020-10-01&endDate=2020-10-31', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Response

{
  "status": "text",
  "error": {
    "Message": "text"
  },
  "data": {
    "accounts": [
      {
        "code": "ap-northeast-2",
        "name": "Asia Pacific (Seoul)",
        "parentCode": "RGNCONVERT",
        "codes": "['t3s','m5','c5']"
      }
    ],
    "products": [
      {
        "code": "ap-northeast-2",
        "name": "Asia Pacific (Seoul)",
        "parentCode": "RGNCONVERT",
        "codes": "['t3s','m5','c5']"
      }
    ]
  }
}

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

Response

Body

statusstring

errorError (object)

listarray of AwsReservedInstanceInventoryModel (object)

Request

const response = await fetch('https://api.opsnow.io/cost/v3/commitment/companies/{companyId}/vendors/aws/services/reserved-instance/auto-savings-inventory?startDate=2020-10-01&endDate=2020-10-31', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Response

{
  "status": "text",
  "error": {
    "Message": "text"
  },
  "list": [
    {
      "reservedInstanceId": "3118c6a8-7fc3-4b5d-8b53-a82fbe6f3169",
      "linkedAccountId": "123456789012",
      "linkedAccountAlias": "Bespinglobal Platform",
      "productCode": "AmazonEC2",
      "productName": "EC2",
      "instanceType": "c4.xlarge",
      "instanceSize": "xlarge",
      "regionCode": "ap-northeast-2",
      "regionName": "Asia Pacific (Seoul)",
      "purchaseOption": "All Upfront",
      "remainingDays": 365,
      "startDate": "2019-01-01 23:59:59",
      "endDate": "2011-01-01 23:59:58",
      "duration": 31536000,
      "platform": "Linux/UNIX",
      "useType": "APN2-HeavyUsage:t3.micro",
      "operationName": "RunInstances",
      "tenancy": "Shared",
      "riCount": 5,
      "status": "active",
      "offerClass": "standard",
      "arn": "arn:aws:rds:ap-northeast-2:249145062117:ri:ri-2020-05-15-05-12-58-377",
      "upfrontFee": 777,
      "recurringFee": 777,
      "az": "777",
      "multiAz": "777"
    }
  ]
}

AWS Reserved Instance utilization APIs

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

Response

Body

statusstring

errorError (object)

listarray of AwsReservedInstanceUtilizationModel (object)

Request

const response = await fetch('https://api.opsnow.io/cost/v3/commitment/companies/{companyId}/vendors/aws/services/reserved-instance/utilizations?startDate=2020-10-01&endDate=2020-10-31', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Response

{
  "status": "text",
  "error": {
    "Message": "text"
  },
  "list": [
    {
      "utilization": 78.15,
      "commitmentCost": 3690.19,
      "usedCommitmentCost": 2880,
      "netSavingsCost": 810.19,
      "netSavingsRate": 0,
      "usedCommitmentCostOnDemandEquivalent": 0,
      "reservedInstanceId": "ri-2020-03-27-04-12-02-595",
      "reservedInstanceArn": "arn:aws:rds:ap-northeast-2:216093335544:ri:ri-2020-03-27-04-12-02-595",
      "linkedAccountId": "123456789012",
      "linkedAccountAlias": "Bespinglobal Platform",
      "productCode": "EC2InstanceSavingsPlans",
      "productName": "EC2 Instance",
      "instanceType": "c5.2xlarge",
      "instanceSize": "c4.xlarge",
      "tenancy": "Shared",
      "regionCode": "ap-northeast-2",
      "regionName": "Asia Pacific (Seoul)",
      "purchaseOption": "All Upfront",
      "startDate": "2019-01-01 23:59:59",
      "endDate": "2011-01-01 23:59:58",
      "platform": "Linux/UNIX",
      "operationName": "RunInstances",
      "riCount": 5
    }
  ]
}

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

Response

Body

statusstring

errorError (object)

listarray of AwsUtilizationPaymentModel (object)

Request

const response = await fetch('https://api.opsnow.io/cost/v3/commitment/companies/{companyId}/vendors/aws/services/reserved-instance/utilizations/time-series/{dateType}?startDate=2020-10-01&endDate=2020-10-31', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Response

{
  "status": "text",
  "error": {
    "Message": "text"
  },
  "list": [
    {
      "utilization": 78.15,
      "commitmentCost": 3690.19,
      "usedCommitmentCost": 2880,
      "netSavingsCost": 810.19,
      "netSavingsRate": 0,
      "usedCommitmentCostOnDemandEquivalent": 0,
      "usageDate": "2020-07-01"
    }
  ]
}

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

Response

Body

statusstring

errorError (object)

dataAwsReservedInstanceFilterResultModel (object)

data

Request

const response = await fetch('https://api.opsnow.io/cost/v3/commitment/companies/{companyId}/vendors/aws/services/reserved-instance/utilizations/categories?startDate=2020-10-01&endDate=2020-10-31', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Response

{
  "status": "text",
  "error": {
    "Message": "text"
  },
  "data": {
    "accounts": [
      {
        "code": "ap-northeast-2",
        "name": "Asia Pacific (Seoul)",
        "parentCode": "RGNCONVERT",
        "codes": "['t3s','m5','c5']"
      }
    ],
    "products": [
      {
        "code": "ap-northeast-2",
        "name": "Asia Pacific (Seoul)",
        "parentCode": "RGNCONVERT",
        "codes": "['t3s','m5','c5']"
      }
    ]
  }
}

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

Response

Body

statusstring

errorError (object)

dataAwsUtilizationPaymentModel (object)

Request

const response = await fetch('https://api.opsnow.io/cost/v3/commitment/companies/{companyId}/vendors/aws/services/reserved-instance/utilizations/aggregated?startDate=2020-10-01&endDate=2020-10-31', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Response

{
  "status": "text",
  "error": {
    "Message": "text"
  },
  "data": {
    "utilization": 78.15,
    "commitmentCost": 3690.19,
    "usedCommitmentCost": 2880,
    "netSavingsCost": 810.19,
    "netSavingsRate": 0,
    "usedCommitmentCostOnDemandEquivalent": 0,
    "usageDate": "2020-07-01"
  }
}

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

Response

Body

statusstring

errorError (object)

listarray of AwsReservedInstanceUtilizationModel (object)

Request

const response = await fetch('https://api.opsnow.io/cost/v3/commitment/companies/{companyId}/vendors/aws/services/reserved-instance/my-utilizations?startDate=2020-10-01&endDate=2020-10-31', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Response

{
  "status": "text",
  "error": {
    "Message": "text"
  },
  "list": [
    {
      "utilization": 78.15,
      "commitmentCost": 3690.19,
      "usedCommitmentCost": 2880,
      "netSavingsCost": 810.19,
      "netSavingsRate": 0,
      "usedCommitmentCostOnDemandEquivalent": 0,
      "reservedInstanceId": "ri-2020-03-27-04-12-02-595",
      "reservedInstanceArn": "arn:aws:rds:ap-northeast-2:216093335544:ri:ri-2020-03-27-04-12-02-595",
      "linkedAccountId": "123456789012",
      "linkedAccountAlias": "Bespinglobal Platform",
      "productCode": "EC2InstanceSavingsPlans",
      "productName": "EC2 Instance",
      "instanceType": "c5.2xlarge",
      "instanceSize": "c4.xlarge",
      "tenancy": "Shared",
      "regionCode": "ap-northeast-2",
      "regionName": "Asia Pacific (Seoul)",
      "purchaseOption": "All Upfront",
      "startDate": "2019-01-01 23:59:59",
      "endDate": "2011-01-01 23:59:58",
      "platform": "Linux/UNIX",
      "operationName": "RunInstances",
      "riCount": 5
    }
  ]
}

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

Response

Body

statusstring

errorError (object)

listarray of AwsUtilizationPaymentModel (object)

Request

const response = await fetch('https://api.opsnow.io/cost/v3/commitment/companies/{companyId}/vendors/aws/services/reserved-instance/my-utilizations/time-series/{dateType}?startDate=2020-10-01&endDate=2020-10-31', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Response

{
  "status": "text",
  "error": {
    "Message": "text"
  },
  "list": [
    {
      "utilization": 78.15,
      "commitmentCost": 3690.19,
      "usedCommitmentCost": 2880,
      "netSavingsCost": 810.19,
      "netSavingsRate": 0,
      "usedCommitmentCostOnDemandEquivalent": 0,
      "usageDate": "2020-07-01"
    }
  ]
}

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

Response

Body

statusstring

errorError (object)

dataAwsReservedInstanceFilterResultModel (object)

data

Request

const response = await fetch('https://api.opsnow.io/cost/v3/commitment/companies/{companyId}/vendors/aws/services/reserved-instance/my-utilizations/categories?startDate=2020-10-01&endDate=2020-10-31', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Response

{
  "status": "text",
  "error": {
    "Message": "text"
  },
  "data": {
    "accounts": [
      {
        "code": "ap-northeast-2",
        "name": "Asia Pacific (Seoul)",
        "parentCode": "RGNCONVERT",
        "codes": "['t3s','m5','c5']"
      }
    ],
    "products": [
      {
        "code": "ap-northeast-2",
        "name": "Asia Pacific (Seoul)",
        "parentCode": "RGNCONVERT",
        "codes": "['t3s','m5','c5']"
      }
    ]
  }
}

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

Response

Body

statusstring

errorError (object)

dataAwsUtilizationPaymentModel (object)

Request

const response = await fetch('https://api.opsnow.io/cost/v3/commitment/companies/{companyId}/vendors/aws/services/reserved-instance/my-utilizations/aggregated?startDate=2020-10-01&endDate=2020-10-31', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Response

{
  "status": "text",
  "error": {
    "Message": "text"
  },
  "data": {
    "utilization": 78.15,
    "commitmentCost": 3690.19,
    "usedCommitmentCost": 2880,
    "netSavingsCost": 810.19,
    "netSavingsRate": 0,
    "usedCommitmentCostOnDemandEquivalent": 0,
    "usageDate": "2020-07-01"
  }
}

AWS Savings Plans Inventory APIs

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

Response

Body

statusstring

errorError (object)

listarray of AwsSavingsPlansInventoryModel (object)

Request

const response = await fetch('https://api.opsnow.io/cost/v3/commitment/companies/{companyId}/vendors/aws/services/savings-plans/my-inventory?startDate=2020-10-01&endDate=2020-10-31', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Response

{
  "status": "text",
  "error": {
    "Message": "text"
  },
  "list": [
    {
      "savingsPlansId": "3118c6a8-7fc3-4b5d-8b53-a82fbe6f3169",
      "linkedAccountId": "123456789012",
      "linkedAccountAlias": "123456789012",
      "productCode": "EC2InstanceSavingsPlans",
      "productName": "EC2 Instance",
      "instanceFamily": "c4",
      "regionCode": "ap-northeast-2",
      "regionName": "Asia Pacific (Seoul)",
      "purchaseOption": "All Upfront",
      "remainingDays": 365,
      "startDate": "2019-01-01 23:59:59",
      "endDate": "2011-01-01 23:59:58",
      "duration": 31536000,
      "useType": "text",
      "operationName": "text",
      "status": "active",
      "arn": "arn:aws:savingsplans::123456789012:savingsplan/3118c6a8-7fc3-4b5d-8b53-a82fbe6f3169",
      "hourlyCommitmentCost": 100,
      "upfrontFee": 100,
      "recurringFee": 100
    }
  ]
}

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

Response

Body

statusstring

errorError (object)

listarray of AwsSavingsPlansInventoryModel (object)

Request

const response = await fetch('https://api.opsnow.io/cost/v3/commitment/companies/{companyId}/vendors/aws/services/savings-plans/inventory?startDate=2020-10-01&endDate=2020-10-31', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Response

{
  "status": "text",
  "error": {
    "Message": "text"
  },
  "list": [
    {
      "savingsPlansId": "3118c6a8-7fc3-4b5d-8b53-a82fbe6f3169",
      "linkedAccountId": "123456789012",
      "linkedAccountAlias": "123456789012",
      "productCode": "EC2InstanceSavingsPlans",
      "productName": "EC2 Instance",
      "instanceFamily": "c4",
      "regionCode": "ap-northeast-2",
      "regionName": "Asia Pacific (Seoul)",
      "purchaseOption": "All Upfront",
      "remainingDays": 365,
      "startDate": "2019-01-01 23:59:59",
      "endDate": "2011-01-01 23:59:58",
      "duration": 31536000,
      "useType": "text",
      "operationName": "text",
      "status": "active",
      "arn": "arn:aws:savingsplans::123456789012:savingsplan/3118c6a8-7fc3-4b5d-8b53-a82fbe6f3169",
      "hourlyCommitmentCost": 100,
      "upfrontFee": 100,
      "recurringFee": 100
    }
  ]
}

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

Response

Body

statusstring

errorError (object)

dataAwsSavingsPlansFilterResultModel (object)

Request

const response = await fetch('https://api.opsnow.io/cost/v3/commitment/companies/{companyId}/vendors/aws/services/savings-plans/inventory/categories?startDate=2020-10-01&endDate=2020-10-31', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Response

{
  "status": "text",
  "error": {
    "Message": "text"
  },
  "data": {
    "accounts": [
      {
        "code": "ap-northeast-2",
        "name": "Asia Pacific (Seoul)",
        "parentCode": "RGNCONVERT",
        "codes": "['t3s','m5','c5']"
      }
    ],
    "products": [
      {
        "code": "ap-northeast-2",
        "name": "Asia Pacific (Seoul)",
        "parentCode": "RGNCONVERT",
        "codes": "['t3s','m5','c5']"
      }
    ]
  }
}

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

Response

Body

statusstring

errorError (object)

listarray of AwsSavingsPlansInventoryModel (object)

Request

const response = await fetch('https://api.opsnow.io/cost/v3/commitment/companies/{companyId}/vendors/aws/services/savings-plans/auto-savings-inventory?startDate=2020-10-01&endDate=2020-10-31', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Response

{
  "status": "text",
  "error": {
    "Message": "text"
  },
  "list": [
    {
      "savingsPlansId": "3118c6a8-7fc3-4b5d-8b53-a82fbe6f3169",
      "linkedAccountId": "123456789012",
      "linkedAccountAlias": "123456789012",
      "productCode": "EC2InstanceSavingsPlans",
      "productName": "EC2 Instance",
      "instanceFamily": "c4",
      "regionCode": "ap-northeast-2",
      "regionName": "Asia Pacific (Seoul)",
      "purchaseOption": "All Upfront",
      "remainingDays": 365,
      "startDate": "2019-01-01 23:59:59",
      "endDate": "2011-01-01 23:59:58",
      "duration": 31536000,
      "useType": "text",
      "operationName": "text",
      "status": "active",
      "arn": "arn:aws:savingsplans::123456789012:savingsplan/3118c6a8-7fc3-4b5d-8b53-a82fbe6f3169",
      "hourlyCommitmentCost": 100,
      "upfrontFee": 100,
      "recurringFee": 100
    }
  ]
}

AWS Savings Plans utilization APIs

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

Response

Body

statusstring

errorError (object)

listarray of AwsSavingsPlansUtilizationModel (object)

Request

const response = await fetch('https://api.opsnow.io/cost/v3/commitment/companies/{companyId}/vendors/aws/services/savings-plans/utilizations?startDate=2020-10-01&endDate=2020-10-31', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Response

{
  "status": "text",
  "error": {
    "Message": "text"
  },
  "list": [
    {
      "utilization": 78.15,
      "commitmentCost": 3690.19,
      "usedCommitmentCost": 2880,
      "netSavingsCost": 810.19,
      "netSavingsRate": 0,
      "usedCommitmentCostOnDemandEquivalent": 0,
      "savingsPlansId": "3118c6a8-7fc3-4b5d-8b53-a82fbe6f3169",
      "linkedAccountId": "123456789012",
      "linkedAccountAlias": "Bespin",
      "productCode": "EC2InstanceSavingsPlans",
      "productName": "EC2 Instance",
      "instanceFamily": "c4",
      "regionCode": "ap-northeast-2",
      "regionName": "Asia Pacific (Seoul)"
    }
  ]
}

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

Response

Body

statusstring

errorError (object)

listarray of AwsUtilizationPaymentModel (object)

Request

const response = await fetch('https://api.opsnow.io/cost/v3/commitment/companies/{companyId}/vendors/aws/services/savings-plans/utilizations/time-series/{dateType}?startDate=2020-10-01&endDate=2020-10-31', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Response

{
  "status": "text",
  "error": {
    "Message": "text"
  },
  "list": [
    {
      "utilization": 78.15,
      "commitmentCost": 3690.19,
      "usedCommitmentCost": 2880,
      "netSavingsCost": 810.19,
      "netSavingsRate": 0,
      "usedCommitmentCostOnDemandEquivalent": 0,
      "usageDate": "2020-07-01"
    }
  ]
}

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

Response

Body

statusstring

errorError (object)

dataAwsSavingsPlansFilterResultModel (object)

Request

const response = await fetch('https://api.opsnow.io/cost/v3/commitment/companies/{companyId}/vendors/aws/services/savings-plans/utilizations/categories?startDate=2020-10-01&endDate=2020-10-31', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Response

{
  "status": "text",
  "error": {
    "Message": "text"
  },
  "data": {
    "accounts": [
      {
        "code": "ap-northeast-2",
        "name": "Asia Pacific (Seoul)",
        "parentCode": "RGNCONVERT",
        "codes": "['t3s','m5','c5']"
      }
    ],
    "products": [
      {
        "code": "ap-northeast-2",
        "name": "Asia Pacific (Seoul)",
        "parentCode": "RGNCONVERT",
        "codes": "['t3s','m5','c5']"
      }
    ]
  }
}

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

Response

Body

statusstring

errorError (object)

dataAwsUtilizationPaymentModel (object)

Request

const response = await fetch('https://api.opsnow.io/cost/v3/commitment/companies/{companyId}/vendors/aws/services/savings-plans/utilizations/aggregated?startDate=2020-10-01&endDate=2020-10-31', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Response

{
  "status": "text",
  "error": {
    "Message": "text"
  },
  "data": {
    "utilization": 78.15,
    "commitmentCost": 3690.19,
    "usedCommitmentCost": 2880,
    "netSavingsCost": 810.19,
    "netSavingsRate": 0,
    "usedCommitmentCostOnDemandEquivalent": 0,
    "usageDate": "2020-07-01"
  }
}

AWS commitment utilization APIs

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

Response

Body

statusstring

errorError (object)

listarray of AwsUtilizationModel (object)

Request

const response = await fetch('https://api.opsnow.io/cost/v3/commitment/companies/{companyId}/vendors/aws/services/all/utilizations?startDate=2020-10-01&endDate=2020-10-31', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Response

{
  "status": "text",
  "error": {
    "Message": "text"
  },
  "list": [
    {
      "utilization": 78.15,
      "commitmentCost": 3690.19,
      "usedCommitmentCost": 2880,
      "netSavingsCost": 810.19,
      "netSavingsRate": 0,
      "usedCommitmentCostOnDemandEquivalent": 0,
      "commitmentId": "ri-2020-03-27-04-12-02-595",
      "arn": "arn:aws:rds:ap-northeast-2:216093335544:ri:ri-2020-03-27-04-12-02-595",
      "linkedAccountId": "123456789012",
      "linkedAccountAlias": "Bespinglobal Platform",
      "productCode": "EC2InstanceSavingsPlans",
      "productName": "EC2 Instance",
      "instanceType": "c5.2xlarge",
      "instanceSize": "c4.xlarge",
      "tenancy": "Shared",
      "regionCode": "ap-northeast-2",
      "regionName": "Asia Pacific (Seoul)",
      "purchaseOption": "All Upfront",
      "startDate": "2019-01-01 23:59:59",
      "endDate": "2011-01-01 23:59:58",
      "platform": "Linux/UNIX",
      "operationName": "RunInstances",
      "riCount": 5,
      "commitmentType": "text"
    }
  ]
}

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

Response

Body

statusstring

errorError (object)

listarray of AwsUtilizationPaymentModel (object)

Request

const response = await fetch('https://api.opsnow.io/cost/v3/commitment/companies/{companyId}/vendors/aws/services/all/utilizations/time-series/{dateType}?startDate=2020-10-01&endDate=2020-10-31', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Response

{
  "status": "text",
  "error": {
    "Message": "text"
  },
  "list": [
    {
      "utilization": 78.15,
      "commitmentCost": 3690.19,
      "usedCommitmentCost": 2880,
      "netSavingsCost": 810.19,
      "netSavingsRate": 0,
      "usedCommitmentCostOnDemandEquivalent": 0,
      "usageDate": "2020-07-01"
    }
  ]
}

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

Response

Body

statusstring

errorError (object)

dataAwsSavingsPlansFilterResultModel (object)

Request

const response = await fetch('https://api.opsnow.io/cost/v3/commitment/companies/{companyId}/vendors/aws/services/all/utilizations/categories?startDate=2020-10-01&endDate=2020-10-31', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Response

{
  "status": "text",
  "error": {
    "Message": "text"
  },
  "data": {
    "accounts": [
      {
        "code": "ap-northeast-2",
        "name": "Asia Pacific (Seoul)",
        "parentCode": "RGNCONVERT",
        "codes": "['t3s','m5','c5']"
      }
    ],
    "products": [
      {
        "code": "ap-northeast-2",
        "name": "Asia Pacific (Seoul)",
        "parentCode": "RGNCONVERT",
        "codes": "['t3s','m5','c5']"
      }
    ]
  }
}

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

Response

Body

statusstring

errorError (object)

dataAwsUtilizationPaymentModel (object)

Request

const response = await fetch('https://api.opsnow.io/cost/v3/commitment/companies/{companyId}/vendors/aws/services/all/utilizations/aggregated?startDate=2020-10-01&endDate=2020-10-31', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Response

{
  "status": "text",
  "error": {
    "Message": "text"
  },
  "data": {
    "utilization": 78.15,
    "commitmentCost": 3690.19,
    "usedCommitmentCost": 2880,
    "netSavingsCost": 810.19,
    "netSavingsRate": 0,
    "usedCommitmentCostOnDemandEquivalent": 0,
    "usageDate": "2020-07-01"
  }
}

Azure Recommendation APIs

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

Response

Body

statusstring

errorError (object)

dataarray of AzureRecommenderInventoryModel (object)

Azure Recommendation list

Request

const response = await fetch('https://api.opsnow.io/cost/v3/commitment/companies/{companyId}/vendors/azure/services/{service}/recommendations?lookbackPeriod=30', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Response

{
  "status": "text",
  "error": {
    "Message": "text"
  },
  "data": [
    {
      "accountId": "123456789012",
      "accountAlias": "Bespinglobal Platform",
      "product": "c4.xlarge",
      "startDate": "2022-01-31",
      "endDate": "2022-03-01",
      "subscriptionId": "daf98eb5-6b7b-432d-a263-8d54aed4679d",
      "subscriptionAlias": "BespinGlobal - FinOps",
      "sku": "Standard_DS2_v2",
      "resourceType": "Microsoft.Consumption/reservationRecommendations",
      "location": "koreasouth",
      "instanceFlexibilityGroup": "DSv2 Series",
      "instanceFlexibilityRate": "2",
      "lookbackPeriod": "Last30Days",
      "termLength": "P3Y",
      "commitmentCount": "3",
      "monthSaveCost": 3.8589864578035966,
      "monthOnDemandCost": 8.759077781999997,
      "reservationCost": 4.9000913241964,
      "originCurrency": "$"
    }
  ]
}

Get product type list of Azure Reservations recommendation

Retrieve product types targeted by Azure Reservations recommendation

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

Authorization

Path parameters

companyId*string

service*string

Response

Body

statusstring

errorError (object)

dataarray of CommonCodeWithParentModel (object)

Azure Recommendation product list

Request

const response = await fetch('https://api.opsnow.io/cost/v3/commitment/companies/{companyId}/vendors/azure/services/{service}/recommendations/products', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Response

{
  "status": "text",
  "error": {
    "Message": "text"
  },
  "data": [
    {
      "code": "ap-northeast-2",
      "name": "Asia Pacific (Seoul)",
      "parentCode": "RGNCONVERT",
      "codes": "['t3s','m5','c5']"
    }
  ]
}

GCP CUD(Committed Use Discount) Inventory APIs

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

Response

Body

statusstring

errorError (object)

listarray of GcpCommittedUseDiscountInventoryModel (object)

Request

const response = await fetch('https://api.opsnow.io/cost/v3/commitment/companies/{companyId}/vendors/gcp/services/cud/inventory?startDate=2020-10-01&endDate=2020-10-31', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Response

{
  "status": "text",
  "error": {
    "Message": "text"
  },
  "list": [
    {
      "projectId": "sample-project",
      "projectName": "OpsNow Sample",
      "commitmentTypeName": "Compute Engine",
      "machineType": "GENERAL_PURPOSE_E2",
      "machineTypeName": "General-purpose E2",
      "regionCode": "ap-northeast-2",
      "regionName": "Asia Pacific (Seoul)",
      "remainingDays": 365,
      "startDate": "2019-01-01 23:59:59",
      "endDate": "2011-01-01 23:59:58",
      "plan": "text",
      "status": "active",
      "cpuAmount": 0,
      "memoryAmount": 0,
      "storageAmount": 0,
      "gpuAmount": 0
    }
  ]
}

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

Response

Body

statusstring

errorError (object)

dataGcpCommittedUseDiscountFilterResultModel (object)

data

Request

const response = await fetch('https://api.opsnow.io/cost/v3/commitment/companies/{companyId}/vendors/gcp/services/cud/inventory/categories?startDate=2020-10-01&endDate=2020-10-31', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Response

{
  "status": "text",
  "error": {
    "Message": "text"
  },
  "data": {
    "projects": [
      {
        "code": "ap-northeast-2",
        "name": "Asia Pacific (Seoul)"
      }
    ],
    "commitmentTypes": [
      {
        "code": "ap-northeast-2",
        "name": "Asia Pacific (Seoul)"
      }
    ],
    "regions": [
      {
        "code": "ap-northeast-2",
        "name": "Asia Pacific (Seoul)"
      }
    ],
    "machineTypes": [
      {
        "code": "ap-northeast-2",
        "name": "Asia Pacific (Seoul)"
      }
    ],
    "resourceTypes": [
      {
        "code": "ap-northeast-2",
        "name": "Asia Pacific (Seoul)"
      }
    ],
    "products": [
      {
        "code": "ap-northeast-2",
        "name": "Asia Pacific (Seoul)"
      }
    ]
  }
}

GCP CUD(Committed Use Discount) utilization APIs

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

Response

Body

statusstring

errorError (object)

totalCount*integer (int32)

Item counts of the list

Example: 123

listarray of GcpCommittedUseDiscountUtilizationModel (object)

Request

const response = await fetch('https://api.opsnow.io/cost/v3/commitment/companies/{companyId}/vendors/gcp/services/cud/utilizations?startDate=2020-10-01&endDate=2020-10-31', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Response

{
  "status": "text",
  "error": {
    "Message": "text"
  },
  "totalCount": 123,
  "list": [
    {
      "utilization": 0,
      "commitmentCapacity": 0,
      "usedCapacity": 0,
      "commitmentCost": 0,
      "usedCommitmentCost": 0,
      "committedUseDiscountOnDemandCostEquivalent": 0,
      "netSavingsCost": 0,
      "netSavingsRate": 0,
      "projectId": "text",
      "projectName": "text",
      "regionCode": "us-central1",
      "regionName": "us-central1",
      "productCode": "text",
      "productName": "Compute Engine",
      "machineType": "E2",
      "commitmentTypeName": "Compute Engine",
      "resourceType": "vCPU",
      "unit": "vCPU"
    }
  ]
}

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

Response

Body

statusstring

errorError (object)

listarray of GcpCommittedUseDiscountUtilizationPaymentModel (object)

Request

const response = await fetch('https://api.opsnow.io/cost/v3/commitment/companies/{companyId}/vendors/gcp/services/cud/utilizations/time-series/{dateType}?startDate=2020-10-01&endDate=2020-10-31', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Response

{
  "status": "text",
  "error": {
    "Message": "text"
  },
  "list": [
    {
      "utilization": 0,
      "commitmentCapacity": 0,
      "usedCapacity": 0,
      "commitmentCost": 0,
      "usedCommitmentCost": 0,
      "committedUseDiscountOnDemandCostEquivalent": 0,
      "netSavingsCost": 0,
      "netSavingsRate": 0,
      "usageDate": "2020-07-01"
    }
  ]
}

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

Response

Body

statusstring

errorError (object)

dataGcpCommittedUseDiscountFilterResultModel (object)

data

Request

const response = await fetch('https://api.opsnow.io/cost/v3/commitment/companies/{companyId}/vendors/gcp/services/cud/utilizations/categories?startDate=2020-10-01&endDate=2020-10-31', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Response

{
  "status": "text",
  "error": {
    "Message": "text"
  },
  "data": {
    "projects": [
      {
        "code": "ap-northeast-2",
        "name": "Asia Pacific (Seoul)"
      }
    ],
    "commitmentTypes": [
      {
        "code": "ap-northeast-2",
        "name": "Asia Pacific (Seoul)"
      }
    ],
    "regions": [
      {
        "code": "ap-northeast-2",
        "name": "Asia Pacific (Seoul)"
      }
    ],
    "machineTypes": [
      {
        "code": "ap-northeast-2",
        "name": "Asia Pacific (Seoul)"
      }
    ],
    "resourceTypes": [
      {
        "code": "ap-northeast-2",
        "name": "Asia Pacific (Seoul)"
      }
    ],
    "products": [
      {
        "code": "ap-northeast-2",
        "name": "Asia Pacific (Seoul)"
      }
    ]
  }
}

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

Response

Body

statusstring

errorError (object)

dataGcpCommittedUseDiscountUtilizationPaymentModel (object)

Request

const response = await fetch('https://api.opsnow.io/cost/v3/commitment/companies/{companyId}/vendors/gcp/services/cud/utilizations/aggregated?startDate=2020-10-01&endDate=2020-10-31', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Response

{
  "status": "text",
  "error": {
    "Message": "text"
  },
  "data": {
    "utilization": 0,
    "commitmentCapacity": 0,
    "usedCapacity": 0,
    "commitmentCost": 0,
    "usedCommitmentCost": 0,
    "committedUseDiscountOnDemandCostEquivalent": 0,
    "netSavingsCost": 0,
    "netSavingsRate": 0,
    "usageDate": "2020-07-01"
  }
}

GCP Coverage APIs

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

Response

Body

statusstring

errorError (object)

listarray of GcpCoverageModel (object)

Request

const response = await fetch('https://api.opsnow.io/cost/v3/commitment/companies/{companyId}/vendors/gcp/services/cud/coverages?startDate=2020-10-01&endDate=2020-10-31', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Response

{
  "status": "text",
  "error": {
    "Message": "text"
  },
  "list": [
    {
      "committedUseDiscountCoverageRate": 0,
      "totalCost": 0,
      "totalOnDemandCostEquivalent": 0,
      "totalCreditCost": 0,
      "totalCommitmentCreditCost": 0,
      "committedUseDiscountOnDemandCostEquivalent": 0,
      "sustainedUseDiscountOnDemandCostEquivalent": 0,
      "etcCreditOnDemandCostEquivalent": 0,
      "onDemandCost": 0,
      "projectId": "text",
      "projectName": "text",
      "regionCode": "us-central1",
      "regionName": "us-central1",
      "productCode": "text",
      "productName": "Compute Engine",
      "machineType": "E2",
      "commitmentTypeName": "text",
      "resourceType": "vCPU"
    }
  ]
}

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

Response

Body

statusstring

errorError (object)

listarray of GcpCoverageTransitionModel (object)

Request

const response = await fetch('https://api.opsnow.io/cost/v3/commitment/companies/{companyId}/vendors/gcp/services/cud/coverages/time-series/{dateType}?startDate=2020-10-01&endDate=2020-10-31', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Response

{
  "status": "text",
  "error": {
    "Message": "text"
  },
  "list": [
    {
      "committedUseDiscountCoverageRate": 0,
      "totalCost": 0,
      "totalOnDemandCostEquivalent": 0,
      "totalCreditCost": 0,
      "totalCommitmentCreditCost": 0,
      "committedUseDiscountOnDemandCostEquivalent": 0,
      "sustainedUseDiscountOnDemandCostEquivalent": 0,
      "etcCreditOnDemandCostEquivalent": 0,
      "onDemandCost": 0,
      "usageDate": "2020-07-01"
    }
  ]
}

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

Response

Body

statusstring

errorError (object)

dataGcpCommittedUseDiscountFilterResultModel (object)

data

Request

const response = await fetch('https://api.opsnow.io/cost/v3/commitment/companies/{companyId}/vendors/gcp/services/cud/coverages/categories?startDate=2020-10-01&endDate=2020-10-31', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Response

{
  "status": "text",
  "error": {
    "Message": "text"
  },
  "data": {
    "projects": [
      {
        "code": "ap-northeast-2",
        "name": "Asia Pacific (Seoul)"
      }
    ],
    "commitmentTypes": [
      {
        "code": "ap-northeast-2",
        "name": "Asia Pacific (Seoul)"
      }
    ],
    "regions": [
      {
        "code": "ap-northeast-2",
        "name": "Asia Pacific (Seoul)"
      }
    ],
    "machineTypes": [
      {
        "code": "ap-northeast-2",
        "name": "Asia Pacific (Seoul)"
      }
    ],
    "resourceTypes": [
      {
        "code": "ap-northeast-2",
        "name": "Asia Pacific (Seoul)"
      }
    ],
    "products": [
      {
        "code": "ap-northeast-2",
        "name": "Asia Pacific (Seoul)"
      }
    ]
  }
}

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

Response

Body

statusstring

errorError (object)

dataGcpCoverageValueModel (object)

Request

const response = await fetch('https://api.opsnow.io/cost/v3/commitment/companies/{companyId}/vendors/gcp/services/cud/coverages/aggregated?startDate=2020-10-01&endDate=2020-10-31', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Response

{
  "status": "text",
  "error": {
    "Message": "text"
  },
  "data": {
    "committedUseDiscountCoverageRate": 0,
    "totalCost": 0,
    "totalOnDemandCostEquivalent": 0,
    "totalCreditCost": 0,
    "totalCommitmentCreditCost": 0,
    "committedUseDiscountOnDemandCostEquivalent": 0,
    "sustainedUseDiscountOnDemandCostEquivalent": 0,
    "etcCreditOnDemandCostEquivalent": 0,
    "onDemandCost": 0
  }
}

GCP Recommendation APIs

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)

dataarray of GcpRecommenderInventoryModel (object)

GCP Recommendation list

Request

const response = await fetch('https://api.opsnow.io/cost/v3/commitment/companies/{companyId}/vendors/gcp/services/{service}/recommendations', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Response

{
  "status": "text",
  "error": {
    "Message": "text"
  },
  "data": [
    {
      "accountId": "123456789012",
      "accountAlias": "Bespinglobal Platform",
      "product": "c4.xlarge",
      "projectId": "opsnow-global-prd",
      "recommendationId": "0a2e6861-fd68-4e2e-8232-1e14e816deec",
      "recommendType": "GENERAL_PURPOSE",
      "recommendAmount": 1024,
      "recommendAction": "1024",
      "recommendStatus": "ACTIVE",
      "recommendDescription": "Purchase a 1 year RAM commitment for region us-central1",
      "resourceType": "MEMORY",
      "expectedCost": -0.800516,
      "plan": "TWELVE_MONTH",
      "termLength": "1yr",
      "goal": "LOW_WATERMARK",
      "regionId": "us-central1",
      "regionName": "Council Bluffs, Iowa",
      "regionCategory": "North America",
      "insightId": "1377dfe4-f62d-4074-b52a-93a64a5a1b9d",
      "monthCommitment": 0,
      "monthSaveCost": 0,
      "onDemandCost": 0
    }
  ]
}

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)

dataarray of GcpRecommenderOptionsModel (object)

Purchase option list

Request

const response = await fetch('https://api.opsnow.io/cost/v3/commitment/companies/{companyId}/vendors/gcp/services/{service}/recommendations/purchase-options', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Response

{
  "status": "text",
  "error": {
    "Message": "text"
  },
  "data": [
    {
      "goal": "LOW_WATERMARK",
      "plan": "TWELVE_MONTH",
      "termLength": "1yr",
      "currency": "USD",
      "expectedCost": -0.800516,
      "recommendAmount": 1024,
      "monthCommitment": 0,
      "monthSaveCost": 0,
      "onDemandCost": 0
    }
  ]
}

Get product type list of GCP CUD recommendation

Retrieve product types targeted by GCP(Google Cloud Platform) CUD(Committed Use Discounts) recommendation

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

Authorization

Path parameters

companyId*string

service*string

Response

Body

statusstring

errorError (object)

dataarray of CommonCodeWithParentModel (object)

AWS Recommendation product list

Request

const response = await fetch('https://api.opsnow.io/cost/v3/commitment/companies/{companyId}/vendors/gcp/services/{service}/recommendations/products', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Response

{
  "status": "text",
  "error": {
    "Message": "text"
  },
  "data": [
    {
      "code": "ap-northeast-2",
      "name": "Asia Pacific (Seoul)",
      "parentCode": "RGNCONVERT",
      "codes": "['t3s','m5','c5']"
    }
  ]
}

PreviousAutoSavings

Last updated 8 days ago