Skip to main content
ZStack
Security & Audit/Security

GetAnhengCapabilityStatus

Get aggregated Anheng capability status. The builtin administrator uses its special read-only identity, a trusted platform-admin always uses global scope without consulting Cloud Projects, and a project-admin supplies X-ZStack-Session so ZCF can derive exactly one Project. The frontend does not send ProjectID. This endpoint does not call AH genSsoUrl, and credentials must never be logged, audited, persisted, or returned in errors.

GET/api/v1/security/anheng/capabilities/{capabilityCode}/status

Operation ID

GetAnhengCapabilityStatus

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

Path Parameters

  • capabilityCode
    StringRequired

    Unique code of the Anheng capability

Responses

200 OK
200 OK

On success, this API returns the following response structure.

  • capabilityCode
    String

    Capability code for this resource

    Example: value

  • instanceUuid
    String

    Instance uuid for this resource

    Example: value

  • capabilityState
    String

    Capability state for this resource

    Example: value

  • taskState
    String

    Task state for this resource

    Example: value

  • artifactState
    String

    Artifact state for this resource

    Example: value

  • readinessState
    String

    Readiness state for this resource

    Example: value

  • enterReady
    Boolean

    Whether the capability 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

  • 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

  • currentSpecCode
    String

    Current spec code for this resource

    Example: value

Change History

View all change history

  • Change Time

    AddedRequest parameters X-ZStack-Session
    View API