Skip to main content
API Explorer|API Explorer
Compute Management/Host Related Interfaces
PUTHost Related InterfacesSince 0.6SynchronousAuth Required

Update Host

Update Host

Execution Availability

Try It Out

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

Path Parameters

Request Inputs

Path Parameters

  • uuidStringRequired

    Resource UUID, uniquely identifies the resource

Body Fields

  • updatehostObjectRequired

    updatehost request body object.

    • nameString

      Resource name

    • descriptionString

      Resource description

    • managementIpString

      管理IP。

  • systemTagsList

    System tag

  • userTagsList

    User tag

Responses

200 OK

On success, this API returns the following response structure.

  • successbooleanRequired

    操作是否成功。

  • errorErrorCodeRequired

    Error code. If not null, the operation failed. If null, the operation succeeded. See details error

    • codeStringRequired

      Error code number, globally unique identifier of the error, e.g. SYS.1000, HOST.1001

    • descriptionStringRequired

      Brief description of the error

    • detailsStringRequired

      Detailed error information

    • elaborationStringRequired

      Reserved field, default is null

    • opaqueLinkedHashMapRequired

      Reserved field, default is null

    • causeErrorCodeRequired

      Root cause, the error that caused the current error. If there is no original error, this field is null

  • inventoryHostInventoryRequired

    See details inventory

    • zoneUuidStringRequired

      Data Center UUID

    • nameStringRequired

      Resource name

    • uuidStringRequired

      Resource UUID, uniquely identifies the resource

    • clusterUuidStringRequired

      Cluster UUID

    • descriptionStringRequired

      Resource description

    • managementIpStringRequired

      管理IP。

    • hypervisorTypeStringRequired

      No description provided.

    • stateStringRequired

      当前状态。

    • statusStringRequired

      状态信息。

    • totalCpuCapacityLongRequired

      总CPU容量。

    • availableCpuCapacityLongRequired

      可用CPU容量。

    • cpuSocketsIntegerRequired

      No description provided.

    • totalMemoryCapacityLongRequired

      总内存容量。

    • availableMemoryCapacityLongRequired

      可用内存容量。

    • cpuNumIntegerRequired

      Number of logical CPUs

    • ipmiAddressStringRequired

      IPMI address

    • ipmiUsernameStringRequired

      IPMI username

    • ipmiPortIntegerRequired

      IPMI port

    • ipmiPowerStatusStringRequired

      IPMI power status

    • architectureStringRequired

      No description provided.

    • nqnStringRequired

      NVMe Qualified Name

    • hostnameStringRequired

      Host name

    • createDateTimestampRequired

      Creation time

    • lastOpDateTimestampRequired

      Last modification time

    • cpuStatusHwMonitorStatusRequired

      See details cpuStatus

      • NormalHwMonitorStatusRequired

        Normal

      • ErrorHwMonitorStatusRequired

        Error

      • UnknownHwMonitorStatusRequired

        Unknown

    • memoryStatusHwMonitorStatusRequired

      See details memoryStatus

      • NormalHwMonitorStatusRequired

        Normal

      • ErrorHwMonitorStatusRequired

        Error

      • UnknownHwMonitorStatusRequired

        Unknown

    • diskStatusHwMonitorStatusRequired

      See details diskStatus

      • NormalHwMonitorStatusRequired

        Normal

      • ErrorHwMonitorStatusRequired

        Error

      • UnknownHwMonitorStatusRequired

        Unknown

    • nicStatusHwMonitorStatusRequired

      See details nicStatus

      • NormalHwMonitorStatusRequired

        Normal

      • ErrorHwMonitorStatusRequired

        Error

      • UnknownHwMonitorStatusRequired

        Unknown

    • gpuStatusHwMonitorStatusRequired

      See details gpuStatus

      • NormalHwMonitorStatusRequired

        Normal

      • ErrorHwMonitorStatusRequired

        Error

      • UnknownHwMonitorStatusRequired

        Unknown

    • powerSupplyStatusHwMonitorStatusRequired

      See details powerSupplyStatus

      • NormalHwMonitorStatusRequired

        Normal

      • ErrorHwMonitorStatusRequired

        Error

      • UnknownHwMonitorStatusRequired

        Unknown

    • fanStatusHwMonitorStatusRequired

      See details fanStatus

      • NormalHwMonitorStatusRequired

        Normal

      • ErrorHwMonitorStatusRequired

        Error

      • UnknownHwMonitorStatusRequired

        Unknown

    • raidStatusHwMonitorStatusRequired

      See details raidStatus

      • NormalHwMonitorStatusRequired

        Normal

      • ErrorHwMonitorStatusRequired

        Error

      • UnknownHwMonitorStatusRequired

        Unknown

    • temperatureStatusHwMonitorStatusRequired

      See details temperatureStatus

      • NormalHwMonitorStatusRequired

        Normal

      • ErrorHwMonitorStatusRequired

        Error

      • UnknownHwMonitorStatusRequired

        Unknown

Endpoint

PUT/zstack/v1/hosts/{uuid}/actions

/zstack/v1/hosts/{uuid}/actions

Operation ID

UpdateHost

Permalink

Request Example

curl -X PUT 'http://{host}/zstack/v1/hosts/{uuid}/actions' -H 'Authorization: OAuth {sessionUuid}' -H 'Content-Type: application/json;charset=UTF-8' -d '{"updatehost":{"name":"<name>","description":"<description>","managementIp":"<managementIp>"},"systemTags":["<systemTags>"],"userTags":["<userTags>"]}'

Response Example

200
{ "inventory": { "zoneUuid": "82c01885efdc3f789fa9130db6a00532", "name": "example", "uuid": "b3b5a4d4c6973932a29d4bee698fe9ca", "clusterUuid": "c416a848e4e538f1b321169001869bbd", "description": "example", "managementIp": "192.168.0.1", "hypervisorType": "KVM", "state": "Enabled", "status": "Connected", "totalCpuCapacity": 4, "availableCpuCapacity": 2, "totalMemoryCapacity": 4, "availableMemoryCapacity": 4 } }

Change History

This API has no change history records yet.

View all change history