Skip to main content
ZStack
Security & Audit/Security

ListAnhengInstances

List visible Anheng instances. Project administrators supply X-ZStack-Session so ZCF can derive their unique Project; platform administrators retain the explicit global management view and may omit the session for this read-only operation. Owner status and lifecycle operations remain scoped to their own fixed-global identity. No ProjectID request field is used.

GET/api/v1/security/anheng/instances

Operation ID

ListAnhengInstances

Since

1.2.8

Execution Mode

Synchronous

Auth Context

Auth Required

Auth Context

Send these values as request headers when calling this API.

AuthorizationstringRequired

Bearer Token

X-Tenant-IDstring

X-Tenant-ID

Request Inputs

Query Parameters

  • capabilityCode
    String

    Unique code of the Anheng capability

  • capabilityState
    String

    Capability state used to filter the results

  • taskState
    String

    Task state used to filter the results

  • limit
    Integer

    Maximum number of records to return

    Example: 0

  • offset
    Integer

    Number of records to skip before returning results

    Example: 0

Responses

200 OK
200 OK

On success, this API returns the following response structure.

  • items
    List

    Collection of result items

    Example: (nested array)

    • instanceUuid
      String

      Instance uuid for this resource

      Example: value

    • capabilityCode
      String

      Capability code for this resource

      Example: value

    • capabilityState
      String

      Capability state for this resource

      Example: value

    • taskState
      String

      Task state for this resource

      Example: value

    • enterReady
      Boolean

      Whether this instance can currently launch the AH console.

      Example: true

    • allowedActions
      List

      Allowed actions for this resource

      Example: item1,item2

    • blockedReasons
      List

      Blocked reasons for this resource

      Example: (nested array)

      • code
        String

        Machine-readable reason or status code

        Example: value

      • source
        String

        Source for this resource

        Example: value

      • message
        String

        Message for this resource

        Example: value

      • retryable
        Boolean

        Retryable for this resource

        Example: true

      • severity
        String

        Severity for this resource

        Example: value

      • owner
        String

        Owner for this resource

        Example: value

    • vm
      Object

      Virtual machine details associated with this resource

      • vmUuid
        String

        Vm uuid for this resource

        Example: value

      • state
        String

        State for this resource

        Example: value

      • ip
        String

        IP address assigned to the virtual machine

        Example: value

      • mac
        String

        MAC address assigned to the virtual machine

        Example: value

      • l3NetworkUuid
        String

        L3 network uuid for this resource

        Example: value

      • name
        String

        Human-readable name of this resource

        Example: my-resource

    • imageArtifactId
      String

      Image artifact id for this resource

      Example: value

    • currentSpecCode
      String

      Current spec code for this resource

      Example: value

    • expireTime
      String

      Expire time for this resource

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

    • lastTaskId
      String

      Last task id for this resource

      Example: value

    • currentTaskId
      String

      Current task id for this resource

      Example: value

    • currentTaskType
      String

      Current task type for this resource

      Example: value

    • currentTaskState
      String

      Current task state for this resource

      Example: value

    • currentSpec
      Object

      Current spec for this resource

      • cpuNum
        Integer

        Cpu num for this resource

        Example: 10

      • memoryBytes
        String

        Memory bytes for this resource

        Example: 10

      • rootDiskBytes
        String

        Root disk bytes for this resource

        Example: 10

      • dataDiskBytes
        List

        Data disk bytes for this resource

        Example: item1,item2

  • total
    Integer

    Total for this resource

    Example: 10

  • limit
    Integer

    Limit for this resource

    Example: 10

  • offset
    Integer

    Offset for this resource

    Example: 10

Change History

View all change history

  • Change Time

    AddedRequest parameters X-ZStack-Session
    View API