Updated on 2024-12-27 GMT+08:00

Changing the Bandwidth of an Attachment

Function

This API is used to change the bandwidth of an attachment.

Calling Method

For details, see Calling APIs.

URI

POST /v3/{project_id}/enterprise-router/{er_id}/attachments/{attachment_id}/change-bandwidths

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID

er_id

Yes

String

Enterprise router ID

attachment_id

Yes

String

Attachment ID

Request Parameters

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

bandwidth

No

Bandwidth object

Bandwidth request body

Table 3 Bandwidth

Parameter

Mandatory

Type

Description

size

No

Integer

Bandwidth, in Mbit/s. The default value is 0, indicating that the bandwidth is not limited. The value -1 indicates that the bandwidth is limited to 2 kbit/s.

Minimum: -1

Default: 0

Response Parameters

Status code: 202

Table 4 Response body parameters

Parameter

Type

Description

attachment

AttachmentResponse object

Attachment basic information

request_id

String

Request ID

Table 5 AttachmentResponse

Parameter

Type

Description

name

String

Attachment name

id

String

Attachment ID

description

String

Description

state

String

Attachment status. Value options: pending, available, modifying, deleting, deleted, failed, pending_acceptance, rejected, and initiating_request

created_at

String

Creation time in the format of YYYY-MM-DDTHH:mm:ss.sssZ

updated_at

String

Update time in the format of YYYY-MM-DDTHH:MM:SS

tags

Array of Tag objects

Enterprise router tags

project_id

String

Project ID

resource_id

String

Attached resource ID on its own service console

resource_type

String

Attachment type.

  • vgw: virtual gateway attachment

  • vpn: VPN gateway attachment

  • gdgw: global DC gateway attachment

  • vpc: VPC attachment

resource_project_id

String

ID of the project that the resource belongs to

Table 6 Tag

Parameter

Type

Description

key

String

Tag key.

  • A tag key can contain letters, digits, spaces encoded using UTF-8, and special characters _.:=+-@

  • A tag key cannot be left blank.

  • A tak key can contain 1 to 128 characters.

  • Tags with the tag key starting with sys are system tags and cannot be added by tenants.

Minimum: 1

Maximum: 128

value

String

Tag value.

  • A tag value can contain letters, digits, spaces encoded using UTF-8, and special characters _.:=+-@

  • A tag value can be left blank or set to null.

  • A tag value can contain 0 to 255 characters.

Minimum: 0

Maximum: 255

Example Requests

Changing the bandwidth of an attachment

PUT https://{erouter_endpoint}/v3/08d5a9564a704afda6039ae2babbef3c/enterprise-router/212d3f0b-8496-472d-bc99-05a7c96d6655/attachments/b70aee08-c671-4cad-9fd5-7381d163bcc8/change-bandwidths

{
  "bandwidth" : {
    "size" : 200
  }
}

Example Responses

Status code: 202

Accepted

{
  "attachment" : {
    "id" : "b70aee08-c671-4cad-9fd5-7381d163bcc8",
    "name" : "attachment",
    "description" : "attachment",
    "state" : "avaliable",
    "created_at" : "2020-03-11T15:13:31Z",
    "updated_at" : "2020-03-11T15:13:31Z",
    "project_id" : "08d5a9564a704afda6039ae2babbef3c",
    "resource_id" : "b715e131-3371-4e17-a2de-4f669e24439a",
    "resource_type" : "connect",
    "resource_project_id" : "0605767a9980d5762fbcc00b3537e757"
  },
  "request_id" : "915a14a6-867b-4af7-83d1-70efceb146f9"
}

Status Codes

Status Code

Description

202

Accepted

Error Codes

See Error Codes.