monitoring.status-pages.get

Describe a status page: its components, their current state, subscriber count

GET /monitoring/api/status-pages/{id}IAM monitoring:DescribeStatusPagesRead

Request syntax

GET /monitoring/api/status-pages/{id}

Path parameters

  • idRequired

    string

    Constraints: uuid

Response

200 with the page as list describes it plus components (each { id, name, description, groupName, position, checkId, manualState }), overall (the worst state on the page), componentStates (each { id, state, uptimePercent }) and subscriberCount. 404 for a missing page and for one the caller may not describe.

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 monitoring:DescribeStatusPages 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 monitoring status-pages get id

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