Modifying Bandwidth

Function

This API is used to modify bandwidth.

URI

PUT /v1/{project_id}/cae/eips

**Table 1** Path parameter
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID. See Obtaining a Project ID.

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token. To obtain a token, see Obtaining a User Token Through Password Authentication. After a response is returned, the value of X-Subject-Token in the response header is the token value. Maximum characters: 16,384
X-Enterprise-Project-ID	No	String	Enterprise project ID. When an environment is created, it will be bound with an enterprise project ID. Enter 0 or up to 36 characters in UUID format with hyphens (-). If this parameter is not specified or set to 0, resources in the default enterprise project are queried. NOTE: For more information about enterprise projects and how to obtain enterprise project IDs, see Enterprise Management User Guide.
X-Environment-ID	Yes	String	Environment ID. To obtain an environment ID, see Obtaining the Environment List in CAE API Reference. In the response, id under items indicates the environment ID.

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
api_version	No	String	API version. Fixed value: v1. Enumerated value: v1
kind	No	String	API type. Fixed value: eip. Enumerated value: eip
spec	No	spec object	Inbound and outbound EIPs whose bandwidth is to be modified.

**Table 4** spec
Parameter	Mandatory	Type	Description
egress	No	egress object	Outbound IP address.
ingress	No	ingress object	Inbound IP address.

**Table 5** egress
Parameter	Mandatory	Type	Description
bandwidth_size	No	Integer	Outbound bandwidth.

**Table 6** ingress
Parameter	Mandatory	Type	Description
bandwidth_size	No	Integer	Inbound bandwidth.

Response Parameters

None

Example Request

Modify inbound and outbound bandwidth.

PUT https://{endpoint}/v1/{project_id}/cae/eips

{
  "api_version" : "v1",
  "kind" : "eip",
  "spec" : {
    "egress" : {
      "bandwidth_size" : 50
    },
    "ingress" : {
      "bandwidth_size" : 100
    }
  }
}