文档首页/ 弹性公网IP EIP/ API参考/ GEIP API/ 全域弹性公网IP/ 绑定全域公网带宽
更新时间：2024-04-26 GMT+08:00
查看PDF
分享

绑定全域公网带宽

功能介绍

绑定全域公网带宽

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

URI

POST /v3/{domain_id}/global-eips/{global_eip_id}/attach-internet-bandwidth

表1 路径参数

参数

是否必选

参数类型

描述

domain_id

是

String

最小长度：5

最大长度：32

global_eip_id

是

String

global_eip_id

最小长度：36

最大长度：36

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户的Token，如何获取用户Token请参见获取用户Token
表3 请求Body参数

参数

是否必选

参数类型

描述

global_eip

是

global_eip object

请求参数对象
表4 global_eip

参数

是否必选

参数类型

描述

internet_bandwidth_id

是

String

全域公网带宽的ID

最小长度：32

最大长度：36

响应参数

状态码： 200

表5 响应Header参数

参数

参数类型

描述

X-Request-Id

-

本次请求编号
表6 响应Body参数

参数

参数类型

描述

request_id

String

本次请求的编号

global_eip

AttachInternetBandwidthGlobalEip object

全域弹性公网IP信息
表7 AttachInternetBandwidthGlobalEip

参数

参数类型

描述

id

String

全域弹性公网IP的ID

name

String

  • 功能说明：全域弹性公网IP名称

  • 取值范围：1-64，支持数字、字母、中文、_(下划线)、-（中划线）、.（点）

最小长度：1

最大长度：64

domain_id

String

description

String

  • 功能说明：用户自定义的资源描述

  • 约束：

    • 值的长度最大512字符，由数字、字母、中文、_(下划线)、-（中划线）、.（点）组成。

最小长度：0

最大长度：512

access_site

String

接入点信息

geip_pool_name

String

全域弹性公网IP池子名称

isp

String

接入线路

ip_version

Integer

  • 功能说明：全域弹性公网IP的版本

  • 取值范围：4、6

枚举值：

  • 4

  • 6

ip_address

String

IPv4地址

ipv6_address

String

IPv6地址

freezen

Boolean

是否冻结

freezen_info

String

冻结原因

polluted

Boolean

是否污染

status

String

状态

枚举值：

  • PENDING_CREATE

  • IDLE

  • INUSE

  • PENDING_UPDATE

created_at

String

创建时间

updated_at

String

更新时间

internet_bandwidth_info

InternetBandwidthInfo object

全域公网带宽信息

global_connection_bandwidth_info

GlobalConnectionBandwidthInfo object

全域互联带宽信息

associate_instance_info

InstanceInfo object

绑定实例的信息

is_pre_paid

Boolean

是否包周期

tags

Array of Tag objects

全域弹性公网IP标签

enterprise_project_id

String

  • 企业项目ID。最大长度36字节，带“-”连字符的UUID格式，或者是字符串“0”。

  • 创建全域弹性公网IP时，给全域弹性公网IP绑定企业项目ID。

  • 不指定该参数时，默认值是 0

  • 关于企业项目ID的获取及企业项目特性的详细信息，请参见《企业管理用户指南》。
表8 InternetBandwidthInfo

参数

参数类型

描述

id

String

全域公网带宽的ID

size

Integer

全域公网带宽大小（出云方向）
表9 GlobalConnectionBandwidthInfo

参数

参数类型

描述

gcb_id

String

骨干带宽的ID

size

Integer

骨干带宽的大小

gcb_type

String

骨干带宽类型（城域、区域和大区）

admin_state

String

  • 功能说明：骨干带宽状态

  • 取值范围：NORMAL 正常、FREEZED 冻结

sla_level

String

  • 功能说明：网络服务等级

  • 取值范围：Pt - 铂金，Au - 金牌，Ag - 银牌，Cu - 铜牌

dscp

Integer

线路质量金银铜对应的DSCP值
表10 InstanceInfo

参数

参数类型

描述

region

String

站点信息

project_id

String

instance_type

String

支持绑定的实例类型

instance_id

String

实例ID

service_type

String

  • 功能说明：绑定实例的服务类型

  • 约束：

    • 该值由调用方传递，非必选，目前绑定CCI服务时会传

service_id

String

  • 功能说明：绑定实例的服务ID

  • 约束：

    • 该值由调用方传递，非必选，目前绑定CCI服务时会传

public_border_group

String

  • 功能说明：表示中心站点资源或者边缘站点资源

  • 取值范围：center、边缘站点名称

最小长度：1

最大长度：64

instance_site

String

绑定实例所在的站点
表11 Tag

参数

参数类型

描述

key

String

  • 功能说明：标签名称

  • 约束：

    • 同一资源的key值不能重复，创建的预定义标签如果与已有的预定义标签完全相同，则会覆盖已有的预定义标签。

    • 键的长度最大36字符，由英文字母、数字、下划线、中划线、中文字符组成。

    • 单个资源最多可以添加20个标签。

最小长度：1

最大长度：36

value

String

  • 功能说明：标签值

  • 约束：

    • 值的长度最大43字符，由英文字母、数字、下划线、点、中划线、中文字符组成。

最小长度：0

最大长度：43

请求示例

绑定全域公网带宽

POST https://{Endpoint}/v3/{domain_id}/global-eips/dad6a045-c939-456c-92f2-3c41b0750260/attach-internet-bandwidth

{
  "global_eip" : {
    "internet_bandwidth_id" : "d916aba2-eb1f-415f-9463-b72dcbf537f8"
  }
}

响应示例

状态码： 200

OK

{
  "global_eip" : {
    "enterprise_project_id" : 0,
    "name" : "geip-981s-0002",
    "created_at" : "2023-12-12T07:53:59Z",
    "updated_at" : "2023-12-12T08:07:01Z",
    "id" : "dad6a045-c939-456c-92f2-3c41b0750260",
    "description" : null,
    "domain_id" : "f35feb8670a94a04a08d6628e0d5165b",
    "access_site" : "cn-south-odin",
    "geip_pool_name" : "cn-south-odin",
    "isp" : "BGP",
    "ip_version" : 4,
    "freezen" : false,
    "status" : "idle",
    "freezen_info" : null,
    "is_pre_paid" : false,
    "tags" : [ ],
    "ip_address" : "10.83.68.72",
    "ipv6_address" : null,
    "polluted" : false,
    "internet_bandwidth_info" : {
      "id" : "d916aba2-eb1f-415f-9463-b72dcbf537f8",
      "size" : 50
    },
    "global_connection_bandwidth_info" : null,
    "associate_instance_info" : null
  },
  "request_id" : "2fee4b49a8fb7b93ed419b9ba7433354"
}

状态码

状态码

描述

200

OK

错误码

请参见错误码。

父主题： 全域弹性公网IP

相关文档