Crea un proceso de consulta dentro del Explorador de Costos para los parámetros especificados. Se devuelve un token que permite consultar el estado de la consulta y, eventualmente, obtener los resultados.
Parámetros de ruta
-
Cadena 24hexadecimal única que identifica la organización que contiene sus proyectos. Utilice el
/orgspunto de conexión para recuperar todas las organizaciones a las que el usuario autenticado tiene acceso.El formato debe coincidir con el siguiente patrón:
^([a-f0-9]{24})$.
Parámetros de consulta
-
Indicador que indica si la aplicación encapsula la respuesta en un objeto JSON
envelope. Algunos clientes de la API no pueden acceder a los encabezados de respuesta HTTP ni al código de estado. Para solucionar esto, configure envelope=true en la consulta. Los endpoints que devuelven una lista de resultados utilizan el objeto de resultados como encapsulado. La aplicación añade el parámetro de estado al cuerpo de la respuesta.El valor predeterminado es
false.
Cuerpo
Requerido
Parámetros de filtro para la consulta del Explorador de costos.
-
La lista de clústeres que se incluirán en la consulta del Explorador de costos.
El formato de cada uno debe coincidir con el siguiente patrón:
^([a-f0-9]{24})$. -
Fecha de finalización exclusiva de la consulta del Explorador de Costos. Debe ser el inicio de un mes.
-
La dimensión por la que se agruparán los resultados de uso devueltos. Se debe proporcionar al menos un valor de filtro para que se utilice una dimensión.
Los valores son
organizations,projects,clustersoservices. -
Marca para controlar si se incluye en la respuesta el uso que coincide con los criterios de filtro, pero que no tiene valores para todos ellos. El valor predeterminado es falso, lo que excluye los datos que coinciden parcialmente.
-
La lista de organizaciones que se incluirán en la query Cost Explorer.
El formato de cada uno debe coincidir con el siguiente patrón:
^([a-f0-9]{24})$. -
La lista de proyectos que se incluirán en la consulta del Explorador de costos.
El formato de cada uno debe coincidir con el siguiente patrón:
^([a-f0-9]{24})$. -
La lista de servicios SKU que se incluirán en la consulta del Explorador de costos.
Los valores son
Atlas,Clusters,Storage,Serverless Instances,Backup,Data Transfer,BI Connector,Premium Features,Atlas Data Federation,Atlas Stream Processing,App Services,Charts,Cloud Manager,Cloud Manager Standard/Premium,Legacy Backup,AI Models,Automated Embedding,Flex Consulting,Support,Credits,DSC ComputeoDSC Storage. -
Fecha de inicio (inclusiva) de la consulta del Explorador de Costos. Debe ser el inicio de un mes.
atlas api invoices createCostExplorerProcess --helpimport (
"os"
"context"
"log"
sdk "go.mongodb.org/atlas-sdk/v20231115001/admin"
)
func main() {
ctx := context.Background()
clientID := os.Getenv("MONGODB_ATLAS_CLIENT_ID")
clientSecret := os.Getenv("MONGODB_ATLAS_CLIENT_SECRET")
// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth
client, err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))
if err != nil {
log.Fatalf("Error: %v", err)
}
params = &sdk.CreateOrgBillingCostExplorerUsageProcessApiParams{}
sdkResp, httpResp, err := client.InvoicesApi.
CreateOrgBillingCostExplorerUsageProcessWithParams(ctx, params).
Execute()
}
curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
--header "Accept: application/vnd.atlas.2023-11-15+json" \
--header "Content-Type: application/json" \
-X POST "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/billing/costExplorer/usage" \
-d '{ <Payload> }'curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
--digest --include \
--header "Accept: application/vnd.atlas.2023-11-15+json" \
--header "Content-Type: application/json" \
-X POST "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/billing/costExplorer/usage" \
-d '{ <Payload> }'{
"clusters": [
"32b6e34b3d91647abb20e7b8"
],
"endDate": "2026-05-04",
"groupBy": "organizations",
"includePartialMatches": true,
"organizations": [
"32b6e34b3d91647abb20e7b8"
],
"projects": [
"32b6e34b3d91647abb20e7b8"
],
"services": [
"Atlas"
],
"startDate": "2026-05-04"
}{
"token": "d9ab638a801efe182f98ae3e18ea4bb47b9fda808a28a8c7de205bb0e94f7d71"
}{
"error": 400,
"detail": "(This is just an example, the exception may not be related to this endpoint) No provider AWS exists.",
"reason": "Bad Request",
"errorCode": "VALIDATION_ERROR"
}{
"error": 401,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Unauthorized",
"errorCode": "NOT_ORG_GROUP_CREATOR"
}{
"error": 403,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Forbidden",
"errorCode": "CANNOT_CHANGE_GROUP_NAME"
}{
"error": 404,
"detail": "(This is just an example, the exception may not be related to this endpoint) Cannot find resource AWS",
"reason": "Not Found",
"errorCode": "RESOURCE_NOT_FOUND"
}{
"error": 500,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Internal Server Error",
"errorCode": "UNEXPECTED_ERROR"
}