Skip to main content
API Explorer|API Explorer
Platform Operations/Platforms
GETRegionSince 1.1.0SynchronousAuth Required

ListRegions

List Regions with pagination and optional platform or product type filters.

Execution Availability

Try It Out

Submit a mock request using the current auth context and example-driven inputs.

Query Parameters

Request Inputs

Query Parameters

  • pageInteger

    Page number (1-based)

    Example: 0

  • pageSizeInteger

    Maximum number of items per page

    Example: 0

  • platformIdString

    Optional: filter by platform UUID

  • productTypeString

    Optional: filter by product type

Responses

200 OK

On success, this API returns the following response structure.

  • regionsList

    List of Regions.

    Example: (nested array)

    • uuidString

      Unique identifier of the Region

      Example: a1b2c3d4-e5f6-7890-abcd-ef1234567890

    • nameString

      User-defined unique name for this Region

      Example: beijing-dc1

    • displayNameString

      Human-readable display name

      Example: Beijing DC-1

    • descriptionString

      Free-form description

      Example: Primary datacenter in Beijing

    • statusString

      Current status (Active, Disabled)

      Example: Active

    • createDateString

      Timestamp when this Region was created

      Example: 2026-01-15T08:00:00Z

    • lastOpDateString

      Timestamp of last update

      Example: 2026-01-15T08:00:00Z

    • statsObject

      Computed resource statistics for this Region

      • cloudCountInteger

        Number of Cloud connections (0 or 1)

        Example: 1

      • connectionCountInteger

        Total connections in this Region

        Example: 3

      • zoneCountInteger

        Number of zones

        Example: 2

      • clusterCountInteger

        Number of clusters

        Example: 4

      • hostCountInteger

        Number of hosts

        Example: 10

      • vmCountInteger

        Number of VMs

        Example: 50

      • k8sClusterCountInteger

        Number of K8s clusters

        Example: 2

      • storageClusterCountInteger

        Number of storage clusters

        Example: 1

  • totalInteger

    Total number of matching Regions

    Example: 10

Endpoint

GET/api/v1/regions

/api/v1/regions

Operation ID

ListRegions

Permalink

Request Example

curl -X GET '{host}/api/v1/regions?page=1&pageSize=20' -H 'Authorization: Bearer {token}'

Response Example

200
{"regions": [{"uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "name": "beijing-dc1", "displayName": "Beijing DC-1", "description": "Primary datacenter in Beijing", "status": "Active", "createDate": "2026-01-15T08:00:00Z", "lastOpDate": "2026-01-15T08:00:00Z", "stats": {"cloudCount": 1, "connectionCount": 3, "zoneCount": 2, "clusterCount": 4, "hostCount": 10, "vmCount": 50, "k8sClusterCount": 2, "storageClusterCount": 1}}], "total": 10}

Change History

This API has no change history records yet.

View all change history