Help Center/ Cloud Application Engine/ API Reference/ CAE API/ EIP./ Modifying the Inbound and Outbound Bandwidth and Enabling Status

Updated on 2025-10-22 GMT+08:00

View PDF

Modifying the Inbound and Outbound Bandwidth and Enabling Status

Function

Modify the inbound and outbound bandwidth and enabling status.

URI

PUT /v1/{project_id}/cae/eips

**Table 1** Path Parameters
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. Obtain the token. For details, see "Obtaining a User Token" in Identity and Access Management API Reference (https://support.huaweicloud.com/intl/en-us/api-iam/iam_30_0001.html). The value of X-Subject-Token in the response header is the token value.
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 details about how to obtain enterprise project IDs and enterprise project features, see Enterprise Management User Guide.
X-Environment-ID	Yes	String	Environment ID. To obtain an environment ID, see Obtaining the Environment List. 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.
kind	No	String	API type. Fixed 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.
enabled	No	Boolean	Whether to disable the outbound IP address.

**Table 6** ingress
Parameter	Mandatory	Type	Description
bandwidth_size	No	Integer	Inbound bandwidth.
enabled	No	Boolean	Whether to disable the inbound IP address.

Response Parameters

Status code: 200

None

Example Requests

Modify the inbound and outbound bandwidth and enabling status.

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

{
  "api_version" : "v1",
  "kind" : "Eip",
  "spec" : {
    "egress" : {
      "bandwidth_size" : 50,
      "enabled" : true
    },
    "ingress" : {
      "bandwidth_size" : 100,
      "enabled" : true
    }
  }
}