AutoSavings

AutoSavings Account APIs

Integrated(User & AutoSavings) Coverage APIs

Integrated(User & AutoSavings) Inventory APIs

Integrated(User & AutoSavings) Utilization APIs

PreviousResources NextCommitment

Last updated 3 months ago

Was this helpful?

Get AutoSavings account List

Retrieve information about the AWS account registered with the company.

get

/cost/v3/autosave/companies/{companyId}/vendors/aws/services/accounts

Authorizations

Path parameters

companyIdstringrequired

Company ID

Example: 1

Query parameters

browserTimeZonestring

Browser Timezone

Example: +09:00

linkedAccountIdstring

Linked Account ID

Example: '123456789011'

linkedAccountAliasstring

Linked Account Name

Example: 'Alias equals name'

accessTypestring

AutoSavings AWS account access type

Example: 'role-arn / access-key '

roleArnstring

roleArn

Example: 'roleArn'

accessKeystring

secretKeystring

tokenstring

startDatestring

endDatestring

siteRegionstring

siteRegion

Example: 'GLOBAL / CHINA'

servicesstring

AutoSavings services subscribed to by the account

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

encryptKeystring

subscriptionStatusstring

Current AutoSavings subscription status of the account

Example: 'SUBSCRIBED'

Responses

*/*

cURL

JavaScript

Python

HTTP

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

200

{
  "status": "text",
  "error": {
    "Code": 1,
    "Message": "text"
  },
  "roleArnInfo": {
    "cloudFormationTemplateUrl": "text",
    "externalId": "text"
  },
  "data": {
    "siteRegion": "text"
  },
  "list": [
    {
      "companyId": "1",
      "linkedAccountId": "123456789012",
      "linkedAccountAlias": "Bespinglobal Platform",
      "accessType": "role-arn",
      "roleArn": "aws:arn:123456:api",
      "siteRegion": "GLOBAL",
      "deleteYn": "0:false / 1:true",
      "createDate": "'%Y-%m-%d %H:%i:%s'",
      "createUser": "user",
      "updateDate": "'%Y-%m-%d %H:%i:%s'",
      "updateUser": "user"
    }
  ]
}

Get AutoSavings Account Subscription Histories

Retrieve AWS AutoSavings subscription histories

get

/cost/v3/autosave/companies/{companyId}/vendors/aws/services/accounts/subscription/histories

Authorizations

Path parameters

companyIdstringrequired

Company ID

Example: 1

Query parameters

browserTimeZonestring

Browser Timezone

Example: +09:00

linkedAccountIdstring

Linked Account ID

Example: '123456789011'

linkedAccountAliasstring

Linked Account Name

Example: 'Alias equals name'

accessTypestring

AutoSavings AWS account access type

Example: 'role-arn / access-key '

roleArnstring

roleArn

Example: 'roleArn'

accessKeystring

secretKeystring

tokenstring

startDatestring

endDatestring

siteRegionstring

siteRegion

Example: 'GLOBAL / CHINA'

servicesstring

AutoSavings services subscribed to by the account

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

encryptKeystring

subscriptionStatusstring

Current AutoSavings subscription status of the account

Example: 'SUBSCRIBED'

latestboolean · default: true

View the latest subscription information by account

Responses

*/*

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.opsnow.io/cost/v3/autosave/companies/{companyId}/vendors/aws/services/accounts/subscription/histories' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

{
  "list": [
    {
      "linkedAccountId": "text",
      "payerAccountId": "text",
      "autoSavingsService": "text",
      "subscriptionStatus": "text",
      "startDateTime": "text",
      "cancelDateTime": "text",
      "endDateTime": "text"
    }
  ]
}

Get AutoSavings Account State

Retrieve registered AWS AutoSavings accounts state

get

/cost/v3/autosave/companies/{companyId}/vendors/aws/services/accounts/state

Authorizations

Path parameters

companyIdstringrequired

Company ID

Example: 1

Query parameters

browserTimeZonestring

Browser Timezone

Example: +09:00

linkedAccountIdstring

Linked Account ID

Example: '123456789011'

linkedAccountAliasstring

Linked Account Name

Example: 'Alias equals name'

accessTypestring

AutoSavings AWS account access type

Example: 'role-arn / access-key '

roleArnstring

roleArn

Example: 'roleArn'

accessKeystring

secretKeystring

tokenstring

startDatestring

endDatestring

siteRegionstring

siteRegion

Example: 'GLOBAL / CHINA'

servicesstring

AutoSavings services subscribed to by the account

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

encryptKeystring

subscriptionStatusstring

Current AutoSavings subscription status of the account

Example: 'SUBSCRIBED'

Responses

*/*

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.opsnow.io/cost/v3/autosave/companies/{companyId}/vendors/aws/services/accounts/state' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

{
  "status": "text",
  "error": {
    "Code": 1,
    "Message": "text"
  },
  "data": {
    "totalCount": 1,
    "subscriptionCount": 1,
    "savingsCost": 1,
    "monthlyEstimateCost": 1,
    "state": "NONE",
    "accounts": [
      {
        "linkedAccountId": "text",
        "linkedAccountName": "text",
        "autoRiSubscribed": true,
        "autoSpSubscribed": true,
        "subscribed": true,
        "purchase": true,
        "estimatedCost": 1,
        "accountStatus": "text"
      }
    ]
  }
}

Get AutoSavings account AWS role ARN Info

Retrieve the necessary information for AWS cross-account registration.

get

/cost/v3/autosave/companies/{companyId}/vendors/aws/services/accounts/role-arn

Authorizations

Path parameters

companyIdstringrequired

Company ID

Example: 1

Query parameters

browserTimeZonestring

Browser Timezone

Example: +09:00

linkedAccountIdstring

Linked Account ID

Example: '123456789011'

linkedAccountAliasstring

Linked Account Name

Example: 'Alias equals name'

accessTypestring

AutoSavings AWS account access type

Example: 'role-arn / access-key '

roleArnstring

roleArn

Example: 'roleArn'

accessKeystring

secretKeystring

tokenstring

startDatestring

endDatestring

siteRegionstring

siteRegion

Example: 'GLOBAL / CHINA'

servicesstring

AutoSavings services subscribed to by the account

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

encryptKeystring

subscriptionStatusstring

Current AutoSavings subscription status of the account

Example: 'SUBSCRIBED'

Responses

*/*

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.opsnow.io/cost/v3/autosave/companies/{companyId}/vendors/aws/services/accounts/role-arn' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

{
  "status": "text",
  "error": {
    "Code": 1,
    "Message": "text"
  },
  "roleArnInfo": {
    "cloudFormationTemplateUrl": "text",
    "externalId": "text"
  },
  "data": {
    "siteRegion": "text"
  },
  "list": [
    {
      "companyId": "1",
      "linkedAccountId": "123456789012",
      "linkedAccountAlias": "Bespinglobal Platform",
      "accessType": "role-arn",
      "roleArn": "aws:arn:123456:api",
      "siteRegion": "GLOBAL",
      "deleteYn": "0:false / 1:true",
      "createDate": "'%Y-%m-%d %H:%i:%s'",
      "createUser": "user",
      "updateDate": "'%Y-%m-%d %H:%i:%s'",
      "updateUser": "user"
    }
  ]
}

Get AutoSavings Site Region

Retrieve Information about customer sites utilizing AWS AutoSavings.

get

/cost/v3/autosave/companies/{companyId}/vendors/aws/services/accounts/region

Authorizations

Path parameters

companyIdstringrequired

Company ID

Example: 1

Query parameters

browserTimeZonestring

Browser Timezone

Example: +09:00

linkedAccountIdstring

Linked Account ID

Example: '123456789011'

linkedAccountAliasstring

Linked Account Name

Example: 'Alias equals name'

accessTypestring

AutoSavings AWS account access type

Example: 'role-arn / access-key '

roleArnstring

roleArn

Example: 'roleArn'

accessKeystring

secretKeystring

tokenstring

startDatestring

endDatestring

siteRegionstring

siteRegion

Example: 'GLOBAL / CHINA'

servicesstring

AutoSavings services subscribed to by the account

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

encryptKeystring

subscriptionStatusstring

Current AutoSavings subscription status of the account

Example: 'SUBSCRIBED'

Responses

*/*

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.opsnow.io/cost/v3/autosave/companies/{companyId}/vendors/aws/services/accounts/region' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

{
  "status": "text",
  "error": {
    "Code": 1,
    "Message": "text"
  },
  "roleArnInfo": {
    "cloudFormationTemplateUrl": "text",
    "externalId": "text"
  },
  "data": {
    "siteRegion": "text"
  },
  "list": [
    {
      "companyId": "1",
      "linkedAccountId": "123456789012",
      "linkedAccountAlias": "Bespinglobal Platform",
      "accessType": "role-arn",
      "roleArn": "aws:arn:123456:api",
      "siteRegion": "GLOBAL",
      "deleteYn": "0:false / 1:true",
      "createDate": "'%Y-%m-%d %H:%i:%s'",
      "createUser": "user",
      "updateDate": "'%Y-%m-%d %H:%i:%s'",
      "updateUser": "user"
    }
  ]
}

Get Savings Plans List

Get Coverage List

get

/cost/v3/autosave/companies/{companyId}/vendors/aws/services/integration/coverages

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']

autoRiYnstring

If retrieve only AutoRI or not

searchTypestring

Search type

Example: All, My, AutoSavings

commitmentServicestring

AWS commitment service type

Example: all, savings-plans, reserved-instance

Responses

*/*

cURL

JavaScript

Python

HTTP

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

200

{
  "status": "text",
  "error": {
    "Code": 1,
    "Message": "text"
  },
  "list": [
    {
      "reservedInstanceCoverageRate": 1,
      "savingsPlansCoverageRate": 1,
      "autoRiCoverageRate": 1,
      "autoSpCoverageRate": 1,
      "onDemandCoverageRate": 1,
      "reservedInstanceOnDemandCostEquivalent": 1,
      "savingsPlansOnDemandCostEquivalent": 1,
      "autoRiOnDemandCostEquivalent": 1,
      "autoSpOnDemandCostEquivalent": 1,
      "onDemandCost": 1,
      "totalOnDemandCostEquivalent": 1,
      "reservedInstanceNormalizeFactorAmount": 1,
      "savingsPlansNormalizeFactorAmount": 1,
      "autoRiNormalizeFactorAmount": 1,
      "autoSpNormalizeFactorAmount": 1,
      "onDemandNormalizeFactorAmount": 1,
      "totalNormalizeFactorAmount": 1,
      "reservedInstanceAmount": 1,
      "savingsPlansAmount": 1,
      "autoRiAmount": 1,
      "autoSpAmount": 1,
      "onDemandAmount": 1,
      "totalAmount": 1,
      "linkedAccountId": "123456789011",
      "linkedAccountAlias": "Service Platform",
      "productCode": "AmazonEC2",
      "productName": "EC2",
      "platform": "Linux",
      "instanceType": "c4.xlarge",
      "instanceSize": "c4.xlarge",
      "tenancy": "Shared",
      "regionCode": "ap-northeast-2",
      "regionName": "Asia Pacific (Seoul)"
    }
  ]
}

Get Savings Plans Total Transition

Get Coverage Total Transition

get

/cost/v3/autosave/companies/{companyId}/vendors/aws/services/integration/coverages/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']

autoRiYnstring

If retrieve only AutoRI or not

searchTypestring

Search type

Example: All, My, AutoSavings

commitmentServicestring

AWS commitment service type

Example: all, savings-plans, reserved-instance

Responses

*/*

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.opsnow.io/cost/v3/autosave/companies/{companyId}/vendors/aws/services/integration/coverages/time-series/{dateType}?startDate=2020-10-01&endDate=2020-10-31' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

{
  "status": "text",
  "error": {
    "Code": 1,
    "Message": "text"
  },
  "list": [
    {
      "reservedInstanceCoverageRate": 1,
      "savingsPlansCoverageRate": 1,
      "autoRiCoverageRate": 1,
      "autoSpCoverageRate": 1,
      "onDemandCoverageRate": 1,
      "reservedInstanceOnDemandCostEquivalent": 1,
      "savingsPlansOnDemandCostEquivalent": 1,
      "autoRiOnDemandCostEquivalent": 1,
      "autoSpOnDemandCostEquivalent": 1,
      "onDemandCost": 1,
      "totalOnDemandCostEquivalent": 1,
      "reservedInstanceNormalizeFactorAmount": 1,
      "savingsPlansNormalizeFactorAmount": 1,
      "autoRiNormalizeFactorAmount": 1,
      "autoSpNormalizeFactorAmount": 1,
      "onDemandNormalizeFactorAmount": 1,
      "totalNormalizeFactorAmount": 1,
      "reservedInstanceAmount": 1,
      "savingsPlansAmount": 1,
      "autoRiAmount": 1,
      "autoSpAmount": 1,
      "onDemandAmount": 1,
      "totalAmount": 1,
      "usageDate": "2020-07-01"
    }
  ]
}

Get Savings Plans Filter

Get Coverage Filter

get

/cost/v3/autosave/companies/{companyId}/vendors/aws/services/integration/coverages/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']

autoRiYnstring

If retrieve only AutoRI or not

searchTypestring

Search type

Example: All, My, AutoSavings

commitmentServicestring

AWS commitment service type

Example: all, savings-plans, reserved-instance

Responses

*/*

cURL

JavaScript

Python

HTTP

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

200

{
  "status": "text",
  "error": {
    "Code": 1,
    "Message": "text"
  },
  "data": {
    "accounts": "['123456789011', '123456789012']",
    "products": "[ {'code':'EC2InstanceReserved', 'value':'EC2 Instance'} ]",
    "regions": "[ {'code':'EC2InstanceReserved', 'value':'EC2 Instance'} ]",
    "instanceTypes": "[ 't2.micro', 'm4.xlarge' ]",
    "opsNowProducts": "[ 'SELF', 'AUTO-RI']"
  }
}

Get Savings Plans total summary

Get Coverage Total summary

get

/cost/v3/autosave/companies/{companyId}/vendors/aws/services/integration/coverages/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']

autoRiYnstring

If retrieve only AutoRI or not

searchTypestring

Search type

Example: All, My, AutoSavings

commitmentServicestring

AWS commitment service type

Example: all, savings-plans, reserved-instance

Responses

*/*

cURL

JavaScript

Python

HTTP

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

200

{
  "status": "text",
  "error": {
    "Code": 1,
    "Message": "text"
  },
  "data": {
    "reservedInstanceCoverageRate": 1,
    "savingsPlansCoverageRate": 1,
    "autoRiCoverageRate": 1,
    "autoSpCoverageRate": 1,
    "onDemandCoverageRate": 1,
    "reservedInstanceOnDemandCostEquivalent": 1,
    "savingsPlansOnDemandCostEquivalent": 1,
    "autoRiOnDemandCostEquivalent": 1,
    "autoSpOnDemandCostEquivalent": 1,
    "onDemandCost": 1,
    "totalOnDemandCostEquivalent": 1,
    "reservedInstanceNormalizeFactorAmount": 1,
    "savingsPlansNormalizeFactorAmount": 1,
    "autoRiNormalizeFactorAmount": 1,
    "autoSpNormalizeFactorAmount": 1,
    "onDemandNormalizeFactorAmount": 1,
    "totalNormalizeFactorAmount": 1,
    "reservedInstanceAmount": 1,
    "savingsPlansAmount": 1,
    "autoRiAmount": 1,
    "autoSpAmount": 1,
    "onDemandAmount": 1,
    "totalAmount": 1
  }
}

Get My Inventory List

get

/cost/v3/autosave/companies/{companyId}/vendors/aws/services/integration/inventory/my-list

Authorizations

Path parameters

companyIdstringrequired

Company ID

Example: 1

Query parameters

dateTypestring · enum

Date query type

Example: DAILY

Options: {DAILY, MONTHLY}

startDatestringrequired

Start Date

Example: 2023-10-01

endDatestringrequired

End Date

Example: 2023-10-31

accountsstring

Linked Account ID

Example: ['123456789011', '123456789012']

productsstring

Products

Example: ['EC2InstanceReserved', 'ComputeReserved']

regionsstring

Regions

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

instanceTypesstring

Instance types

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

opsnowProductCodesstring

OpsNow RI Purchase types

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

searchTypestring

Search type

Example: All, My, AutoSavings

Responses

*/*

cURL

JavaScript

Python

HTTP

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

200

{
  "status": "text",
  "error": {
    "Code": 1,
    "Message": "text"
  },
  "list": [
    {
      "inventoryId": "3118c6a8-7fc3-4b5d-8b53-a82fbe6f3169",
      "linkedAccountId": "123456789012",
      "linkedAccountAlias": "Bespinglobal Platform",
      "productCode": "AmazonEC2",
      "productName": "EC2",
      "instanceType": "c4.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",
      "operationName": "RunInstances",
      "status": "active",
      "arn": "arn:aws:rds:ap-northeast-2:249145062117:ri:ri-2020-05-15-05-12-58-377",
      "hourlyCommitmentCost": 100,
      "upfrontFee": 777,
      "recurringFee": 777
    }
  ]
}

Get Savings Plans Inventory List

get

/cost/v3/autosave/companies/{companyId}/vendors/aws/services/integration/inventory/list

Authorizations

Path parameters

companyIdstringrequired

Company ID

Example: 1

Query parameters

dateTypestring · enum

Date query type

Example: DAILY

Options: {DAILY, MONTHLY}

startDatestringrequired

Start Date

Example: 2023-10-01

endDatestringrequired

End Date

Example: 2023-10-31

accountsstring

Linked Account ID

Example: ['123456789011', '123456789012']

productsstring

Products

Example: ['EC2InstanceReserved', 'ComputeReserved']

regionsstring

Regions

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

instanceTypesstring

Instance types

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

opsnowProductCodesstring

OpsNow RI Purchase types

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

searchTypestring

Search type

Example: All, My, AutoSavings

Responses

*/*

cURL

JavaScript

Python

HTTP

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

200

{
  "status": "text",
  "error": {
    "Code": 1,
    "Message": "text"
  },
  "list": [
    {
      "inventoryId": "3118c6a8-7fc3-4b5d-8b53-a82fbe6f3169",
      "linkedAccountId": "123456789012",
      "linkedAccountAlias": "Bespinglobal Platform",
      "productCode": "AmazonEC2",
      "productName": "EC2",
      "instanceType": "c4.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",
      "operationName": "RunInstances",
      "status": "active",
      "arn": "arn:aws:rds:ap-northeast-2:249145062117:ri:ri-2020-05-15-05-12-58-377",
      "hourlyCommitmentCost": 100,
      "upfrontFee": 777,
      "recurringFee": 777
    }
  ]
}

Get AutoSavings Inventory List

get

/cost/v3/autosave/companies/{companyId}/vendors/aws/services/integration/inventory/auto-list

Authorizations

Path parameters

companyIdstringrequired

Company ID

Example: 1

Query parameters

dateTypestring · enum

Date query type

Example: DAILY

Options: {DAILY, MONTHLY}

startDatestringrequired

Start Date

Example: 2023-10-01

endDatestringrequired

End Date

Example: 2023-10-31

accountsstring

Linked Account ID

Example: ['123456789011', '123456789012']

productsstring

Products

Example: ['EC2InstanceReserved', 'ComputeReserved']

regionsstring

Regions

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

instanceTypesstring

Instance types

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

opsnowProductCodesstring

OpsNow RI Purchase types

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

searchTypestring

Search type

Example: All, My, AutoSavings

Responses

*/*

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.opsnow.io/cost/v3/autosave/companies/{companyId}/vendors/aws/services/integration/inventory/auto-list?startDate=2023-10-01&endDate=2023-10-31' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

{
  "status": "text",
  "error": {
    "Code": 1,
    "Message": "text"
  },
  "list": [
    {
      "inventoryId": "3118c6a8-7fc3-4b5d-8b53-a82fbe6f3169",
      "linkedAccountId": "123456789012",
      "linkedAccountAlias": "Bespinglobal Platform",
      "productCode": "AmazonEC2",
      "productName": "EC2",
      "instanceType": "c4.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",
      "operationName": "RunInstances",
      "status": "active",
      "arn": "arn:aws:rds:ap-northeast-2:249145062117:ri:ri-2020-05-15-05-12-58-377",
      "hourlyCommitmentCost": 100,
      "upfrontFee": 777,
      "recurringFee": 777
    }
  ]
}

Get Agreement Utilization List

get

/cost/v3/autosave/companies/{companyId}/vendors/aws/services/integration/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: 2023-10-01

endDatestringrequired

End Date

Example: 2023-10-31

accountsstring

Linked Account ID

Example: ['123456789011', '123456789012']

productsstring

Products

Example: ['EC2InstanceReserved', 'ComputeReserved']

regionsstring

Regions

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

instanceTypesstring

Instance types

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

opsnowProductCodesstring

OpsNow RI Purchase types

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

searchTypestring

Search type

Example: All, My, AutoSavings

Responses

*/*

cURL

JavaScript

Python

HTTP

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

200

{
  "status": "text",
  "error": {
    "Code": 1,
    "Message": "text"
  },
  "list": [
    {
      "utilization": 78.15,
      "commitmentCost": 2880,
      "usedCommitmentCost": 3690.19,
      "netSavingsCost": 810.19,
      "usedCommitmentCostOnDemandEquivalent": 1,
      "netSavingsRate": 28.13,
      "opsNowProduct": "AUTO-RI",
      "inventoryId": "ri-2020-03-27-04-12-02-595",
      "inventoryArn": "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",
      "regionCode": "ap-northeast-2",
      "regionName": "Asia Pacific (Seoul)",
      "purchaseOption": "All Upfront",
      "startDate": "2025-02-23T05:47:05.107Z",
      "endDate": "2025-02-23T05:47:05.107Z"
    }
  ]
}

Get Total Transition

Get Utilization Total Transition

get

/cost/v3/autosave/companies/{companyId}/vendors/aws/services/integration/utilizations/time-series/{dateType}

Authorizations

Path parameters

companyIdstringrequired

Company ID

Example: 1

dateTypestringrequired

Date query type

Example: DAILY

Query parameters

startDatestringrequired

Start Date

Example: 2023-10-01

endDatestringrequired

End Date

Example: 2023-10-31

accountsstring

Linked Account ID

Example: ['123456789011', '123456789012']

productsstring

Products

Example: ['EC2InstanceReserved', 'ComputeReserved']

regionsstring

Regions

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

instanceTypesstring

Instance types

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

opsnowProductCodesstring

OpsNow RI Purchase types

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

searchTypestring

Search type

Example: All, My, AutoSavings

Responses

*/*

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.opsnow.io/cost/v3/autosave/companies/{companyId}/vendors/aws/services/integration/utilizations/time-series/{dateType}?startDate=2023-10-01&endDate=2023-10-31' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

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

Overview Monthly Overview Savings

get

/cost/v3/autosave/companies/{companyId}/vendors/aws/services/integration/utilizations/overview-savings

Authorizations

Path parameters

companyIdstringrequired

Company ID

Query parameters

startDatestring

Search start date

endDatestring

Search end date

Responses

*/*

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.opsnow.io/cost/v3/autosave/companies/{companyId}/vendors/aws/services/integration/utilizations/overview-savings' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

{
  "status": "text",
  "error": {
    "Code": 1,
    "Message": "text"
  },
  "state": {
    "totalCount": 1,
    "subscriptionCount": 1,
    "savingsCost": 1,
    "monthlyEstimateCost": 1,
    "state": "NONE",
    "accounts": [
      {
        "linkedAccountId": "text",
        "linkedAccountName": "text",
        "autoRiSubscribed": true,
        "autoSpSubscribed": true,
        "subscribed": true,
        "purchase": true,
        "estimatedCost": 1,
        "accountStatus": "text"
      }
    ]
  },
  "lastMonthNetSavings": {
    "yearMonth": "text",
    "lastDay": "Service Platform",
    "totalSavingCost": 1,
    "autoSavingCost": 1,
    "mySavingCost": 1,
    "estimatedCost": 1,
    "estimatedAutoSavingCost": 1,
    "estimatedMySavingCost": 1,
    "savingsCostComparedPreviousMonth": 1,
    "savingsRateComparedPreviousMonth": 1
  },
  "list": [
    {
      "yearMonth": "text",
      "lastDay": "Service Platform",
      "totalSavingCost": 1,
      "autoSavingCost": 1,
      "mySavingCost": 1,
      "estimatedCost": 1,
      "estimatedAutoSavingCost": 1,
      "estimatedMySavingCost": 1,
      "savingsCostComparedPreviousMonth": 1,
      "savingsRateComparedPreviousMonth": 1
    }
  ]
}

Get Filter

Get Utilization Filter

get

/cost/v3/autosave/companies/{companyId}/vendors/aws/services/integration/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: 2023-10-01

endDatestringrequired

End Date

Example: 2023-10-31

accountsstring

Linked Account ID

Example: ['123456789011', '123456789012']

productsstring

Products

Example: ['EC2InstanceReserved', 'ComputeReserved']

regionsstring

Regions

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

instanceTypesstring

Instance types

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

opsnowProductCodesstring

OpsNow RI Purchase types

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

searchTypestring

Search type

Example: All, My, AutoSavings

Responses

*/*

cURL

JavaScript

Python

HTTP

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

200

{
  "status": "text",
  "error": {
    "Code": 1,
    "Message": "text"
  },
  "data": {
    "accounts": "['123456789011', '123456789012']",
    "products": "[ {'code':'EC2InstanceReserved', 'value':'EC2 Instance'} ]",
    "regions": "[ {'code':'EC2InstanceReserved', 'value':'EC2 Instance'} ]",
    "instanceTypes": "[ 't2.micro', 'm4.xlarge' ]",
    "opsNowProducts": "[ 'SELF', 'AUTO-RI']"
  }
}

Get total summary

Get Utilization Total summary

get

/cost/v3/autosave/companies/{companyId}/vendors/aws/services/integration/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: 2023-10-01

endDatestringrequired

End Date

Example: 2023-10-31

accountsstring

Linked Account ID

Example: ['123456789011', '123456789012']

productsstring

Products

Example: ['EC2InstanceReserved', 'ComputeReserved']

regionsstring

Regions

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

instanceTypesstring

Instance types

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

opsnowProductCodesstring

OpsNow RI Purchase types

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

searchTypestring

Search type

Example: All, My, AutoSavings

Responses

*/*

cURL

JavaScript

Python

HTTP

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

200

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