Commitment

AWS Recommendation APIs

Get result list of AWS commitment recommendation

Retrieve results of AWS commitment recommendation

get

/cost/v3/commitment/companies/{companyId}/vendors/aws/services/{service}/recommendations

Authorizations

Path parameters

companyIdstringrequired

Company ID

servicestringrequired

Query parameters

productstringrequired

Recommendation target product

purchasestringrequired

Service

termstringrequired

Analysis terms

Example: 14

linkedAccountsstring

Linked accounts

purchaseOptionstring

Purchase option

leasContractLengthstring

Commitment terms

offerClassstring

Offer Class

analyzeTypeCodestring

Savings Plan analysis type code

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.opsnow.io/cost/v3/commitment/companies/{companyId}/vendors/aws/services/{service}/recommendations?product=text&purchase=text&term=14' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

200

{
  "status": "text",
  "error": {
    "Code": 1,
    "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",
      "offerClass": "standard",
      "flexibility": "Flexible",
      "az": "Single-AZ",
      "commitment": 1,
      "monthCommitment": 1,
      "monthOnDemandCost": 1,
      "monthSaveCost": 1,
      "residualOnDemandCost": 1,
      "onDemandCost": 1,
      "onDemandCostOnlyEC2": 1,
      "reservedInstanceOnDemandCost": 1,
      "savingsPlansOnDemandCost": 1,
      "savingsPlansOnDemandCostOnlyEC2": 1,
      "coverageRate": 1,
      "expectancyCoverageRate": 1
    }
  ]
}

OK

Get purchase option information of AWS commitment recommendation

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

get

/cost/v3/commitment/companies/{companyId}/vendors/aws/services/{service}/recommendations/purchase-options

Authorizations

Path parameters

companyIdstringrequired

Company ID

servicestringrequired

Query parameters

productstringrequired

Recommendation target product

purchasestringrequired

Service

termstringrequired

Analysis terms

Example: 14

linkedAccountsstring

Linked accounts

purchaseOptionstring

Purchase option

leasContractLengthstring

Commitment terms

offerClassstring

Offer Class

analyzeTypeCodestring

Savings Plan analysis type code

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.opsnow.io/cost/v3/commitment/companies/{companyId}/vendors/aws/services/{service}/recommendations/purchase-options?product=text&purchase=text&term=14' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

200

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

OK

Get product type list of AWS commitment recommendation

Retrieve product types targeted by AWS commitment recommendation

get

/cost/v3/commitment/companies/{companyId}/vendors/aws/services/{service}/recommendations/products

Authorizations

Path parameters

companyIdstringrequired

servicestringrequired

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.opsnow.io/cost/v3/commitment/companies/{companyId}/vendors/aws/services/{service}/recommendations/products' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

200

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

OK

AWS Reserved Instance Inventory APIs

Get list of user's AWS Reserved Instance inventory

Retrieve Reserved Instance inventory(purchased by user).

get

/cost/v3/commitment/companies/{companyId}/vendors/aws/services/reserved-instance/my-inventory

Authorizations

Path parameters

companyIdstringrequired

Company ID

Example: 1

Query parameters

dateTypestring · enum

Date query type

Example: DAILY

Options: {DAILY, MONTHLY}

startDatestringrequired

Start Date

Example: 2020-10-01

endDatestringrequired

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

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.opsnow.io/cost/v3/commitment/companies/{companyId}/vendors/aws/services/reserved-instance/my-inventory?startDate=2020-10-01&endDate=2020-10-31' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

200

{
  "status": "text",
  "error": {
    "Code": 1,
    "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"
    }
  ]
}

OK

Get list of AWS Reserved Instance inventory

Retrieve Reserved Instance inventory(purchased list).

get

/cost/v3/commitment/companies/{companyId}/vendors/aws/services/reserved-instance/inventory

Authorizations

Path parameters

companyIdstringrequired

Company ID

Example: 1

Query parameters

dateTypestring · enum

Date query type

Example: DAILY

Options: {DAILY, MONTHLY}

startDatestringrequired

Start Date

Example: 2020-10-01

endDatestringrequired

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

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.opsnow.io/cost/v3/commitment/companies/{companyId}/vendors/aws/services/reserved-instance/inventory?startDate=2020-10-01&endDate=2020-10-31' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

200

{
  "status": "text",
  "error": {
    "Code": 1,
    "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"
    }
  ]
}

OK

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.

get

/cost/v3/commitment/companies/{companyId}/vendors/aws/services/reserved-instance/inventory/categories

Authorizations

Path parameters

companyIdstringrequired

Company ID

Example: 1

Query parameters

dateTypestring · enum

Date query type

Example: DAILY

Options: {DAILY, MONTHLY}

startDatestringrequired

Start Date

Example: 2020-10-01

endDatestringrequired

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

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.opsnow.io/cost/v3/commitment/companies/{companyId}/vendors/aws/services/reserved-instance/inventory/categories?startDate=2020-10-01&endDate=2020-10-31' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

200

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

OK

Get list of AutoSavings AWS Reserved Instance inventory

Retrieve Reserved Instance inventory(purchased by AutoSavings).

get

/cost/v3/commitment/companies/{companyId}/vendors/aws/services/reserved-instance/auto-savings-inventory

Authorizations

Path parameters

companyIdstringrequired

Company ID

Example: 1

Query parameters

dateTypestring · enum

Date query type

Example: DAILY

Options: {DAILY, MONTHLY}

startDatestringrequired

Start Date

Example: 2020-10-01

endDatestringrequired

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

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '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' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

200

{
  "status": "text",
  "error": {
    "Code": 1,
    "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"
    }
  ]
}

OK

AWS Reserved Instance utilization APIs

Get utilization data of AWS Reserved Instance

Retrieve utilization data of each AWS Reserved Instance.

get

/cost/v3/commitment/companies/{companyId}/vendors/aws/services/reserved-instance/utilizations

Authorizations

Path parameters

companyIdstringrequired

Company ID

Example: 1

Query parameters

dateTypestring · enum

Date query type

Example: DAILY

Options: {DAILY, MONTHLY}

startDatestringrequired

Start Date

Example: 2020-10-01

endDatestringrequired

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

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.opsnow.io/cost/v3/commitment/companies/{companyId}/vendors/aws/services/reserved-instance/utilizations?startDate=2020-10-01&endDate=2020-10-31' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

200

{
  "status": "text",
  "error": {
    "Code": 1,
    "Message": "text"
  },
  "list": [
    {
      "utilization": 78.15,
      "commitmentCost": 3690.19,
      "usedCommitmentCost": 2880,
      "netSavingsCost": 810.19,
      "netSavingsRate": 1,
      "usedCommitmentCostOnDemandEquivalent": 1,
      "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
    }
  ]
}

OK

Get utilization summary trends of AWS Reserved Instance

Retrieve time-series utilization summary for AWS Reserved Instance.

get

/cost/v3/commitment/companies/{companyId}/vendors/aws/services/reserved-instance/utilizations/time-series/{dateType}

Authorizations

Path parameters

companyIdstringrequired

Company ID

Example: 1

dateTypestringrequired

Date query type

Example: DAILY

Query parameters

startDatestringrequired

Start Date

Example: 2020-10-01

endDatestringrequired

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

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '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' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

200

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

OK

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.

get

/cost/v3/commitment/companies/{companyId}/vendors/aws/services/reserved-instance/utilizations/categories

Authorizations

Path parameters

companyIdstringrequired

Company ID

Example: 1

Query parameters

dateTypestring · enum

Date query type

Example: DAILY

Options: {DAILY, MONTHLY}

startDatestringrequired

Start Date

Example: 2020-10-01

endDatestringrequired

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

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.opsnow.io/cost/v3/commitment/companies/{companyId}/vendors/aws/services/reserved-instance/utilizations/categories?startDate=2020-10-01&endDate=2020-10-31' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

200

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

OK

Get utilization summary of AWS Reserved Instance

Retrieve aggregated utilization summary for AWS Reserved Instance.

get

/cost/v3/commitment/companies/{companyId}/vendors/aws/services/reserved-instance/utilizations/aggregated

Authorizations

Path parameters

companyIdstringrequired

Company ID

Example: 1

Query parameters

dateTypestring · enum

Date query type

Example: DAILY

Options: {DAILY, MONTHLY}

startDatestringrequired

Start Date

Example: 2020-10-01

endDatestringrequired

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

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.opsnow.io/cost/v3/commitment/companies/{companyId}/vendors/aws/services/reserved-instance/utilizations/aggregated?startDate=2020-10-01&endDate=2020-10-31' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

200

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

OK

Get utilization data of user's AWS Reserved Instance

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

get

/cost/v3/commitment/companies/{companyId}/vendors/aws/services/reserved-instance/my-utilizations

Authorizations

Path parameters

companyIdstringrequired

Company ID

Example: 1

Query parameters

dateTypestring · enum

Date query type

Example: DAILY

Options: {DAILY, MONTHLY}

startDatestringrequired

Start Date

Example: 2020-10-01

endDatestringrequired

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

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.opsnow.io/cost/v3/commitment/companies/{companyId}/vendors/aws/services/reserved-instance/my-utilizations?startDate=2020-10-01&endDate=2020-10-31' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

200

{
  "status": "text",
  "error": {
    "Code": 1,
    "Message": "text"
  },
  "list": [
    {
      "utilization": 78.15,
      "commitmentCost": 3690.19,
      "usedCommitmentCost": 2880,
      "netSavingsCost": 810.19,
      "netSavingsRate": 1,
      "usedCommitmentCostOnDemandEquivalent": 1,
      "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
    }
  ]
}

OK

Get utilization summary trends of user's AWS Reserved Instance

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

get

/cost/v3/commitment/companies/{companyId}/vendors/aws/services/reserved-instance/my-utilizations/time-series/{dateType}

Authorizations

Path parameters

companyIdstringrequired

Company ID

Example: 1

dateTypestringrequired

Date query type

Example: DAILY

Query parameters

startDatestringrequired

Start Date

Example: 2020-10-01

endDatestringrequired

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

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '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' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

200

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

OK

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.

get

/cost/v3/commitment/companies/{companyId}/vendors/aws/services/reserved-instance/my-utilizations/categories

Authorizations

Path parameters

companyIdstringrequired

Company ID

Example: 1

Query parameters

dateTypestring · enum

Date query type

Example: DAILY

Options: {DAILY, MONTHLY}

startDatestringrequired

Start Date

Example: 2020-10-01

endDatestringrequired

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

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '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' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

200

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

OK

Get utilization summary of user's AWS Reserved Instance

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

get

/cost/v3/commitment/companies/{companyId}/vendors/aws/services/reserved-instance/my-utilizations/aggregated

Authorizations

Path parameters

companyIdstringrequired

Company ID

Example: 1

Query parameters

dateTypestring · enum

Date query type

Example: DAILY

Options: {DAILY, MONTHLY}

startDatestringrequired

Start Date

Example: 2020-10-01

endDatestringrequired

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

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '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' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

200

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

OK

AWS Savings Plans Inventory APIs

Get list of user's AWS Savings Plans inventory

Retrieve Savings Plans inventory(purchased by user).

get

/cost/v3/commitment/companies/{companyId}/vendors/aws/services/savings-plans/my-inventory

Authorizations

Path parameters

companyIdstringrequired

Company ID

Example: 1

Query parameters

dateTypestring · enum

Date query type

Example: DAILY

Options: {DAILY, MONTHLY}

startDatestringrequired

Start Date

Example: 2020-10-01

endDatestringrequired

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

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.opsnow.io/cost/v3/commitment/companies/{companyId}/vendors/aws/services/savings-plans/my-inventory?startDate=2020-10-01&endDate=2020-10-31' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

200

{
  "status": "text",
  "error": {
    "Code": 1,
    "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
    }
  ]
}

OK

Get list of AWS Savings Plans inventory

Retrieve Savings Plans inventory(purchased list).

get

/cost/v3/commitment/companies/{companyId}/vendors/aws/services/savings-plans/inventory

Authorizations

Path parameters

companyIdstringrequired

Company ID

Example: 1

Query parameters

dateTypestring · enum

Date query type

Example: DAILY

Options: {DAILY, MONTHLY}

startDatestringrequired

Start Date

Example: 2020-10-01

endDatestringrequired

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

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.opsnow.io/cost/v3/commitment/companies/{companyId}/vendors/aws/services/savings-plans/inventory?startDate=2020-10-01&endDate=2020-10-31' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

200

{
  "status": "text",
  "error": {
    "Code": 1,
    "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
    }
  ]
}

OK

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.

get

/cost/v3/commitment/companies/{companyId}/vendors/aws/services/savings-plans/inventory/categories

Authorizations

Path parameters

companyIdstringrequired

Company ID

Example: 1

Query parameters

dateTypestring · enum

Date query type

Example: DAILY

Options: {DAILY, MONTHLY}

startDatestringrequired

Start Date

Example: 2020-10-01

endDatestringrequired

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

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.opsnow.io/cost/v3/commitment/companies/{companyId}/vendors/aws/services/savings-plans/inventory/categories?startDate=2020-10-01&endDate=2020-10-31' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

200

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

OK

Get list of AutoSavings AWS Savings Plans inventory

Retrieve Savings Plans inventory(purchased by AutoSavings).

get

/cost/v3/commitment/companies/{companyId}/vendors/aws/services/savings-plans/auto-savings-inventory

Authorizations

Path parameters

companyIdstringrequired

Company ID

Example: 1

Query parameters

dateTypestring · enum

Date query type

Example: DAILY

Options: {DAILY, MONTHLY}

startDatestringrequired

Start Date

Example: 2020-10-01

endDatestringrequired

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

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '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' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

200

{
  "status": "text",
  "error": {
    "Code": 1,
    "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
    }
  ]
}

OK

AWS Savings Plans utilization APIs

Get utilization data of AWS Savings Plans

Retrieve utilization data of each AWS Savings Plans.

get

/cost/v3/commitment/companies/{companyId}/vendors/aws/services/savings-plans/utilizations

Authorizations

Path parameters

companyIdstringrequired

Company ID

Example: 1

Query parameters

dateTypestring · enum

Date query type

Example: DAILY

Options: {DAILY, MONTHLY}

startDatestringrequired

Start Date

Example: 2020-10-01

endDatestringrequired

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

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.opsnow.io/cost/v3/commitment/companies/{companyId}/vendors/aws/services/savings-plans/utilizations?startDate=2020-10-01&endDate=2020-10-31' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

200

{
  "status": "text",
  "error": {
    "Code": 1,
    "Message": "text"
  },
  "list": [
    {
      "utilization": 78.15,
      "commitmentCost": 3690.19,
      "usedCommitmentCost": 2880,
      "netSavingsCost": 810.19,
      "netSavingsRate": 1,
      "usedCommitmentCostOnDemandEquivalent": 1,
      "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)"
    }
  ]
}

OK

Get utilization summary trends of AWS Savings Plans

Retrieve time-series utilization summary for AWS Savings Plans.

get

/cost/v3/commitment/companies/{companyId}/vendors/aws/services/savings-plans/utilizations/time-series/{dateType}

Authorizations

Path parameters

companyIdstringrequired

Company ID

Example: 1

dateTypestringrequired

Date query type

Example: DAILY

Query parameters

startDatestringrequired

Start Date

Example: 2020-10-01

endDatestringrequired

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

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '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' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

200

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

OK

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.

get

/cost/v3/commitment/companies/{companyId}/vendors/aws/services/savings-plans/utilizations/categories

Authorizations

Path parameters

companyIdstringrequired

Company ID

Example: 1

Query parameters

dateTypestring · enum

Date query type

Example: DAILY

Options: {DAILY, MONTHLY}

startDatestringrequired

Start Date

Example: 2020-10-01

endDatestringrequired

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

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.opsnow.io/cost/v3/commitment/companies/{companyId}/vendors/aws/services/savings-plans/utilizations/categories?startDate=2020-10-01&endDate=2020-10-31' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

200

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

OK

Get utilization summary of AWS Savings Plans

Retrieve aggregated utilization summary for AWS Savings Plans.

get

/cost/v3/commitment/companies/{companyId}/vendors/aws/services/savings-plans/utilizations/aggregated

Authorizations

Path parameters

companyIdstringrequired

Company ID

Example: 1

Query parameters

dateTypestring · enum

Date query type

Example: DAILY

Options: {DAILY, MONTHLY}

startDatestringrequired

Start Date

Example: 2020-10-01

endDatestringrequired

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

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.opsnow.io/cost/v3/commitment/companies/{companyId}/vendors/aws/services/savings-plans/utilizations/aggregated?startDate=2020-10-01&endDate=2020-10-31' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

200

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

OK

AWS commitment utilization APIs

Get utilization data of AWS commitment

Retrieve utilization data of each AWS commitment.

get

/cost/v3/commitment/companies/{companyId}/vendors/aws/services/all/utilizations

Authorizations

Path parameters

companyIdstringrequired

Company ID

Example: 1

Query parameters

dateTypestring · enum

Date query type

Example: DAILY

Options: {DAILY, MONTHLY}

startDatestringrequired

Start Date

Example: 2020-10-01

endDatestringrequired

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

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.opsnow.io/cost/v3/commitment/companies/{companyId}/vendors/aws/services/all/utilizations?startDate=2020-10-01&endDate=2020-10-31' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

200

{
  "status": "text",
  "error": {
    "Code": 1,
    "Message": "text"
  },
  "list": [
    {
      "utilization": 78.15,
      "commitmentCost": 3690.19,
      "usedCommitmentCost": 2880,
      "netSavingsCost": 810.19,
      "netSavingsRate": 1,
      "usedCommitmentCostOnDemandEquivalent": 1,
      "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"
    }
  ]
}

OK

Get utilization summary trends of AWS commitment

Retrieve time-series utilization summary for AWS commitment.

get

/cost/v3/commitment/companies/{companyId}/vendors/aws/services/all/utilizations/time-series/{dateType}

Authorizations

Path parameters

companyIdstringrequired

Company ID

Example: 1

dateTypestringrequired

Date query type

Example: DAILY

Query parameters

startDatestringrequired

Start Date

Example: 2020-10-01

endDatestringrequired

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

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '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' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

200

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

OK

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.

get

/cost/v3/commitment/companies/{companyId}/vendors/aws/services/all/utilizations/categories

Authorizations

Path parameters

companyIdstringrequired

Company ID

Example: 1

Query parameters

dateTypestring · enum

Date query type

Example: DAILY

Options: {DAILY, MONTHLY}

startDatestringrequired

Start Date

Example: 2020-10-01

endDatestringrequired

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

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.opsnow.io/cost/v3/commitment/companies/{companyId}/vendors/aws/services/all/utilizations/categories?startDate=2020-10-01&endDate=2020-10-31' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

200

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

OK

Get utilization summary of AWS commitment

Retrieve aggregated utilization summary for AWS commitment.

get

/cost/v3/commitment/companies/{companyId}/vendors/aws/services/all/utilizations/aggregated

Authorizations

Path parameters

companyIdstringrequired

Company ID

Example: 1

Query parameters

dateTypestring · enum

Date query type

Example: DAILY

Options: {DAILY, MONTHLY}

startDatestringrequired

Start Date

Example: 2020-10-01

endDatestringrequired

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

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.opsnow.io/cost/v3/commitment/companies/{companyId}/vendors/aws/services/all/utilizations/aggregated?startDate=2020-10-01&endDate=2020-10-31' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

200

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

OK

Azure Recommendation APIs

Get result list of Azure Reservations recommendation

Retrieve results of Azure Reservations recommendations

get

/cost/v3/commitment/companies/{companyId}/vendors/azure/services/{service}/recommendations

Authorizations

Path parameters

companyIdstringrequired

Company ID

Example: 1

servicestringrequired

Query parameters

toKRWboolean

To convert amount data to Korean Won(₩)

lookbackPeriodstringrequired

Azure Lookback Period

Example: 30

termstring

Commitment term

Example: P1Y

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.opsnow.io/cost/v3/commitment/companies/{companyId}/vendors/azure/services/{service}/recommendations?lookbackPeriod=30' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

200

{
  "status": "text",
  "error": {
    "Code": 1,
    "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": "$"
    }
  ]
}

OK

Get product type list of Azure Reservations recommendation

Retrieve product types targeted by Azure Reservations recommendation

get

/cost/v3/commitment/companies/{companyId}/vendors/azure/services/{service}/recommendations/products

Authorizations

Path parameters

companyIdstringrequired

servicestringrequired

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.opsnow.io/cost/v3/commitment/companies/{companyId}/vendors/azure/services/{service}/recommendations/products' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

200

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

OK

GCP CUD(Committed Use Discount) Inventory APIs

Get list of GCP CUD(Committed Use Discount) inventory

Retrieve Reserved Instance inventory(purchased list).

get

/cost/v3/commitment/companies/{companyId}/vendors/gcp/services/cud/inventory

Authorizations

Path parameters

companyIdstringrequired

Company ID

Example: 1

Query parameters

dateTypestring · enum

Date query type

Example: DAILY

Options: {DAILY, MONTHLY}

startDatestringrequired

Search start Date

Example: 2020-10-01

endDatestringrequired

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

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.opsnow.io/cost/v3/commitment/companies/{companyId}/vendors/gcp/services/cud/inventory?startDate=2020-10-01&endDate=2020-10-31' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

200

{
  "status": "text",
  "error": {
    "Code": 1,
    "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": 1,
      "memoryAmount": 1,
      "storageAmount": 1,
      "gpuAmount": 1
    }
  ]
}

OK

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.

get

/cost/v3/commitment/companies/{companyId}/vendors/gcp/services/cud/inventory/categories

Authorizations

Path parameters

companyIdstringrequired

Company ID

Example: 1

Query parameters

dateTypestring · enum

Date query type

Example: DAILY

Options: {DAILY, MONTHLY}

startDatestringrequired

Search start Date

Example: 2020-10-01

endDatestringrequired

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

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.opsnow.io/cost/v3/commitment/companies/{companyId}/vendors/gcp/services/cud/inventory/categories?startDate=2020-10-01&endDate=2020-10-31' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

200

{
  "status": "text",
  "error": {
    "Code": 1,
    "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)"
      }
    ]
  }
}

OK

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).

get

/cost/v3/commitment/companies/{companyId}/vendors/gcp/services/cud/utilizations

Authorizations

Path parameters

companyIdstringrequired

Company ID

Example: 1

Query parameters

dateTypestring · enum

Date query type

Example: DAILY

Options: {DAILY, MONTHLY}

startDatestringrequired

Search start Date

Example: 2020-10-01

endDatestringrequired

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

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.opsnow.io/cost/v3/commitment/companies/{companyId}/vendors/gcp/services/cud/utilizations?startDate=2020-10-01&endDate=2020-10-31' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

200

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

OK

Get utilization summary trends of GCP CUD(Committed Use Discount)

Retrieve time-series utilization summary for GCP CUD(Committed Use Discount).

get

/cost/v3/commitment/companies/{companyId}/vendors/gcp/services/cud/utilizations/time-series/{dateType}

Authorizations

Path parameters

companyIdstringrequired

Company ID

Example: 1

dateTypestringrequired

Date query type

Example: DAILY

Query parameters

startDatestringrequired

Search start Date

Example: 2020-10-01

endDatestringrequired

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

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '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' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

200

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

OK

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.

get

/cost/v3/commitment/companies/{companyId}/vendors/gcp/services/cud/utilizations/categories

Authorizations

Path parameters

companyIdstringrequired

Company ID

Example: 1

Query parameters

dateTypestring · enum

Date query type

Example: DAILY

Options: {DAILY, MONTHLY}

startDatestringrequired

Search start Date

Example: 2020-10-01

endDatestringrequired

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

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.opsnow.io/cost/v3/commitment/companies/{companyId}/vendors/gcp/services/cud/utilizations/categories?startDate=2020-10-01&endDate=2020-10-31' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

200

{
  "status": "text",
  "error": {
    "Code": 1,
    "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)"
      }
    ]
  }
}

OK

Get utilization summary of GCP CUD(Committed Use Discount)

Retrieve aggregated utilization summary for GCP CUD(Committed Use Discount).

get

/cost/v3/commitment/companies/{companyId}/vendors/gcp/services/cud/utilizations/aggregated

Authorizations

Path parameters

companyIdstringrequired

Company ID

Example: 1

Query parameters

dateTypestring · enum

Date query type

Example: DAILY

Options: {DAILY, MONTHLY}

startDatestringrequired

Search start Date

Example: 2020-10-01

endDatestringrequired

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

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.opsnow.io/cost/v3/commitment/companies/{companyId}/vendors/gcp/services/cud/utilizations/aggregated?startDate=2020-10-01&endDate=2020-10-31' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

200

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

OK

GCP Coverage APIs

Get coverage data of GCP commitment

Retrieve coverage data of each GCP commitment.

get

/cost/v3/commitment/companies/{companyId}/vendors/gcp/services/cud/coverages

Authorizations

Path parameters

companyIdstringrequired

Company ID

Example: 1

Query parameters

dateTypestring · enum

Date query type

Example: DAILY

Options: {DAILY, MONTHLY}

startDatestringrequired

Search start Date

Example: 2020-10-01

endDatestringrequired

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

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.opsnow.io/cost/v3/commitment/companies/{companyId}/vendors/gcp/services/cud/coverages?startDate=2020-10-01&endDate=2020-10-31' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

200

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

OK

Get coverage summary trends of GCP commitment

Retrieve time-series coverage summary for GCP commitment.

get

/cost/v3/commitment/companies/{companyId}/vendors/gcp/services/cud/coverages/time-series/{dateType}

Authorizations

Path parameters

companyIdstringrequired

Company ID

Example: 1

dateTypestringrequired

Date query type

Example: DAILY

Query parameters

startDatestringrequired

Search start Date

Example: 2020-10-01

endDatestringrequired

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

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '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' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

200

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

OK

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.

get

/cost/v3/commitment/companies/{companyId}/vendors/gcp/services/cud/coverages/categories

Authorizations

Path parameters

companyIdstringrequired

Company ID

Example: 1

Query parameters

dateTypestring · enum

Date query type

Example: DAILY

Options: {DAILY, MONTHLY}

startDatestringrequired

Search start Date

Example: 2020-10-01

endDatestringrequired

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

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.opsnow.io/cost/v3/commitment/companies/{companyId}/vendors/gcp/services/cud/coverages/categories?startDate=2020-10-01&endDate=2020-10-31' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

200

{
  "status": "text",
  "error": {
    "Code": 1,
    "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)"
      }
    ]
  }
}

OK

Get coverage summary of GCP commitment

Retrieve aggregated coverage summary for GCP commitment.

get

/cost/v3/commitment/companies/{companyId}/vendors/gcp/services/cud/coverages/aggregated

Authorizations

Path parameters

companyIdstringrequired

Company ID

Example: 1

Query parameters

dateTypestring · enum

Date query type

Example: DAILY

Options: {DAILY, MONTHLY}

startDatestringrequired

Search start Date

Example: 2020-10-01

endDatestringrequired

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

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.opsnow.io/cost/v3/commitment/companies/{companyId}/vendors/gcp/services/cud/coverages/aggregated?startDate=2020-10-01&endDate=2020-10-31' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

200

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

OK

GCP Recommendation APIs

Get result list of GCP CUD recommendation

Retrieve results of GCP(Google Cloud Platform) CUD(Committed Use Discounts) recommendations

get

/cost/v3/commitment/companies/{companyId}/vendors/gcp/services/{service}/recommendations

Authorizations

Path parameters

companyIdstringrequired

Company ID

Example: 1

servicestringrequired

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.opsnow.io/cost/v3/commitment/companies/{companyId}/vendors/gcp/services/{service}/recommendations' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

200

{
  "status": "text",
  "error": {
    "Code": 1,
    "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": 1,
      "monthSaveCost": 1,
      "onDemandCost": 1
    }
  ]
}

OK

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.

get

/cost/v3/commitment/companies/{companyId}/vendors/gcp/services/{service}/recommendations/purchase-options

Authorizations

Path parameters

companyIdstringrequired

Company ID

Example: 1

servicestringrequired

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.opsnow.io/cost/v3/commitment/companies/{companyId}/vendors/gcp/services/{service}/recommendations/purchase-options' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

200

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

OK

Get product type list of GCP CUD recommendation

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

get

/cost/v3/commitment/companies/{companyId}/vendors/gcp/services/{service}/recommendations/products

Authorizations

Path parameters

companyIdstringrequired

servicestringrequired

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.opsnow.io/cost/v3/commitment/companies/{companyId}/vendors/gcp/services/{service}/recommendations/products' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

200

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

OK