// This is an automatically generated code sample.
// To make this code sample work in your Oracle Cloud tenancy,
// please replace the values for any parameters whose current values do not fit
// your use case (such as resource IDs, strings containing ‘EXAMPLE’ or ‘unique_id’, and
// boolean, number, and enum parameters with values not fitting your use case).
import * as usageapi from "oci-usageapi";
import common = require("oci-common");
// Create a default authentication provider that uses the DEFAULT
// profile in the configuration file.
// Refer to <see href="https://docs.cloud.oracle.com/en-us/iaas/Content/API/Concepts/sdkconfig.htm#SDK_and_CLI_Configuration_File>the public documentation</see> on how to prepare a configuration file.
const provider: common.ConfigFileAuthenticationDetailsProvider = new common.ConfigFileAuthenticationDetailsProvider();
(async () => {
try {
// Create a service client
const client = new usageapi.UsageapiClient({ authenticationDetailsProvider: provider });
// Create a request and dependent object(s).
const createUsageCarbonEmissionsQueryDetails = {
compartmentId: "ocid1.test.oc1..<unique_ID>EXAMPLE-compartmentId-Value",
queryDefinition: {
displayName: "EXAMPLE-displayName-Value",
reportQuery: {
tenantId: "ocid1.test.oc1..<unique_ID>EXAMPLE-tenantId-Value",
timeUsageStarted: new Date("Mon Oct 25 03:55:51 UTC 2049"),
timeUsageEnded: new Date("Sat Jul 09 15:13:12 UTC 2022"),
emissionCalculationMethod: usageapi.models.RequestUsageCarbonEmissionsDetails.EmissionCalculationMethod.SpendBased,
emissionType: usageapi.models.RequestUsageCarbonEmissionsDetails.EmissionType.LocationBased,
granularity: usageapi.models.RequestUsageCarbonEmissionsDetails.Granularity.Monthly,
isAggregateByTime: false,
groupBy: ["EXAMPLE--Value" ],
groupByTag: [{
namespace: "EXAMPLE-namespace-Value",
key: "EXAMPLE-key-Value",
value: "EXAMPLE-value-Value",
}
],
compartmentDepth: 4,
filter: {
operator: usageapi.models.Filter.Operator.Or,
dimensions: [{
key: "EXAMPLE-key-Value",
value: "EXAMPLE-value-Value",
}
],
tags: [{
namespace: "EXAMPLE-namespace-Value",
key: "EXAMPLE-key-Value",
value: "EXAMPLE-value-Value",
}
],
}
,
dateRangeName: usageapi.models.UsageCarbonEmissionsReportQuery.DateRangeName.LastTwoMonths,
}
,
costAnalysisUI: {
graph: usageapi.models.CostAnalysisUI.Graph.StackedLines,
isCumulativeGraph: true,
}
,
version: 1308,
}
,
}
const createUsageCarbonEmissionsQueryRequest: usageapi.requests.CreateUsageCarbonEmissionsQueryRequest = {
createUsageCarbonEmissionsQueryDetails: createUsageCarbonEmissionsQueryDetails,
opcRequestId: "ET2TYJVM7PVBFW8UCGUC<unique_ID>",
opcRetryToken: "EXAMPLE-opcRetryToken-Value",
};
// Send request to the Client.
const createUsageCarbonEmissionsQueryResponse = await client.createUsageCarbonEmissionsQuery(createUsageCarbonEmissionsQueryRequest);
}
catch (error) {
console.log("createUsageCarbonEmissionsQuery Failed with error " + error);
}
})();