Skip to main content
API Explorer|API Explorer
Resource Center/Hardware/Host Operations
GETHost OperationsSince 4.6.21SynchronousAuth Required

QueryHostOsCategory

QueryHostOsCategory

Execution Availability

Try It Out

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

Request Inputs

This API requires no request parameters.

Responses

200 OK

On success, this API returns the following response structure.

  • successbooleanRequired

    Whether the query is successful or not.

  • inventoriesListRequired

    See inventories.

    • uuidStringRequired

      The resource UUID.

    • architectureStringRequired

      The host architecture, such as x86_64.

    • osReleaseVersionStringRequired

      The host operation system version.

    • createDateTimestampRequired

      The creation date.

    • lastOpDateTimestampRequired

      The last operation date.

    • metadataListListRequired

      See metadataList

      • uuidStringRequired

        The resource UUID.

      • categoryUuidStringRequired

        The UUID of the supported host category.

      • managementNodeUuidStringRequired

        The management node UUID.

      • hypervisorStringRequired

        The hypervisor name, such as qemu-kvm.

      • versionStringRequired

        The version number, such as 4.2.0-632.g6a6222b.el7.

      • createDateTimestampRequired

        The creation date.

      • lastOpDateTimestampRequired

        The last operation date.

  • errorErrorCodeRequired

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

    • codeStringRequired

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

    • descriptionStringRequired

      The brief description of the error.

    • detailsStringRequired

      The details about the error.

    • elaborationStringRequired

      The reserved field. Default value: null.

    • opaqueLinkedHashMapRequired

      The reserved field. Default value: null.

    • causeErrorCodeRequired

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

Endpoint

GET/zstack/v1/hosts/os/category

/zstack/v1/hosts/os/category

Operation ID

QueryHostOsCategory

Permalink

Request Example

curl -X GET 'http://{host}/zstack/v1/hosts/os/category' -H 'Authorization: OAuth {sessionUuid}'

Response Example

200
{ "inventories": [ { "architecture": "x86_64", "osReleaseVersion": "helix Core 7.6", "metadataList": [ { "managementNodeUuid": "fe5459189a8733ef9b6b8141b84f7071", "hypervisor": "qemu-kvm", "version": "4.2.0-632.g6a6222b.el7", "createDate": "Nov 14, 2017 2:20:57 PM", "lastOpDate": "Nov 14, 2017 2:20:57 PM" } ], "createDate": "Nov 14, 2017 2:20:57 PM", "lastOpDate": "Nov 14, 2017 2:20:57 PM" } ] }

Change History

This API has no change history records yet.

View all change history