Skip to main content
API Explorer|API Explorer
Resource Center/Elastic Bare Metal Management(Plus)
PUTElastic Bare Metal Management(Plus)Since 4.0.0SynchronousAuth Required

UpdateBareMetal2Gateway

UpdateBareMetal2Gateway

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

    The gateway UUID.

Body Fields

  • updatebaremetal2gatewayObjectRequired

    updatebaremetal2gateway request body object.

    • sshPortInteger

      Optional. The SSH port.

    • usernameString

      Optional. The username of the gateway.

    • passwordString

      Optional. The password of the gateway.

    • nameString

      Optional. The name of the gateway.

    • descriptionString

      Optional. The detailed description of the gateway.

    • managementIpString

      Optional. The IP address of the management node.

  • systemTagsList

    Optional. The system tags.

  • userTagsList

    Optional. The user tags.

Responses

200 OK

On success, this API returns the following response structure.

  • 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.

  • inventoryBareMetal2GatewayInventoryRequired

    See inventory.

    • attachedClusterUuidsListRequired

      The attached cluster UUIDs.

    • usernameStringRequired

      The username of the gateway.

    • sshPortIntegerRequired

      The SSH port.

    • zoneUuidStringRequired

      The zone UUID.

    • nameStringRequired

      The name of the gateway.

    • uuidStringRequired

      The UUID of the gateway.

    • clusterUuidStringRequired

      The cluster UUID.

    • descriptionStringRequired

      The detailed description of the gateway.

    • managementIpStringRequired

      The IP address of the management node.

    • hypervisorTypeStringRequired

      The virtualization type.

    • stateStringRequired

      The state of the gateway.

    • statusStringRequired

      The connection status of the gateway.

    • totalCpuCapacityLongRequired

      The total processing capacity of CPU.

    • availableCpuCapacityLongRequired

      The available processing capacity of CPU.

    • cpuSocketsIntegerRequired

      No description provided.

    • totalMemoryCapacityLongRequired

      The total memory size.

    • availableMemoryCapacityLongRequired

      The available memory size.

    • cpuNumIntegerRequired

      The number of CPU cores.

    • createDateTimestampRequired

      The time when the gateway was created.

    • lastOpDateTimestampRequired

      The time when the was gateway last modified.

    • provisionNicBareMetal2GatewayProvisionNicInventoryRequired

      See provisionNic.

      • uuidStringRequired

        The NIC UUID.

      • networkUuidStringRequired

        The deployment network UUID.

      • interfaceNameStringRequired

        The name of the NIC.

      • ipStringRequired

        The IP address of the NIC.

      • netmaskStringRequired

        The netmask of the NIC.

      • gatewayStringRequired

        The gateway.

      • metadataStringRequired

        附加元数据。

      • createDateTimestampRequired

        The time when the NIC was created.

      • lastOpDateTimestampRequired

        The time when the NIC was last modified.

Endpoint

PUT/zstack/v1/baremetal2/gateways/{uuid}/actions

/zstack/v1/baremetal2/gateways/{uuid}/actions

Operation ID

UpdateBareMetal2Gateway

Permalink

Request Example

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

Response Example

200
{ "inventory": { "username": "username", "password": "password", "sshPort": 22.0, "zoneUuid": "e5337859dc214ce49ce31acea22a3bab", "name": "BM_GATEWAY", "uuid": "ce1634f0ff72403fbb457b1630420096", "description": "This is a bare metal gateway.", "managementIp": "192.168.0.10", "state": "Enabled", "status": "Connected", "createDate": "Nov 14, 2017 10:20:57 PM", "lastOpDate": "Nov 14, 2017 10:20:57 PM" } }

Change History

This API has no change history records yet.

View all change history