IBM Cloud Usage Reports - IBM Cloud API Docs

Introduction

Last updated: 2020-09-30

The IBM Cloud® Usage Reports API provides details about the usage quantity and cost of resources in an account. Usage details are reported by the month in which they were incurred. Usage quantities and their corresponding costs are aggregated at the following levels:

Individual resource instances
Cloud Foundry organization or resource group
Entire account (all resources)

Endpoint

You access the Usage Reports API by sending requests to the https://billing.cloud.ibm.com endpoint.

Error handling

This API uses standard HTTP response codes to indicate whether a method completed successfully. A 200 response always indicates success. A 400 type response is some sort of failure, and a 500 type response usually indicates an internal system error.

Authentication

Access to the Usage Reporting API is enforced through both IBM Cloud Identity and Access Management (IAM) access tokens and Cloud Foundry access roles. For more information, see Managing access in IBM Cloud.

To work with the API, authenticate your app or service by including your IBM Cloud IAM access token in the API request authentication header:

-H 'Authorization: Bearer <IAM_TOKEN>'

You can retrieve an access token by first creating an API key, and then exchanging your API key for a IBM Cloud IAM token. For more information, see Getting an IBM Cloud IAM token by using an API key.

Event tracking

You can monitor API activity within your account by using the IBM Cloud Activity Tracker with LogDNA service. When an API method is called, an event is generated that you can then track and audit from within Activity Tracker with LogDNA. The specific event type is listed for each individual method. For more information about how to track Account and Billing activity, see Auditing events for account management.

Get account summary

Returns the summary for the account for a given month. Account billing managers are authorized to access this report.

GET /v4/accounts/{account_id}/summary/{billingmonth}

/v4/accounts/{account_id}/summary/{billingmonth}

(usageReports *UsageReportsV4) GetAccountSummary(getAccountSummaryOptions *GetAccountSummaryOptions) (result *AccountSummary, response *core.DetailedResponse, err error)

(usageReports *UsageReportsV4) GetAccountSummary(getAccountSummaryOptions *GetAccountSummaryOptions) (result *AccountSummary, response *core.DetailedResponse, err error)

(usageReports *UsageReportsV4) GetAccountSummaryWithContext(ctx context.Context, getAccountSummaryOptions *GetAccountSummaryOptions) (result *AccountSummary, response *core.DetailedResponse, err error)

(usageReports *UsageReportsV4) GetAccountSummaryWithContext(ctx context.Context, getAccountSummaryOptions *GetAccountSummaryOptions) (result *AccountSummary, response *core.DetailedResponse, err error)

ServiceCall<AccountSummary> getAccountSummary(GetAccountSummaryOptions getAccountSummaryOptions)
ServiceCall<AccountSummary> getAccountSummary(GetAccountSummaryOptions getAccountSummaryOptions)

getAccountSummary(params)

getAccountSummary(params)

get_account_summary(self,
        account_id: str,
        billingmonth: str,
        **kwargs
    ) -> DetailedResponse

get_account_summary(self,
        account_id: str,
        billingmonth: str,
        **kwargs
    ) -> DetailedResponse

Request

Instantiate the GetAccountSummaryOptions struct and set the fields to provide parameter values for the GetAccountSummary method.

Use the GetAccountSummaryOptions.Builder to create a GetAccountSummaryOptions object that contains the parameter values for the getAccountSummary method.

Path Parameters

account_id
string
Account ID for which the usage report is requested
billingmonth
string
The billing month for which the usage report is requested. Format is yyyy-mm.

Constraints: Value must match regular expression ^\d{4}\-(0?[1-9]|1[012])$

parameter

WithContext method only

GetAccountSummaryOptions

The GetAccountSummary options.

GetAccountSummaryOptions

The getAccountSummary options.

parameters

accountId
string
Account ID for which the usage report is requested.
billingmonth
string
The billing month for which the usage report is requested. Format is yyyy-mm.

Constraints: Value must match regular expression /^\\d{4}\\-(0?[1-9]|1[012])$/

parameters

account_id
str
Account ID for which the usage report is requested.
billingmonth
str
The billing month for which the usage report is requested. Format is yyyy-mm.

Constraints: Value must match regular expression /^\\d{4}\\-(0?[1-9]|1[012])$/

curl -X GET -H "Authorization: {iam_token}" -H "Accept: application/json" "{base_url}/v4/accounts/{account_id}/summary/{billingmonth}"

getAccountSummaryOptions := usageReportsService.NewGetAccountSummaryOptions( accountID, billingMonth, ) accountSummary, response, err := usageReportsService.GetAccountSummary(getAccountSummaryOptions) if err != nil { panic(err) } b, _ := json.MarshalIndent(accountSummary, "", " ") fmt.Println(string(b))

GetAccountSummaryOptions getAccountSummaryOptions = new GetAccountSummaryOptions.Builder() .accountId(accountId) .billingmonth(billingMonth) .build(); Response<AccountSummary> response = service.getAccountSummary(getAccountSummaryOptions).execute(); AccountSummary accountSummary = response.getResult(); System.out.println("getAccountSummary() result:\n" + accountSummary.toString());

const params = { accountId: accountId, billingmonth: billingMonth, }; usageReportsService.getAccountSummary(params) .then(res => { console.log(JSON.stringify(res.result, null, 2)); }) .catch(err => { console.warn(err) });

account_summary = usage_reports_service.get_account_summary( account_id=account_id, billingmonth=billing_month ).get_result() print(json.dumps(account_summary, indent=2))