Assigning EIPs in Batches

project_id

Yes

String

Project ID

bandwidth

Yes

BatchBandwidth object

Bandwidth information

publicip

Yes

BatchPublicIp object

EIP information

publicip_number

Yes

Integer

Number of EIPs to be created in batches

enterprise_project_id

Yes

String

Enterprise project ID

charge_mode

No

String

• Whether the billing is based on traffic or bandwidth For IPv6 addresses, the default value is bandwidth outside China and is traffic in China. If the value is traffic, the billing is based on traffic.

Enumerated values:

• bandwidth
• traffic

name

No

String

• Bandwidth name
• The value can contain 1 to 64 characters, including letters, digits, underscores (_), hyphens (-), and periods (.).
• This parameter is mandatory if share_type is set to PER. This parameter will be ignored if share_type is set to WHOLE with an ID specified.

Minimum length: 1

Maximum: 64

share_type

No

String

• Bandwidth type.
• The value can be PER or WHOLE. IPv6 addresses do not support bandwidth whose type is WHOLE.

Enumerated values:

• PER
• WHOLE

size

Yes

Integer

• Bandwidth size (Mbit/s).
• The value ranges from 1 Mbit/s to 2000 Mbit/s by default. (The specific range may vary depending on the configuration in each region. You can see the available bandwidth range on the management console.)
• This parameter is mandatory if share_type is set to PER. This parameter will be ignored if share_type is set to WHOLE with an ID specified.
• The minimum increment for bandwidth adjustment varies depending on the bandwidth range. The details are as follows:
  • The minimum increment is 1 Mbit/s if the allowed bandwidth ranges from 0 Mbit/s to 300 Mbit/s (with 300 Mbit/s included).
  • The minimum increment is 50 Mbit/s if the allowed bandwidth ranges from 300 Mbit/s to 1000 Mbit/s (with 1000 Mbit/s included).
  • The minimum increment is 500 Mbit/s if the allowed bandwidth is greater than 1000 Mbit/s.

id

No

String

• Bandwidth ID. You can specify an existing shared bandwidth ID when assigning an EIP that uses the bandwidth whose type is WHOLE.
• Value: ID of the bandwidth of type WHOLE

id

No

String

Assigning an EIP by specifying an ID

type

Yes

String

EIP type

Enumerated values:

• 5_bgp
• 5_union
• 5_sbgp

ip_version

No

String

EIP version, for example, IPv4 and IPv6. The default value is ipv4.

enterprise_project_id

No

String

Enterprise project ID

tags

No

Array of ResourceTagOption objects

• Tag list
• Format: The key and value of a tag are separated by an asterisk (*). If there are multiple tags, use commas (,) to separate different key-value pairs. For details, see the request example.

profile

No

BatchProfile object

Order information

key

Yes

String

• Tag key
• Constraints:
  • Cannot be left blank.
  • Can contain a maximum of 128 characters.
  • Can contain letters, digits, underscores (_), and hyphens (-).
  • The tag key of a resource must be unique.

Maximum length: 128

value

Yes

String

• Tag value
• Constraints:
  • Can contain no more than 255 characters.
  • Can contain letters, digits, underscores (_), and hyphens (-).
  • The tag key of a resource must be unique.

Maximum length: 255

user_id

No

String

User ID

product_id

No

String

Product ID

region_id

No

String

Region ID

order_id

No

String

Order ID

job_id

String

Job ID. The netAPI needs to be called to view the job execution status. netAPI: /v1/{project_id}/jobs/{job_id}