list-anomalies

dci list-anomalies [flags]

Returns a list of detected anomalies. Anomalies are returned in reverse chronological order by default. The notifications array is always present on each anomaly item; it is empty unless includeNotifications=true is supplied.

Flags

--min-creation-time: (string)

--max-creation-time: (string)

--filter: (string)

--max-results: (integer format:int64)

--page-token: (string)

--include-notifications: (boolean default:false)

Responses

200 (application/json)

OK - The request succeeded.

{
  "type": "object",
  "description": "List of detected cloud cost anomalies.",
  "properties": {
    "anomalies": {
      "type": "array",
      "items": {
        "required": [
          "attribution",
          "billingAccount",
          "costOfAnomaly",
          "platform",
          "scope",
          "serviceName",
          "severityLevel",
          "startTime",
          "timeFrame",
          "top3SKUs",
          "notifications"
        ],
        "type": "object",
        "description": "Detailed information about a detected anomaly. The `notifications` array is always present; list responses return an empty array unless `includeNotifications=true` is requested.",
        "properties": {
          "attribution": {
            "type": "string",
            "description": "Attribution ID."
          },
          "billingAccount": {
            "type": "string",
            "description": "Billing account ID."
          },
          "costOfAnomaly": {
            "type": "number",
            "description": "Excess cost over and above the expected normal cost.",
            "format": "double"
          },
          "id": {
            "type": "string"
          },
          "platform": {
            "type": "string",
            "description": "Cloud Provider name."
          },
          "scope": {
            "type": "string",
            "description": "Scope: Project or Account"
          },
          "serviceName": {
            "type": "string",
            "description": "Service name."
          },
          "severityLevel": {
            "type": "string",
            "description": "Severity level: Information, Warning or Critical"
          },
          "startTime": {
            "type": "integer",
            "description": "Usage start time of the anomaly.",
            "format": "int64"
          },
          "endTime": {
            "type": "integer",
            "nullable": true,
            "description": "End of the anomaly."
          },
          "timeFrame": {
            "type": "string",
            "description": "Timeframe: Daily or Hourly"
          },
          "top3SKUs": {
            "type": "array",
            "description": "Array of SKU entries contributing to an anomaly.",
            "items": {
              "type": "object",
              "description": "SKU-level information contributing to an anomaly.",
              "properties": {
                "cost": {
                  "type": "number",
                  "format": "double"
                },
                "name": {
                  "type": "string"
                }
              }
            }
          },
          "resourceData": {
            "type": "array",
            "description": "Array of resources contributing to an anomaly.",
            "items": {
              "type": "object",
              "description": "Resource-specific contribution to an anomaly.",
              "properties": {
                "cost": {
                  "type": "number",
                  "format": "double"
                },
                "resourceId": {
                  "type": "string"
                },
                "skuDescription": {
                  "type": "string"
                },
                "operation": {
                  "description": "For anomalies related to AWS S3",
                  "type": "string"
                },
                "labels": {
                  "type": "array",
                  "description": "Labels (also known as cost-allocation tags) present on this resource during the anomaly; each entry reports the label's key, its value, and the resource's cost tagged with that key/value pair.\nCloud providers use different names for the same concept; GCP uses \"labels\", AWS uses \"cost-allocation tags\", and Azure uses \"tags\". We refer to all of these as labels.",
                  "items": {
                    "type": "object",
                    "description": "A single label (a.k.a. cost-allocation tag) on the resource, paired with the resource's cost tagged with this key/value pair.",
                    "properties": {
                      "key": {
                        "type": "string",
                        "description": "The label/tag key."
                      },
                      "value": {
                        "type": "string",
                        "description": "The label/tag value."
                      },
                      "cost": {
                        "type": "number",
                        "format": "double",
                        "description": "The resource's cost tagged with this key/value pair; typically equal to the resource's cost, since labels/tags usually cover all of its spend."
                      }
                    }
                  }
                }
              }
            }
          },
          "status": {
            "type": "string",
            "nullable": true,
            "enum": [
              "active",
              "inactive"
            ]
          },
          "acknowledged": {
            "description": "Has the anomaly been acknowledged",
            "type": "boolean"
          },
          "acknowledgedAt": {
            "description": "When the anomaly was first acknowledged",
            "type": "string",
            "format": "date-time",
            "nullable": true
          },
          "acknowledgedBy": {
            "description": "Email of the user who first acknowledged the anomaly",
            "type": "string",
            "nullable": true
          },
          "notifications": {
            "type": "array",
            "description": "Chronologically ordered notification dispatch events.",
            "items": {
              "type": "object",
              "description": "A successful notification dispatch for an anomaly.\nThis records that the API/worker sent the notification, not that delivery was confirmed.",
              "required": [
                "timestamp",
                "channel"
              ],
              "properties": {
                "timestamp": {
                  "type": "string",
                  "format": "date-time",
                  "description": "Dispatch timestamp in RFC3339 UTC."
                },
                "channel": {
                  "type": "string",
                  "description": "Dispatch channel.",
                  "enum": [
                    "email",
                    "slack",
                    "msteams"
                  ]
                }
              }
            }
          }
        }
      }
    },
    "pageToken": {
      "type": "string"
    },
    "rowCount": {
      "type": "integer",
      "format": "int64"
    }
  }
}

400 (application/json)

Bad Request - The server cannot process the request, often due to a malformed request.

{
  "type": "object",
  "description": "Standard error response structure.",
  "properties": {
    "error": {
      "type": "string",
      "description": "Detailed error message."
    }
  }
}

401 (application/json)

Unauthorized - Invalid API key.

{
  "type": "object",
  "description": "Standard error response structure.",
  "properties": {
    "error": {
      "type": "string",
      "description": "Detailed error message."
    }
  }
}

403 (application/json)

Forbidden - The client is not authorized to perform the request.

{
  "type": "object",
  "description": "Standard error response structure.",
  "properties": {
    "error": {
      "type": "string",
      "description": "Detailed error message."
    }
  }
}

404 (application/json)

Not Found - The requested resource does not exist.

{
  "type": "object",
  "description": "Standard error response structure.",
  "properties": {
    "error": {
      "type": "string",
      "description": "Detailed error message."
    }
  }
}

Aliases: list-anomalies, listanomalies