创建全域弹性公网IP - CreateGlobalEip

功能介绍

创建全域弹性公网IP。

调试

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

授权信息

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

如果使用角色与策略授权，具体权限要求请参见权限和授权项。

如果使用身份策略授权，需具备如下身份策略权限。

授权项	访问级别	资源类型（*为必须）	条件键	别名	依赖的授权项
eip:globalEips:create	Write	globalEip *	-	-	-
eip:globalEips:create	Write	-	g:EnterpriseProjectId g:RequestTag/<tag-key> g:TagKeys	-	-

URI

POST /v3/{domain_id}/global-eips

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

请求参数

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

表3 请求Body参数
参数	是否必选	参数类型	描述
global_eip	是	global_eip object	请求体信息

表4 global_eip
参数	是否必选	参数类型	描述
name	否	String	功能说明：全域弹性公网IP名称取值范围：1-64，支持数字、字母、中文、_(下划线)、-（中划线）、.（点）
description	否	String	功能说明：用户自定义的资源描述约束与限制：值的长度最大512字符，由数字、字母、中文、_(下划线)、-（中划线）、.（点）组成。最小长度：0 最大长度：512
geip_pool_name	是	String	全域弹性公网IP池名称，可通过查询全域弹性公网IP池列表接口查询。最小长度：1 最大长度：64
access_site	是	String	接入点信息最小长度：1 最大长度：64
internet_bandwidth_id	否	String	参数解释：全域公网带宽的ID。取值范围：长度为[32-36]个字符
tags	否	Array of tags objects	全域弹性公网IP标签
enterprise_project_id	否	String	企业项目ID。最大长度36字节，带“-”连字符的UUID格式，或者是字符串“0”。创建全域弹性公网IP时，给全域弹性公网IP绑定企业项目ID。不指定该参数时，默认值是 0 关于企业项目ID的获取及企业项目特性的详细信息，请参见《企业管理用户指南》。最小长度：1 最大长度：36

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

响应参数

状态码：201

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

表7 响应Body参数
参数	参数类型	描述
job_id	String	本次请求的job id
global_eip	CreateGlobalEip object	创建成功返回的响应对象

表8 CreateGlobalEip
参数	参数类型	描述
id	String	全域弹性公网IP的ID
name	String	功能说明：全域弹性公网IP名称取值范围：1-64，支持数字、字母、中文、_(下划线)、-（中划线）、.（点）最小长度：1 最大长度：64

请求示例

创建全域弹性公网IP

POST https://{Endpoint}/v3/{domain_id}/global-eips

{
  "global_eip" : {
    "access_site" : "cn-south-odin",
    "geip_pool_name" : "cn-south-odin",
    "internet_bandwidth_id" : "0571f097-f50e-4a65-9c53-bd6361ba6f6d",
    "name" : "geip-981f"
  }
}

响应示例

状态码：201

CREATED

{
  "global_eip" : {
    "id" : "16392308-2b92-4c2c-8935-296e5dfbe487",
    "name" : "geip-981f"
  },
  "job_id" : "1318b3c3-75a1-46e7-845f-0562d07de7e0"
}