Skip to main content
ZStack
Resource Center/Resource Pool/Affinity Group Operations

GetCandidateAffinityGroupForAttachingVm

GetCandidateAffinityGroupForAttachingVm

GET/zstack/v1/affinityGroup/attachingVm

Operation ID

GetCandidateAffinityGroupForAttachingVm

Since

4.0.0

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

  • vmUuid
    StringRequired

    The VM UUID.

  • systemTags
    List

    Optional. The system tags.

  • userTags
    List

    Optional. The user tags.

Responses

200 OK
200 OK

On success, this API returns the following response structure.

  • success
    booleanRequired

    Whether the operation succeeded.

  • error
    ErrorCodeRequired

    The error code. If not null, the operation fails, or vice versa. For more information, see error.

    • code
      StringRequired

      The error code, which is a numbered or alphanumeric code that specifies an error. For example, SYS.1000, HOST.1001.

    • description
      StringRequired

      The brief description of the error.

    • details
      StringRequired

      The details about the error.

    • elaboration
      StringRequired

      The reserved field. Default value: null.

    • opaque
      LinkedHashMapRequired

      The reserved field. Default value: null.

    • cause
      ErrorCodeRequired

      The root error, which is the associated root cause of the current error. If no root error exists, this parameter is null.

  • inventories
    ListRequired

    For more information, see inventories.

    • uuid
      StringRequired

      The affinity group UUID.

    • name
      StringRequired

      The affinity group name.

    • description
      StringRequired

      The detailed description of the affinity group.

    • policy
      StringRequired

      The policy.

    • version
      StringRequired

      The version.

    • type
      StringRequired

      The resource type.

    • appliance
      StringRequired

      The appliance.

    • state
      StringRequired

      The resource state.

    • createDate
      TimestampRequired

      The time when the affinity group was created.

    • lastOpDate
      TimestampRequired

      The time when the affinity group was last modified.

    • usages
      ListRequired

      For more information, see usages.

      • uuid
        StringRequired

        The affinity group UUID.

      • affinityGroupUuid
        StringRequired

        The affinity group UUID.

      • resourceUuid
        StringRequired

        The resource UUID.

      • resourceType
        StringRequired

        The resource type.

      • createDate
        TimestampRequired

        The time when the affinity group was created.

      • lastOpDate
        TimestampRequired

        The time when the affinity group was last modified.

Change History

View all change history

  • Change Time

    AddedResponse fields affinityGroupUuid, appliance, createDate...
    View API