Skip to main content
API Explorer|API Explorer
Resource Center/Network Service/Network Service Operations/VIP Operations
PUTVIP OperationsSince 2.3SynchronousAuth Required

SetVipQos

SetVipQos

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 resource UUID.

Body Fields

  • setvipqosObjectRequired

    setvipqos request body object.

    • portInteger

      Optional. The port.

    • outboundBandwidthLong

      Optional. The outbound bandwidth of the request port.

    • inboundBandwidthLong

      Optional. The inbound bandwidth of the request port. Make sure that either inboundBandwidth or outboundBandwidth is not null.

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

  • inventoryVipQosInventoryRequired

    See inventory.

    • uuidStringRequired

      The resource UUID.

    • vipUuidStringRequired

      The VIP UUID.

    • portIntegerRequired

      The port.

    • inboundBandwidthLongRequired

      The outbound bandwidth of the response port.

    • outboundBandwidthLongRequired

      The inbound bandwidth of the response port.

    • typeStringRequired

      The QoS unit type.

    • createDateTimestampRequired

      The creation date.

    • lastOpDateTimestampRequired

      The last operation date.

Endpoint

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

/zstack/v1/vips/{uuid}/actions

Operation ID

SetVipQos

Permalink

Request Example

curl -X PUT 'http://{host}/zstack/v1/vips/{uuid}/actions' -H 'Authorization: OAuth {sessionUuid}' -H 'Content-Type: application/json;charset=UTF-8' -d '{"setvipqos":{"port":1,"outboundBandwidth":1,"inboundBandwidth":1},"systemTags":["<systemTags>"],"userTags":["<userTags>"]}'

Response Example

200
{ "inventory": { "uuid": "dd9459fe90ff4ae0b26ab3cbf1f1e3a2", "vipUuid": "e82e583934b441aaaf37039ff5eba877", "port": 80.0, "inboundBandwidth": 1048576.0, "outboundBandwidth": 1048576.0 } }

Change History

This API has no change history records yet.

View all change history