ListPlatforms

On success, this API returns the following response structure.

• items

  List

  List of platform records

  Example: (nested array)

  Show child properties
  • uuid

    String

    Unique identifier of the platform

    Example: plat-abc123-def456

  • name

    String

    Human-readable name of the platform

    Example: prod-zstack-01

  • productType

    String

    Product type identifier (e.g. zstack, vmware)

    Example: zstack

  • hostIp

    String

    IP address of the platform host

    Example: 192.168.1.100

  • hostPort

    Integer

    Port number of the platform API endpoint

    Example: 8080

  • accessKeyName

    String

    Name of the access key credential used for authentication

    Example: admin-key

  • status

    String

    Current operational status of the platform connection

    Example: connected

  • lastError

    String

    Last error message if the platform encountered a failure

    Example: connection timeout

  • features

    Object

    Feature flags enabled for this platform

    Show child properties
    • syncResource

      Boolean

      Whether resource synchronization is enabled for this platform

      Example: true

    • monitoring

      Boolean

      Whether monitoring data collection is enabled

      Example: true

    • logCollection

      Boolean

      Whether log collection is enabled for this platform

      Example: false

    • credential

      Object

      Encrypted admin credential (AES-256-GCM ciphertext) captured at CreatePlatform

      Show child properties
      • usernameEnc

        String

        AES-256-GCM ciphertext (base64) of the admin username

        Example: value

      • passwordEnc

        String

        AES-256-GCM ciphertext (base64) of the admin password

        Example: value

  • version

    String

    Version string of the platform software

    Example: 4.3.0

  • healthStatus

    String

    Overall health status of the platform (healthy, degraded, unhealthy)

    Example: healthy

  • lastSuccessAt

    String

    Last success at

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

  • lastErrorAt

    String

    Last error at

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

  • lastErrorDetail

    String

    Detailed description of the last error for diagnostics

    Example: dial tcp 192.168.1.100:8080: connect: connection refused

  • successCount

    Integer

    Cumulative count of successful operations

    Example: 1024

  • errorCount

    Integer

    Cumulative count of failed operations

    Example: 3

  • createDate

    String

    Create date

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

  • lastOpDate

    String

    Last op date

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

  • scope

    String

    Connection scope: 'region' (resource-type) or 'global' (platform-level)

    Example: region

  • regionUuid

    String

    UUID of the Region this connection belongs to (empty for global scope)

    Example: region-abc123-def456

  • deletionPhase

    String

    Deletion framework phase for this platform. Empty means no deletion is in progress.

    Example: Failed

  • deleteRetryable

    Boolean

    Whether retry-delete can be used for the current deletion failure.

    Example: true

  • deletionFailureReason

    String

    Last deletion failure reason recorded by the deletion framework.

    Example: revoke zns access key before delete: connection refused

• total

  Integer

  Total number of platforms matching the query

  Example: 42

• limit

  Integer

  Maximum number of items returned per page

  Example: 20

• offset

  Integer

  Number of items skipped

  Example: 20