创建全域公网带宽 - CreateInternetBandwidth

功能介绍

创建全域公网带宽。

调试

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

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

如果使用角色与策略授权，具体权限要求请参见权限和授权项。
如果使用身份策略授权，需具备如下身份策略权限。
授权项
访问级别
资源类型（*为必须）
条件键
别名
依赖的授权项
eip:internetBandwidths:create
Write
internetBandwidth *
-
-
-
-
g:EnterpriseProjectId

授权项	访问级别	资源类型（*为必须）	条件键	别名	依赖的授权项
eip:internetBandwidths:create	Write	internetBandwidth *	-	-	-
-	g:EnterpriseProjectId

URI

POST /v3/{domain_id}/geip/internet-bandwidths

表1 路径参数
参数	是否必选	参数类型	描述
domain_id	是	String	租户账号ID，获取租户账号ID请参见租户账号ID 最小长度：5 最大长度：32

请求参数

表2 请求Header参数
参数	是否必选	参数类型	描述
X-Auth-Token	是	String	用户的Token，如何获取用户Token请参见获取用户Token

表3 请求Body参数
参数	是否必选	参数类型	描述
internet_bandwidth	是	internet_bandwidth object	全域公网带宽信息

表4 internet_bandwidth
参数	是否必选	参数类型	描述
ingress_size	否	Integer	全域公网带宽大小（入云方向），具体取值范围以购买页面为准最小值：1
charge_mode	是	String	功能说明：计费模式，客户支持的计费类型可通过全域公网带宽限制列表接口查询。约束与限制：95计费需要满足一定条件才可使用，具体请见计费类。取值范围： bandwidth(按带宽计费) traffic(按流量计费) 95peak_plus_1000(按增强型95计费) 95peak_bidirection(按双向型传统95计费) 95peak_guar(带保底传统型95计费) 95peak_avr(95峰值平均计费)
isp	是	String	全域公网带宽接入的线路，接入线路信息可通过查询全域弹性公网IP池列表接口查询。最小长度：1 最大长度：64
access_site	是	String	接入点信息，具体接入点信息可通过查询接入点列表接口查询。最小长度：1 最大长度：64
size	是	Integer	全域公网带宽大小（出云方向），具体取值范围以购买页面为准最小值：1
name	否	String	功能说明：全域公网带宽名称取值范围：1-64，支持数字、字母、中文、_(下划线)、-（中划线）、.（点）最小长度：1 最大长度：64
description	否	String	功能说明：用户自定义的资源描述约束与限制：值的长度最大512字符，由数字、字母、中文、_(下划线)、-（中划线）、.（点）组成。最小长度：0 最大长度：512
tags	否	Array of tags objects	全域公网带宽标签
enterprise_project_id	否	String	企业项目ID。最大长度36字节，带“-”连字符的UUID格式，或者是字符串“0”。创建全域公网带宽时，给全域公网带宽绑定企业项目ID。不指定该参数时，默认值是 0 关于企业项目ID的获取及企业项目特性的详细信息，请参见《企业管理用户指南》。最小长度：1 最大长度：36
type	否	String	全域公网带宽类型缺省值：standard 最小长度：1 最大长度：64

表5 tags
参数	是否必选	参数类型	描述
key	是	String	功能说明：标签名称约束与限制：同一资源的key值不能重复，创建的预定义标签如果与已有的预定义标签完全相同，则会覆盖已有的预定义标签。键的长度最大128字符，由英文字母、数字、下划线、中划线、中文字符组成。单个资源最多可以添加20个标签。最小长度：1 最大长度：128
value	是	String	功能说明：标签值约束与限制：值的长度最大255字符，由英文字母、数字、下划线、点、中划线、中文字符组成。最小长度：0 最大长度：255

响应参数

状态码：201

表6 响应Header参数
参数	参数类型	描述
X-Request-Id	String	本次请求编号

表7 响应Body参数
参数	参数类型	描述
request_id	String	本次请求的编号
internet_bandwidth	CreateInternetBandwidth object	创建全域公网带宽成功响应体

表8 CreateInternetBandwidth
参数	参数类型	描述
id	String	全域公网带宽的ID
name	String	功能说明：全域公网带宽名称取值范围：1-64，支持数字、字母、中文、_(下划线)、-（中划线）、.（点）最小长度：1 最大长度：64
ingress_size	Integer	全域公网带宽大小（入云方向）
isp	String	全域公网带宽接入的线路，接入线路信息可通过查询全域弹性公网IP池列表接口查询。
access_site	String	接入点信息，具体接入点信息可通过查询接入点列表接口查询。
size	Integer	全域公网带宽大小（出云方向）
description	String	功能说明：用户自定义的资源描述约束与限制：值的长度最大512字符，由数字、字母、中文、_(下划线)、-（中划线）、.（点）组成。最小长度：0 最大长度：512
charge_mode	String	功能说明：计费模式，客户支持的计费类型可通过全域公网带宽限制列表接口查询。约束与限制：95计费需要满足一定条件才可使用，具体请见计费类。取值范围： bandwidth(按带宽计费) traffic(按流量计费) 95peak_plus_1000(按增强型95计费) 95peak_bidirection(按双向型传统95计费) 95peak_guar(带保底传统型95计费) 95peak_avr(95峰值平均计费)
ratio_95peak	Integer	增强95保底率
freezen_info	String	冻结原因
domain_id	String	租户账号ID，获取租户账号ID请参见租户账号ID
billing_info	String	包周期时有值，订单信息
status	String	状态
is_pre_paid	Boolean	是否包周期
is_change_service	Boolean	是否切换服务到VPC
created_at	String	创建时间
updated_at	String	更新时间
tags	Array of Tag objects	全域公网带宽标签
enterprise_project_id	String	企业项目ID。最大长度36字节，带“-”连字符的UUID格式，或者是字符串“0”。创建全域公网带宽时，给全域公网带宽绑定企业项目ID。不指定该参数时，默认值是 0 关于企业项目ID的获取及企业项目特性的详细信息，请参见《企业管理用户指南》。
type	String	全域公网带宽类型

表9 Tag
参数	参数类型	描述
key	String	功能说明：标签名称约束与限制：同一资源的key值不能重复，创建的预定义标签如果与已有的预定义标签完全相同，则会覆盖已有的预定义标签。键的长度最大128字符，由英文字母、数字、下划线、中划线、中文字符组成。单个资源最多可以添加20个标签。最小长度：1 最大长度：128
value	String	功能说明：标签值约束与限制：值的长度最大255字符，由英文字母、数字、下划线、点、中划线、中文字符组成。最小长度：0 最大长度：255

请求示例

创建一个按带宽计费，大小为80的全域公网带宽

POST https://{Endpoint}/v3/{domain_id}/geip/internet-bandwidths

{
  "internet_bandwidth" : {
    "access_site" : "cn-south-odin",
    "charge_mode" : "bandwidth",
    "isp" : "BGP",
    "size" : 80,
    "type" : "standard",
    "name" : "test"
  }
}

响应示例

状态码：201

CREATED

{
  "internet_bandwidth" : {
    "enterprise_project_id" : 0,
    "name" : "test",
    "id" : "cce4b43d-c92c-4845-8065-8c2cdd1a1881",
    "isp" : "BGP",
    "access_site" : "cn-south-odin",
    "size" : 80,
    "description" : null,
    "charge_mode" : "bandwidth",
    "freezen_info" : null,
    "domain_id" : "f35feb8670a94a04a08d6628e0d5165b",
    "is_pre_paid" : false,
    "is_change_service" : false,
    "billing_info" : null,
    "status" : "normal",
    "ratio_95peak" : 0,
    "ingress_size" : 80,
    "tags" : [ ],
    "type" : "standard"
  },
  "request_id" : "8bcadb5d-1bf4-42e8-909f-1606ecf781ce"
}