Commitment

AWS Recommendation APIs

Get result list of AWS commitment recommendation

get

Retrieve results of AWS commitment recommendation

Authorizations
Path parameters
companyIdstringRequired

Company ID

servicestringRequired
Query parameters
productstringRequired

Recommendation target product

purchasestringRequired

Service

termstringRequired

Analysis terms

Example: 14
linkedAccountsstringOptional

Linked accounts

purchaseOptionstringOptional

Purchase option

leasContractLengthstringOptional

Commitment terms

offerClassstringOptional

Offer Class

analyzeTypeCodestringOptional

Savings Plan analysis type code

Responses
200
OK
*/*
get
GET /cost/v3/commitment/companies/{companyId}/vendors/aws/services/{service}/recommendations HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

OK

{
  "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
    }
  ]
}

Get purchase option information of AWS commitment recommendation

get

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

Authorizations
Path parameters
companyIdstringRequired

Company ID

servicestringRequired
Query parameters
productstringRequired

Recommendation target product

purchasestringRequired

Service

termstringRequired

Analysis terms

Example: 14
linkedAccountsstringOptional

Linked accounts

purchaseOptionstringOptional

Purchase option

leasContractLengthstringOptional

Commitment terms

offerClassstringOptional

Offer Class

analyzeTypeCodestringOptional

Savings Plan analysis type code

Responses
200
OK
*/*
get
GET /cost/v3/commitment/companies/{companyId}/vendors/aws/services/{service}/recommendations/purchase-options HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

OK

{
  "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]"
          ]
        }
      ]
    }
  ]
}

Get product type list of AWS commitment recommendation

get

Retrieve product types targeted by AWS commitment recommendation

Authorizations
Path parameters
companyIdstringRequired
servicestringRequired
Responses
200
OK
*/*
get
GET /cost/v3/commitment/companies/{companyId}/vendors/aws/services/{service}/recommendations/products HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

OK

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

AWS Reserved Instance Inventory APIs

Get list of user's AWS Reserved Instance inventory

get

Retrieve Reserved Instance inventory(purchased by user).

Authorizations
Path parameters
companyIdstringRequired

Company ID

Example: 1
Query parameters
dateTypestring · enumOptional

Date query type

Example: DAILYPossible values:
startDatestringRequired

Start Date

Example: 2020-10-01
endDatestringRequired

End Date

Example: 2020-10-31
accountsstringOptional

Linked Account IDs

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

Products

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

Whether the commitment is expired

searchTypestringOptional

Commitment search type

Example: All, My, AutoSavings
Responses
200
OK
*/*
get
GET /cost/v3/commitment/companies/{companyId}/vendors/aws/services/reserved-instance/my-inventory HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

OK

{
  "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"
    }
  ]
}

Get list of AWS Reserved Instance inventory

get

Retrieve Reserved Instance inventory(purchased list).

Authorizations
Path parameters
companyIdstringRequired

Company ID

Example: 1
Query parameters
dateTypestring · enumOptional

Date query type

Example: DAILYPossible values:
startDatestringRequired

Start Date

Example: 2020-10-01
endDatestringRequired

End Date

Example: 2020-10-31
accountsstringOptional

Linked Account IDs

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

Products

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

Whether the commitment is expired

searchTypestringOptional

Commitment search type

Example: All, My, AutoSavings
Responses
200
OK
*/*
get
GET /cost/v3/commitment/companies/{companyId}/vendors/aws/services/reserved-instance/inventory HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

OK

{
  "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"
    }
  ]
}

Get category list of AWS Reserved Instance inventory

get

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

Authorizations
Path parameters
companyIdstringRequired

Company ID

Example: 1
Query parameters
dateTypestring · enumOptional

Date query type

Example: DAILYPossible values:
startDatestringRequired

Start Date

Example: 2020-10-01
endDatestringRequired

End Date

Example: 2020-10-31
accountsstringOptional

Linked Account IDs

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

Products

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

Whether the commitment is expired

searchTypestringOptional

Commitment search type

Example: All, My, AutoSavings
Responses
200
OK
*/*
get
GET /cost/v3/commitment/companies/{companyId}/vendors/aws/services/reserved-instance/inventory/categories HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

OK

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

Get list of AutoSavings AWS Reserved Instance inventory

get

Retrieve Reserved Instance inventory(purchased by AutoSavings).

Authorizations
Path parameters
companyIdstringRequired

Company ID

Example: 1
Query parameters
dateTypestring · enumOptional

Date query type

Example: DAILYPossible values:
startDatestringRequired

Start Date

Example: 2020-10-01
endDatestringRequired

End Date

Example: 2020-10-31
accountsstringOptional

Linked Account IDs

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

Products

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

Whether the commitment is expired

searchTypestringOptional

Commitment search type

Example: All, My, AutoSavings
Responses
200
OK
*/*
get
GET /cost/v3/commitment/companies/{companyId}/vendors/aws/services/reserved-instance/auto-savings-inventory HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

OK

{
  "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"
    }
  ]
}

AWS Reserved Instance utilization APIs

Get utilization data of AWS Reserved Instance

get

Retrieve utilization data of each AWS Reserved Instance.

Authorizations
Path parameters
companyIdstringRequired

Company ID

Example: 1
Query parameters
dateTypestring · enumOptional

Date query type

Example: DAILYPossible values:
startDatestringRequired

Start Date

Example: 2020-10-01
endDatestringRequired

End Date

Example: 2020-10-31
accountsstringOptional

Linked Account IDs

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

Products

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

Whether the commitment is expired

searchTypestringOptional

Commitment search type

Example: All, My, AutoSavings
Responses
200
OK
*/*
get
GET /cost/v3/commitment/companies/{companyId}/vendors/aws/services/reserved-instance/utilizations HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

OK

{
  "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
    }
  ]
}

Get utilization summary trends of AWS Reserved Instance

get

Retrieve time-series utilization summary for AWS Reserved Instance.

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
accountsstringOptional

Linked Account IDs

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

Products

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

Whether the commitment is expired

searchTypestringOptional

Commitment search type

Example: All, My, AutoSavings
Responses
200
OK
*/*
get
GET /cost/v3/commitment/companies/{companyId}/vendors/aws/services/reserved-instance/utilizations/time-series/{dateType} HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

OK

{
  "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"
    }
  ]
}

Get category list of AWS Reserved Instance utilization

get

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.

Authorizations
Path parameters
companyIdstringRequired

Company ID

Example: 1
Query parameters
dateTypestring · enumOptional

Date query type

Example: DAILYPossible values:
startDatestringRequired

Start Date

Example: 2020-10-01
endDatestringRequired

End Date

Example: 2020-10-31
accountsstringOptional

Linked Account IDs

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

Products

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

Whether the commitment is expired

searchTypestringOptional

Commitment search type

Example: All, My, AutoSavings
Responses
200
OK
*/*
get
GET /cost/v3/commitment/companies/{companyId}/vendors/aws/services/reserved-instance/utilizations/categories HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

OK

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

Get utilization summary of AWS Reserved Instance

get

Retrieve aggregated utilization summary for AWS Reserved Instance.

Authorizations
Path parameters
companyIdstringRequired

Company ID

Example: 1
Query parameters
dateTypestring · enumOptional

Date query type

Example: DAILYPossible values:
startDatestringRequired

Start Date

Example: 2020-10-01
endDatestringRequired

End Date

Example: 2020-10-31
accountsstringOptional

Linked Account IDs

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

Products

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

Whether the commitment is expired

searchTypestringOptional

Commitment search type

Example: All, My, AutoSavings
Responses
200
OK
*/*
get
GET /cost/v3/commitment/companies/{companyId}/vendors/aws/services/reserved-instance/utilizations/aggregated HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

OK

{
  "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"
  }
}

Get utilization data of user's AWS Reserved Instance

get

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

Authorizations
Path parameters
companyIdstringRequired

Company ID

Example: 1
Query parameters
dateTypestring · enumOptional

Date query type

Example: DAILYPossible values:
startDatestringRequired

Start Date

Example: 2020-10-01
endDatestringRequired

End Date

Example: 2020-10-31
accountsstringOptional

Linked Account IDs

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

Products

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

Whether the commitment is expired

searchTypestringOptional

Commitment search type

Example: All, My, AutoSavings
Responses
200
OK
*/*
get
GET /cost/v3/commitment/companies/{companyId}/vendors/aws/services/reserved-instance/my-utilizations HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

OK

{
  "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
    }
  ]
}

Get utilization summary trends of user's AWS Reserved Instance

get

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

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
accountsstringOptional

Linked Account IDs

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

Products

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

Whether the commitment is expired

searchTypestringOptional

Commitment search type

Example: All, My, AutoSavings
Responses
200
OK
*/*
get
GET /cost/v3/commitment/companies/{companyId}/vendors/aws/services/reserved-instance/my-utilizations/time-series/{dateType} HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

OK

{
  "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"
    }
  ]
}

Get category list of user's AWS Reserved Instance utilization

get

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.

Authorizations
Path parameters
companyIdstringRequired

Company ID

Example: 1
Query parameters
dateTypestring · enumOptional

Date query type

Example: DAILYPossible values:
startDatestringRequired

Start Date

Example: 2020-10-01
endDatestringRequired

End Date

Example: 2020-10-31
accountsstringOptional

Linked Account IDs

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

Products

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

Whether the commitment is expired

searchTypestringOptional

Commitment search type

Example: All, My, AutoSavings
Responses
200
OK
*/*
get
GET /cost/v3/commitment/companies/{companyId}/vendors/aws/services/reserved-instance/my-utilizations/categories HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

OK

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

Get utilization summary of user's AWS Reserved Instance

get

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

Authorizations
Path parameters
companyIdstringRequired

Company ID

Example: 1
Query parameters
dateTypestring · enumOptional

Date query type

Example: DAILYPossible values:
startDatestringRequired

Start Date

Example: 2020-10-01
endDatestringRequired

End Date

Example: 2020-10-31
accountsstringOptional

Linked Account IDs

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

Products

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

Whether the commitment is expired

searchTypestringOptional

Commitment search type

Example: All, My, AutoSavings
Responses
200
OK
*/*
get
GET /cost/v3/commitment/companies/{companyId}/vendors/aws/services/reserved-instance/my-utilizations/aggregated HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

OK

{
  "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"
  }
}

AWS Savings Plans Inventory APIs

Get list of user's AWS Savings Plans inventory

get

Retrieve Savings Plans inventory(purchased by user).

Authorizations
Path parameters
companyIdstringRequired

Company ID

Example: 1
Query parameters
dateTypestring · enumOptional

Date query type

Example: DAILYPossible values:
startDatestringRequired

Start Date

Example: 2020-10-01
endDatestringRequired

End Date

Example: 2020-10-31
accountsstringOptional

Linked Account ID

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

Service type

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

Whether the commitment is expired

Example: false
searchTypestringOptional

Commitment search Type

Example: All, My, AutoSavings
Responses
200
OK
*/*
get
GET /cost/v3/commitment/companies/{companyId}/vendors/aws/services/savings-plans/my-inventory HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

OK

{
  "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
    }
  ]
}

Get list of AWS Savings Plans inventory

get

Retrieve Savings Plans inventory(purchased list).

Authorizations
Path parameters
companyIdstringRequired

Company ID

Example: 1
Query parameters
dateTypestring · enumOptional

Date query type

Example: DAILYPossible values:
startDatestringRequired

Start Date

Example: 2020-10-01
endDatestringRequired

End Date

Example: 2020-10-31
accountsstringOptional

Linked Account ID

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

Service type

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

Whether the commitment is expired

Example: false
searchTypestringOptional

Commitment search Type

Example: All, My, AutoSavings
Responses
200
OK
*/*
get
GET /cost/v3/commitment/companies/{companyId}/vendors/aws/services/savings-plans/inventory HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

OK

{
  "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
    }
  ]
}

Get category list of AWS Savings Plans inventory

get

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

Authorizations
Path parameters
companyIdstringRequired

Company ID

Example: 1
Query parameters
dateTypestring · enumOptional

Date query type

Example: DAILYPossible values:
startDatestringRequired

Start Date

Example: 2020-10-01
endDatestringRequired

End Date

Example: 2020-10-31
accountsstringOptional

Linked Account ID

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

Service type

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

Whether the commitment is expired

Example: false
searchTypestringOptional

Commitment search Type

Example: All, My, AutoSavings
Responses
200
OK
*/*
get
GET /cost/v3/commitment/companies/{companyId}/vendors/aws/services/savings-plans/inventory/categories HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

OK

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

Get list of AutoSavings AWS Savings Plans inventory

get

Retrieve Savings Plans inventory(purchased by AutoSavings).

Authorizations
Path parameters
companyIdstringRequired

Company ID

Example: 1
Query parameters
dateTypestring · enumOptional

Date query type

Example: DAILYPossible values:
startDatestringRequired

Start Date

Example: 2020-10-01
endDatestringRequired

End Date

Example: 2020-10-31
accountsstringOptional

Linked Account ID

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

Service type

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

Whether the commitment is expired

Example: false
searchTypestringOptional

Commitment search Type

Example: All, My, AutoSavings
Responses
200
OK
*/*
get
GET /cost/v3/commitment/companies/{companyId}/vendors/aws/services/savings-plans/auto-savings-inventory HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

OK

{
  "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
    }
  ]
}

AWS Savings Plans utilization APIs

Get utilization data of AWS Savings Plans

get

Retrieve utilization data of each AWS Savings Plans.

Authorizations
Path parameters
companyIdstringRequired

Company ID

Example: 1
Query parameters
dateTypestring · enumOptional

Date query type

Example: DAILYPossible values:
startDatestringRequired

Start Date

Example: 2020-10-01
endDatestringRequired

End Date

Example: 2020-10-31
accountsstringOptional

Linked Account ID

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

Service type

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

Whether the commitment is expired

Example: false
searchTypestringOptional

Commitment search Type

Example: All, My, AutoSavings
Responses
200
OK
*/*
get
GET /cost/v3/commitment/companies/{companyId}/vendors/aws/services/savings-plans/utilizations HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

OK

{
  "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)"
    }
  ]
}

Get utilization summary trends of AWS Savings Plans

get

Retrieve time-series utilization summary for AWS Savings Plans.

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
accountsstringOptional

Linked Account ID

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

Service type

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

Whether the commitment is expired

Example: false
searchTypestringOptional

Commitment search Type

Example: All, My, AutoSavings
Responses
200
OK
*/*
get
GET /cost/v3/commitment/companies/{companyId}/vendors/aws/services/savings-plans/utilizations/time-series/{dateType} HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

OK

{
  "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"
    }
  ]
}

Get category list of AWS Savings Plans utilization

get

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.

Authorizations
Path parameters
companyIdstringRequired

Company ID

Example: 1
Query parameters
dateTypestring · enumOptional

Date query type

Example: DAILYPossible values:
startDatestringRequired

Start Date

Example: 2020-10-01
endDatestringRequired

End Date

Example: 2020-10-31
accountsstringOptional

Linked Account ID

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

Service type

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

Whether the commitment is expired

Example: false
searchTypestringOptional

Commitment search Type

Example: All, My, AutoSavings
Responses
200
OK
*/*
get
GET /cost/v3/commitment/companies/{companyId}/vendors/aws/services/savings-plans/utilizations/categories HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

OK

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

Get utilization summary of AWS Savings Plans

get

Retrieve aggregated utilization summary for AWS Savings Plans.

Authorizations
Path parameters
companyIdstringRequired

Company ID

Example: 1
Query parameters
dateTypestring · enumOptional

Date query type

Example: DAILYPossible values:
startDatestringRequired

Start Date

Example: 2020-10-01
endDatestringRequired

End Date

Example: 2020-10-31
accountsstringOptional

Linked Account ID

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

Service type

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

Whether the commitment is expired

Example: false
searchTypestringOptional

Commitment search Type

Example: All, My, AutoSavings
Responses
200
OK
*/*
get
GET /cost/v3/commitment/companies/{companyId}/vendors/aws/services/savings-plans/utilizations/aggregated HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

OK

{
  "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"
  }
}

AWS commitment utilization APIs

Get utilization data of AWS commitment

get

Retrieve utilization data of each AWS commitment.

Authorizations
Path parameters
companyIdstringRequired

Company ID

Example: 1
Query parameters
dateTypestring · enumOptional

Date query type

Example: DAILYPossible values:
startDatestringRequired

Start Date

Example: 2020-10-01
endDatestringRequired

End Date

Example: 2020-10-31
accountsstringOptional

Linked Account ID

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

Service type

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

Whether the commitment is expired

Example: false
searchTypestringOptional

Commitment search Type

Example: All, My, AutoSavings
Responses
200
OK
*/*
get
GET /cost/v3/commitment/companies/{companyId}/vendors/aws/services/all/utilizations HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

OK

{
  "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"
    }
  ]
}

Get utilization summary trends of AWS commitment

get

Retrieve time-series utilization summary for AWS commitment.

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
accountsstringOptional

Linked Account ID

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

Service type

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

Whether the commitment is expired

Example: false
searchTypestringOptional

Commitment search Type

Example: All, My, AutoSavings
Responses
200
OK
*/*
get
GET /cost/v3/commitment/companies/{companyId}/vendors/aws/services/all/utilizations/time-series/{dateType} HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

OK

{
  "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"
    }
  ]
}

Get category list of AWS commitment utilization

get

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

Authorizations
Path parameters
companyIdstringRequired

Company ID

Example: 1
Query parameters
dateTypestring · enumOptional

Date query type

Example: DAILYPossible values:
startDatestringRequired

Start Date

Example: 2020-10-01
endDatestringRequired

End Date

Example: 2020-10-31
accountsstringOptional

Linked Account ID

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

Service type

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

Whether the commitment is expired

Example: false
searchTypestringOptional

Commitment search Type

Example: All, My, AutoSavings
Responses
200
OK
*/*
get
GET /cost/v3/commitment/companies/{companyId}/vendors/aws/services/all/utilizations/categories HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

OK

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

Get utilization summary of AWS commitment

get

Retrieve aggregated utilization summary for AWS commitment.

Authorizations
Path parameters
companyIdstringRequired

Company ID

Example: 1
Query parameters
dateTypestring · enumOptional

Date query type

Example: DAILYPossible values:
startDatestringRequired

Start Date

Example: 2020-10-01
endDatestringRequired

End Date

Example: 2020-10-31
accountsstringOptional

Linked Account ID

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

Service type

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

Whether the commitment is expired

Example: false
searchTypestringOptional

Commitment search Type

Example: All, My, AutoSavings
Responses
200
OK
*/*
get
GET /cost/v3/commitment/companies/{companyId}/vendors/aws/services/all/utilizations/aggregated HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

OK

{
  "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"
  }
}

Azure Recommendation APIs

Get result list of Azure Reservations recommendation

get

Retrieve results of Azure Reservations recommendations

Authorizations
Path parameters
companyIdstringRequired

Company ID

Example: 1
servicestringRequired
Query parameters
toKRWbooleanOptional

To convert amount data to Korean Won(₩)

Default: false
lookbackPeriodstringRequired

Azure Lookback Period

Example: 30
termstringOptional

Commitment term

Example: P1Y
Responses
200
OK
*/*
get
GET /cost/v3/commitment/companies/{companyId}/vendors/azure/services/{service}/recommendations HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

OK

{
  "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": "$"
    }
  ]
}

Get product type list of Azure Reservations recommendation

get

Retrieve product types targeted by Azure Reservations recommendation

Authorizations
Path parameters
companyIdstringRequired
servicestringRequired
Responses
200
OK
*/*
get
GET /cost/v3/commitment/companies/{companyId}/vendors/azure/services/{service}/recommendations/products HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

OK

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

GCP CUD(Committed Use Discount) Inventory APIs

Get list of GCP CUD(Committed Use Discount) inventory

get

Retrieve Reserved Instance inventory(purchased list).

Authorizations
Path parameters
companyIdstringRequired

Company ID

Example: 1
Query parameters
dateTypestring · enumOptional

Date query type

Example: DAILYPossible values:
startDatestringRequired

Search start Date

Example: 2020-10-01
endDatestringRequired

Search end Date

Example: 2020-10-31
projectsstringOptional

Project IDs

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

CUD types

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

Regions

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

Machine types

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

Products

resourceTypesstringOptional

Resource types

Responses
200
OK
*/*
get
GET /cost/v3/commitment/companies/{companyId}/vendors/gcp/services/cud/inventory HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

OK

{
  "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
    }
  ]
}

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

get

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

Authorizations
Path parameters
companyIdstringRequired

Company ID

Example: 1
Query parameters
dateTypestring · enumOptional

Date query type

Example: DAILYPossible values:
startDatestringRequired

Search start Date

Example: 2020-10-01
endDatestringRequired

Search end Date

Example: 2020-10-31
projectsstringOptional

Project IDs

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

CUD types

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

Regions

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

Machine types

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

Products

resourceTypesstringOptional

Resource types

Responses
200
OK
*/*
get
GET /cost/v3/commitment/companies/{companyId}/vendors/gcp/services/cud/inventory/categories HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

OK

{
  "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)"
      }
    ]
  }
}

GCP CUD(Committed Use Discount) utilization APIs

Get utilization data of GCP CUD(Committed Use Discount)

get

Retrieve utilization data of each GCP CUD(Committed Use Discount).

Authorizations
Path parameters
companyIdstringRequired

Company ID

Example: 1
Query parameters
dateTypestring · enumOptional

Date query type

Example: DAILYPossible values:
startDatestringRequired

Search start Date

Example: 2020-10-01
endDatestringRequired

Search end Date

Example: 2020-10-31
projectsstringOptional

Project IDs

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

CUD types

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

Regions

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

Machine types

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

Products

resourceTypesstringOptional

Resource types

Responses
200
OK
*/*
get
GET /cost/v3/commitment/companies/{companyId}/vendors/gcp/services/cud/utilizations HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

OK

{
  "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"
    }
  ]
}

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

get

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

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
projectsstringOptional

Project IDs

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

CUD types

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

Regions

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

Machine types

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

Products

resourceTypesstringOptional

Resource types

Responses
200
OK
*/*
get
GET /cost/v3/commitment/companies/{companyId}/vendors/gcp/services/cud/utilizations/time-series/{dateType} HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

OK

{
  "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"
    }
  ]
}

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

get

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.

Authorizations
Path parameters
companyIdstringRequired

Company ID

Example: 1
Query parameters
dateTypestring · enumOptional

Date query type

Example: DAILYPossible values:
startDatestringRequired

Search start Date

Example: 2020-10-01
endDatestringRequired

Search end Date

Example: 2020-10-31
projectsstringOptional

Project IDs

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

CUD types

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

Regions

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

Machine types

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

Products

resourceTypesstringOptional

Resource types

Responses
200
OK
*/*
get
GET /cost/v3/commitment/companies/{companyId}/vendors/gcp/services/cud/utilizations/categories HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

OK

{
  "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)"
      }
    ]
  }
}

Get utilization summary of GCP CUD(Committed Use Discount)

get

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

Authorizations
Path parameters
companyIdstringRequired

Company ID

Example: 1
Query parameters
dateTypestring · enumOptional

Date query type

Example: DAILYPossible values:
startDatestringRequired

Search start Date

Example: 2020-10-01
endDatestringRequired

Search end Date

Example: 2020-10-31
projectsstringOptional

Project IDs

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

CUD types

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

Regions

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

Machine types

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

Products

resourceTypesstringOptional

Resource types

Responses
200
OK
*/*
get
GET /cost/v3/commitment/companies/{companyId}/vendors/gcp/services/cud/utilizations/aggregated HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

OK

{
  "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"
  }
}

GCP Coverage APIs

Get coverage data of GCP commitment

get

Retrieve coverage data of each GCP commitment.

Authorizations
Path parameters
companyIdstringRequired

Company ID

Example: 1
Query parameters
dateTypestring · enumOptional

Date query type

Example: DAILYPossible values:
startDatestringRequired

Search start Date

Example: 2020-10-01
endDatestringRequired

Search end Date

Example: 2020-10-31
projectsstringOptional

Project IDs

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

CUD types

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

Regions

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

Machine types

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

Products

resourceTypesstringOptional

Resource types

Responses
200
OK
*/*
get
GET /cost/v3/commitment/companies/{companyId}/vendors/gcp/services/cud/coverages HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

OK

{
  "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"
    }
  ]
}

Get coverage summary trends of GCP commitment

get

Retrieve time-series coverage summary for GCP commitment.

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
projectsstringOptional

Project IDs

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

CUD types

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

Regions

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

Machine types

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

Products

resourceTypesstringOptional

Resource types

Responses
200
OK
*/*
get
GET /cost/v3/commitment/companies/{companyId}/vendors/gcp/services/cud/coverages/time-series/{dateType} HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

OK

{
  "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"
    }
  ]
}

Get category list of GCP commitment coverage

get

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

Authorizations
Path parameters
companyIdstringRequired

Company ID

Example: 1
Query parameters
dateTypestring · enumOptional

Date query type

Example: DAILYPossible values:
startDatestringRequired

Search start Date

Example: 2020-10-01
endDatestringRequired

Search end Date

Example: 2020-10-31
projectsstringOptional

Project IDs

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

CUD types

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

Regions

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

Machine types

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

Products

resourceTypesstringOptional

Resource types

Responses
200
OK
*/*
get
GET /cost/v3/commitment/companies/{companyId}/vendors/gcp/services/cud/coverages/categories HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

OK

{
  "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)"
      }
    ]
  }
}

Get coverage summary of GCP commitment

get

Retrieve aggregated coverage summary for GCP commitment.

Authorizations
Path parameters
companyIdstringRequired

Company ID

Example: 1
Query parameters
dateTypestring · enumOptional

Date query type

Example: DAILYPossible values:
startDatestringRequired

Search start Date

Example: 2020-10-01
endDatestringRequired

Search end Date

Example: 2020-10-31
projectsstringOptional

Project IDs

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

CUD types

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

Regions

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

Machine types

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

Products

resourceTypesstringOptional

Resource types

Responses
200
OK
*/*
get
GET /cost/v3/commitment/companies/{companyId}/vendors/gcp/services/cud/coverages/aggregated HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

OK

{
  "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
  }
}

GCP Recommendation APIs

Get result list of GCP CUD recommendation

get

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

Authorizations
Path parameters
companyIdstringRequired

Company ID

Example: 1
servicestringRequired
Responses
200
OK
*/*
get
GET /cost/v3/commitment/companies/{companyId}/vendors/gcp/services/{service}/recommendations HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

OK

{
  "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
    }
  ]
}

Get purchase option information of GCP CUD recommendation

get

Retrieve the cost information based on GCP(Google Cloud Platform) CUD(Committed Use Discounts) purchase options and their corresponding purchase outcomes.

Authorizations
Path parameters
companyIdstringRequired

Company ID

Example: 1
servicestringRequired
Responses
200
OK
*/*
get
GET /cost/v3/commitment/companies/{companyId}/vendors/gcp/services/{service}/recommendations/purchase-options HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

OK

{
  "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
    }
  ]
}

Get product type list of GCP CUD recommendation

get

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

Authorizations
Path parameters
companyIdstringRequired
servicestringRequired
Responses
200
OK
*/*
get
GET /cost/v3/commitment/companies/{companyId}/vendors/gcp/services/{service}/recommendations/products HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

OK

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

Last updated