Help Center> Elastic IP > API Reference> APIs> Bandwidth (V2.0)> Assigning a Shared Bandwidth
Updated on 2023-03-17 GMT+08:00

Assigning a Shared Bandwidth

Function

This API is used to assign a shared bandwidth.

URI

POST /v2.0/{project_id}/bandwidths

Table 1 describes the parameters.
Table 1 Parameter description

Name

Mandatory

Description

project_id

Yes

Specifies the project ID. For details about how to obtain a project ID, see Obtaining a Project ID.

Request Message

  • Request parameter
    Table 2 Request header parameter

    Parameter

    Mandatory

    Type

    Description

    X-Auth-Token

    Yes

    String

    Specifies the user token. The token can be obtained by calling the IAM API used for obtaining a user token. The value of X-Subject-Token in the response header is the user token.

    Table 3 Request parameter

    Name

    Mandatory

    Type

    Description

    bandwidth

    Yes

    bandwidth object

    Specifies the bandwidth objects. For details, see Table 4.

    Table 4 Description of the bandwidth field

    Name

    Mandatory

    Type

    Description

    name

    Yes

    String

    • Specifies the bandwidth name.
    • The value can contain 1 to 64 characters, including letters, digits, underscores (_), hyphens (-), and periods (.).

    size

    Yes

    Integer

    • Specifies the bandwidth size. The shared bandwidth has a minimum limit, which may vary depending on sites. The default minimum value is 5 Mbit/s.
    • The value ranges from 1 Mbit/s to 300 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.)
    • If a decimal fraction (for example 10.2) or a character string (for example "10") is specified, the specified value will be automatically converted to an integer.
    • 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.

    enterprise_project_id

    No

    String

    • Specifies the enterprise project ID. The value is 0 or a string that contains a maximum of 36 characters in UUID format with hyphens (-). Value 0 indicates the default enterprise project.
    • When creating a shared bandwidth, associate the enterprise project ID with the shared bandwidth.
    NOTE:

    For more information about enterprise projects and how to obtain enterprise project IDs, see the Enterprise Management User Guide.

    public_border_group

    No

    String

    Specifies whether it is in a central site or an edge site.

    Values:

    • center
    • Edge site name

    This resource can only be associated with an EIP of the same region.

    bandwidth_type

    No

    String

    • Specifies the type of the bandwidth to be created.
    • For details about supported types of bandwidth, see Querying a Bandwidth.
      By default:
      • Central region: share
      • Edge site: edgeshare
  • Example request
    POST https://{Endpoint}/v2.0/{project_id}/bandwidths
    
    {
        "bandwidth": {
            "name": "bandwidth123",
            "size": 10
        }
    }

Response Message

  • Response parameter
    Table 5 Response parameter

    Name

    Type

    Description

    bandwidth

    bandwidth object

    Specifies the bandwidth objects. For details, see Table 6.

    Table 6 Description of the bandwidth field

    Name

    Type

    Description

    name

    String

    • Specifies the bandwidth name.
    • The value can contain 1 to 64 characters, including letters, digits, underscores (_), hyphens (-), and periods (.).

    size

    Integer

    • Specifies the bandwidth size.
    • The value ranges from 1 Mbit/s to 300 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.)

    id

    String

    Specifies the bandwidth ID, which uniquely identifies the bandwidth.

    share_type

    String

    • Specifies whether the bandwidth is shared or dedicated.
    • The value can be PER or WHOLE.
      • WHOLE: Shared bandwidth
      • PER: Dedicated bandwidth

    publicip_info

    Array of publicip_info objects

    • Specifies information about the EIP that uses the bandwidth. For details, see Table 7.
    • The bandwidth, whose type is WHOLE, can be used by multiple EIPs. The bandwidth, whose type is PER, can be used by only one EIP.

    tenant_id

    String

    Specifies the project ID.

    bandwidth_type

    String

    • Specifies the bandwidth type. The default value for the shared bandwidth is share.
    • The value can be share, bgp, or sbgp.
      • share: Shared bandwidth
      • bgp: Dynamic BGP
      • sbgp: Static BGP

    charge_mode

    String

    • Specifies whether the bandwidth is billed by traffic or by bandwidth size.
    • Possible values can be bandwidth (billed by bandwidth) and traffic (billed by traffic). If the value is an empty character string or no value is specified, value bandwidth is used.
    • The shared bandwidth can be billed only by bandwidth.

    billing_info

    String

    Specifies the bill information.

    If billing_info is specified, the bandwidth is in yearly/monthly billing mode.

    enterprise_project_id

    String

    • Specifies the enterprise project ID. The value is 0 or a UUID that can contain a maximum of 36 characters, including hyphens (-). Value 0 indicates the default enterprise project.
    • When creating a shared bandwidth, associate the enterprise project ID with the shared bandwidth.
    NOTE:

    For more information about enterprise projects and how to obtain enterprise project IDs, see the Enterprise Management User Guide.

    status

    String

    • Specifies the bandwidth status.
    • Possible values are as follows:
      • FREEZED (Frozen)
      • NORMAL (Normal)

    created_at

    String

    • Specifies the time (UTC) when the bandwidth is created.
    • Format: yyyy-MM-ddTHH:mm:ss

    updated_at

    String

    • Specifies the time (UTC) when the bandwidth is updated.
    • Format: yyyy-MM-ddTHH:mm:ss

    enable_bandwidth_rules

    boolean

    • Specifies whether to enable QoS.
    • The value can be true or false.

    rule_quota

    integer

    Specifies the maximum number of grouping rules supported by the bandwidth.

    bandwidth_rules

    Array of bandwidth_rules objects

    Specifies the bandwidth rules.

    public_border_group

    String

    Specifies whether it is in a central site or an edge site.

    Values:

    • center
    • Edge site name

    This resource can only be associated with an EIP of the same region.

    Table 7 publicip_info object

    Name

    Type

    Description

    publicip_id

    String

    Specifies the ID of the EIP that uses the bandwidth.

    publicip_address

    String

    Specifies the obtained EIP if only IPv4 EIPs are available.

    publicipv6_address

    String

    Specifies the obtained EIP if IPv6 EIPs are available. This parameter does not exist if only IPv4 EIPs are available.

    ip_version

    Integer

    • Specifies the IP address version.
    • Possible values are as follows:
      • 4: IPv4 address
      • 6: IPv6 address

    publicip_type

    String

    • Specifies the EIP type.
    • The value can be 5_bgp.
    • Constraints:
      • The configured value must be supported by the system.
      • publicip_id is an IPv4 port. If publicip_type is not specified, the default value is 5_bgp.
    Table 8 bandwidth_rules object

    Name

    Type

    Description

    id

    string

    Specifies the bandwidth rule ID.

    name

    string

    Specifies the name of the bandwidth rule.

    admin_state_up

    boolean

    Specifies the configuration status. The value False indicates that the configuration does not take effect.

    egress_size

    integer

    • Specifies the maximum outbound bandwidth in Mbit/s.
    • The value range ranges from 0 to n, where n indicates the shared bandwidth size. If the value is set to 0, the maximum bandwidth, that is the shared bandwidth size will be used.

    egress_guarented_size

    integer

    • Specifies the guaranteed outbound bandwidth in Mbit/s.
    • The value ranges from 0 to x, where x indicates the remaining bandwidth.

    publicip_info

    Array of publicip_info objects

    • Specifies the EIP associated with the bandwidth.
    • The bandwidth, whose type is set to WHOLE, can be used by multiple EIPs. The bandwidth, whose type is set to PER, can be used by only one EIP.
  • Example response
    {
      "bandwidth": {
        "id": "1bffc5f2-ff19-45a6-96d2-dfdca49cc387",
        "name": "bandwidth123",
        "size": 10,
        "share_type": "WHOLE",
        "publicip_info": [],
        "tenant_id": "26ae5181a416420998eb2093aaed84d9",
        "bandwidth_type": "share",
        "charge_mode": "bandwidth",
        "billing_info": "",
        "enterprise_project_id": "0",
        "status": "NORMAL",
        "created_at": "2020-04-21T07:58:02Z", 
        "updated_at": "2020-04-21T07:58:02Z",
        "enable_bandwidth_rules": false,
        "rule_quota": 0,
        "bandwidth_rules": [],
      }
    }

Status Code

See Status Codes.

Error Code

See Error Codes.