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

创建全域弹性公网IP段

功能介绍

创建全域弹性公网IP段

调试

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

URI

POST /v3/{domain_id}/global-eip-segments

表1 路径参数

参数

是否必选

参数类型

描述

domain_id

是

String

最小长度：5

最大长度：32

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

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

参数

是否必选

参数类型

描述

global_eip_segment

是

global_eip_segment object

创建全域弹性公网IP段请求对象信息
表4 global_eip_segment

参数

是否必选

参数类型

描述

name

否

String

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

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

最小长度：0

最大长度：64

description

否

String

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

  • 约束：

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

最小长度：0

最大长度：512

geip_pool_name

是

String

全域弹性公网IP池子名称

最小长度：1

最大长度：64

access_site

是

String

接入点信息

最小长度：1

最大长度：64

mask

是

Integer

掩码长度。取值范围由GET /v3/{domain_id}/global-eip-segments/support-masks接口提供

最小值：1

最大值：128

internet_bandwidth

否

internet_bandwidth object

全域公网带宽

tags

否

Array of tags objects

全域弹性公网IP段标签

enterprise_project_id

否

String

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

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

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

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

最小长度：1

最大长度：36
表5 internet_bandwidth

参数

是否必选

参数类型

描述

id

否

String

全域公网带宽的ID

最小长度：0

最大长度：36

ingress_size

否

Integer

全域公网带宽大小（入云方向）

charge_mode

否

String

计费模式

最小长度：1

最大长度：36

size

否

Integer

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

name

否

String

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

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

最小长度：1

最大长度：64

tags

否

Array of tags objects

全域弹性公网IP段标签

type

否

String

全域公网带宽类型

缺省值：standard

最小长度：1

最大长度：64
表6 tags

参数

是否必选

参数类型

描述

key

是

String

  • 功能说明：标签名称

  • 约束：

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

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

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

最小长度：1

最大长度：36

value

是

String

  • 功能说明：标签值

  • 约束：

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

最小长度：0

最大长度：43
表7 tags

参数

是否必选

参数类型

描述

key

是

String

  • 功能说明：标签名称

  • 约束：

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

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

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

最小长度：1

最大长度：36

value

是

String

  • 功能说明：标签值

  • 约束：

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

最小长度：0

最大长度：43

响应参数

状态码： 201

表8 响应Header参数

参数

参数类型

描述

X-Request-Id

-

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

参数

参数类型

描述

job_id

String

本次请求的job id

global_eip_segment

ShortGlobalEipSegment object

全域弹性公网IP段信息
表10 ShortGlobalEipSegment

参数

参数类型

描述

id

String

全域弹性公网IP段的ID

name

String

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

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

最小长度：1

最大长度：64

请求示例

创建全域弹性公网IP段

POST https://{Endpoint}/v3/{domain_id}/global-eip-segments

{
  "global_eip_segment" : {
    "name" : "geip-48bb",
    "geip_pool_name" : "test_dc_segment",
    "mask" : 26,
    "access_site" : "cn-south-odin",
    "internet_bandwidth" : {
      "name" : "bandwidth-48bb",
      "charge_mode" : "bandwidth",
      "size" : 100,
      "type" : "standard"
    }
  }
}

响应示例

状态码： 201

CREATED

{
  "global_eip_segment" : {
    "id" : "cc3da1f6-fa84-4161-98f9-89e2563dff27",
    "name" : "geip-48bb"
  },
  "job_id" : "784dbb97-2e36-451b-8332-195d198f4160"
}

状态码

状态码

描述

201

CREATED

错误码

请参见错误码。

父主题： 全域弹性公网IP段

相关文档