billing.budgets.scope-preview

Count the resources a scope would cover, before saving it

POST /billing/api/budgets/scope-previewIAM billing:GetBudgetsRead

A read behind a POST: the scope is a nested structure, and encoding it into a query string would mean a second parser for the same shape. Nothing is written. Also requires tags:ListTags — it reads tag membership.

Request syntax

POST /billing/api/budgets/scope-preview
{
  "scope": "object"
}

Request body

  • scopeRequired

    object

    The scope to try: {type: organization}, {type: resourceProject, projectId}, {type: project, projectId} or {type: tags, clauses}

    Constraints: JSON

Response

200 with { valid, error, matchesEverything, projectName, matched, billable, byType }: matched is how many resources the scope selects, billable how many of them are billed now; a project that does not exist answers valid false with the error. 403 without both billing:GetBudgets and tags:ListTags.

A JSON response is wrapped as { "success": true, "data": … }; the CLI prints the whole body with --json.

Errors

  • 400The request does not pass the schema above. The body is { "error": …, "issues": […] }, one issue per field.
  • 401No credentials, or an access key that is unknown, revoked or expired.
  • 403The caller's policies do not allow billing:GetBudgets on this resource. The body names the action and the resource, and the refusal is recorded in the audit log.
  • 404The resource does not exist in your organization.

Examples

The required parameters only, with example values. Replace id and the other placeholders with your own.

dcloud billing budgets scope-preview --scope '{}'

Generated from the API description, the same one the API checks requests against and the CLI is built from. MCP tool: dcloud_billing_budgets_scope-preview.