Help Center> Elastic IP > API Reference> API V3> Shared Bandwidth Types> Querying Shared Bandwidth Types of a Specified Tenant
Updated on 2023-03-17 GMT+08:00

Querying Shared Bandwidth Types of a Specified Tenant

Function

This API is used to query shared bandwidth types of a specified tenant.

URI

GET /v3/{project_id}/eip/share-bandwidth-types

Table 1 Path parameter

Parameter

Mandatory

Type

Description

project_id

Yes

String

  • Project ID.

Minimum length: 0

Maximum length: 32

Table 2 Query parameters

Parameter

Mandatory

Type

Description

fields

No

String

  • Field. Format: "fields=id&fields=bandwidth_type&..."
  • Supported fields: id, bandwidth_type, name_en, name_zh, created_at, update_at, public_border_group, and description.

Minimum length: 0

Maximum length: 1024

id

No

String

  • Bandwidth type ID.

Minimum length: 0

Maximum length: 36

bandwidth_type

No

String

  • Bandwidth type.

Minimum length: 1

Maximum length: 36

name_en

No

String

  • Bandwidth type in English.

Minimum length: 0

Maximum length: 256

name_zh

No

String

  • Bandwidth type in Chinese.

Minimum length: 0

Maximum length: 256

public_border_group

No

String

  • Whether the bandwidth type is in a central region or an edge site.

Minimum length: 0

Maximum length: 36

sort_key

No

String

  • Sort. Format: "sort_key=id&sort_dir=asc"
  • Supported fields: id, bandwidth_type, and public_border_group.

Minimum length: 0

Maximum length: 1024

sort_dir

No

String

  • Sorting direction.
  • The value can be asc or desc

Minimum length: 0

Maximum length: 1024

limit

No

Integer

  • Number of records returned on each page.
  • The value ranges from 0 to 2,000. The maximum value varies by region.

Minimum value: 0

Maximum value: 2000

Request Parameter

Table 3 Request header parameter

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

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.

Minimum length: 0

Maximum length: 4096

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

share_bandwidth_types

Array of ShareBandwidthTypeShowResp objects

Shared bandwidth type.

request_id

String

Request ID.

page_info

PageInfoOption object

Pagination page number information.

Table 5 ShareBandwidthTypeShowResp

Parameter

Type

Description

id

String

Bandwidth type ID.

Minimum length: 0

Maximum length: 36

bandwidth_type

String

Bandwidth type.

Minimum length: 0

Maximum length: 36

public_border_group

String

Central region or edge site. The parameter is displayed by default.

Minimum length: 0

Maximum length: 64

created_at

String

Assigning time

Minimum length: 0

Maximum length: 64

updated_at

String

Update time

Minimum length: 0

Maximum length: 64

name_en

String

Bandwidth type in English.

Minimum length: 0

Maximum length: 256

name_zh

String

Bandwidth type in Chinese.

Minimum length: 0

Maximum length: 256

description

String

Bandwidth type description.

Minimum length: 0

Maximum length: 1024

Table 6 PageInfoOption

Parameter

Type

Description

previous_marker

String

Marker value of the previous page.

Minimum length: 0

Maximum length: 36

next_marker

String

Marker value of the next page.

Minimum length: 0

Maximum length: 36

current_count

Integer

Total number of data records on the current page.

Minimum value: 0

Maximum value: 99999

Example Request

None

Example Response

Status code: 200

Normal response to the GET operation

{
  "share_bandwidth_types" : [ {
    "id" : "1b478471-eaf1-4a71-9c77-edba89f62016",
    "bandwidth_type" : "share",
    "name_en" : "share_bandwidth_type",
    "description" : null,
    "created_at" : "2021-09-29T04:19:22Z",
    "updated_at" : "2021-09-29T04:19:22Z",
    "public_border_group" : "center"
  }, {
    "id" : "2bbb2990-e908-46a7-b664-03d3084af032",
    "bandwidth_type" : "edgeshare",
    "name_en" : "edge_share_bandwidth_type",
    "description" : null,
    "created_at" : "2021-09-29T04:19:22Z",
    "updated_at" : "2021-09-29T04:19:22Z",
    "public_border_group" : "az1"
  } ],
  "request_id" : "07f05e3d-b688-43f8-bda2-e9d10d2352e9",
  "page_info" : {
    "previous_marker" : "1b478471-eaf1-4a71-9c77-edba89f62016",
    "current_count" : 2
  }
}

Status Codes

See Status Codes.

Error Codes

See Error Codes.