Skip to main content
API Explorer|API Explorer
Resource Center/Resource Pool/VM Instance Operations
PUTVM Instance OperationsSince 0.6SynchronousAuth Required

SetVmStaticIp

SetVmStaticIp

Execution Availability

Try It Out

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

Path Parameters

Request Inputs

Path Parameters

  • vmInstanceUuidStringRequired

    The VM instance UUID.

Body Fields

  • setvmstaticipObjectRequired

    setvmstaticip request body object.

    • l3NetworkUuidStringRequired

      The L3 network UUID.

    • ipString

      Optional. The specified IP address.

    • ip6String

      Optional. The specified IPv6 address.

  • systemTagsList

    Optional. The system tags.

  • userTagsList

    Optional. The user tags.

  • netmaskString

    Optional. The IPv4 netmask.

  • gatewayString

    Optional. The IPv4 gateway.

Responses

200 OK

On success, this API returns an empty JSON object {}.

Endpoint

PUT/zstack/v1/vm-instances/{vmInstanceUuid}/actions

/zstack/v1/vm-instances/{vmInstanceUuid}/actions

Operation ID

SetVmStaticIp

Permalink

Request Example

curl -X PUT 'http://{host}/zstack/v1/vm-instances/{vmInstanceUuid}/actions' -H 'Authorization: OAuth {sessionUuid}' -H 'Content-Type: application/json;charset=UTF-8' -d '{"setvmstaticip":{"l3NetworkUuid":"<l3NetworkUuid>","ip":"<ip>","ip6":"<ip6>"},"systemTags":["<systemTags>"],"userTags":["<userTags>"],"netmask":"<netmask>","gateway":"<gateway>","ipv6Gateway":"<ipv6Gateway>","ipv6Prefix":"<ipv6Prefix>"}'

Response Example

200
{}

Change History

This API has no change history records yet.

View all change history