查询全域弹性公网IP详情 - ShowGlobalEip

功能介绍

查询全域弹性公网IP详情。

调试

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

授权信息

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

如果使用角色与策略授权，具体权限要求请参见权限和授权项。
如果使用身份策略授权，需具备如下身份策略权限。
授权项
访问级别
资源类型（*为必须）
条件键
别名
依赖的授权项
eip:globalEips:get
Read
globalEip *
g:ResourceTag/<tag-key>
g:EnterpriseProjectId
-
-

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

URI

GET /v3/{domain_id}/global-eips/{global_eip_id}

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

表2 Query参数
参数	是否必选	参数类型	描述
fields	否	Array of strings	功能说明：查询指定的字段，格式为fields=A&fields=B&fields=C&...... 支持的字段： id name description domain_id access_site geip_pool_name isp ip_version ip_address ipv6_address freezen freezen_info polluted status created_at updated_at internet_bandwidth_info global_connection_bandwidth_info associate_instance_info is_pre_paid tags sys_tags enterprise_project_id

请求参数

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

响应参数

状态码：200

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

表5 响应Body参数
参数	参数类型	描述
request_id	String	本次请求的编号
global_eip	ShowGlobalEip object	弹性公网IP详情响应对象

表6 ShowGlobalEip
参数	参数类型	描述
id	String	全域弹性公网IP的ID
name	String	功能说明：全域弹性公网IP名称取值范围：1-64，支持数字、字母、中文、_(下划线)、-（中划线）、.（点）最小长度：1 最大长度：64
description	String	功能说明：用户自定义的资源描述约束与限制：值的长度最大512字符，由数字、字母、中文、_(下划线)、-（中划线）、.（点）组成。最小长度：0 最大长度：512
domain_id	String	租户账号ID，获取租户账号ID请参见租户账号ID
access_site	String	接入点信息
geip_pool_name	String	全域弹性公网IP池子名称
isp	String	全域公网带宽接入的线路，接入线路信息可通过查询全域弹性公网IP池列表接口查询。
ip_version	Integer	功能说明：全域弹性公网IP的版本取值范围：4、6
ip_address	String	IPv4地址
ipv6_address	String	IPv6地址
freezen	Boolean	是否冻结
freezen_info	String	冻结原因
polluted	Boolean	是否污染
is_charged	Boolean	是否收费
status	String	状态
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的获取及企业项目特性的详细信息，请参见《企业管理用户指南》。

表7 InternetBandwidthInfo
参数	参数类型	描述
id	String	全域公网带宽的ID
size	Integer	全域公网带宽大小（出云方向）

表8 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值

表9 InstanceInfo
参数	参数类型	描述
region	String	站点信息
project_id	String	项目ID，获取项目ID请参见获取项目ID
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	绑定实例所在的站点

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

请求示例

查询id为393f69a0-e007-45ee-89f0-872d11620f31的全域弹性公网IP详情

GET https://{Endpoint}/v3/{domain_id}/global-eips/393f69a0-e007-45ee-89f0-872d11620f31

响应示例

状态码：200

{
  "request_id" : "da346cb858ae8d335a6f6b45edbc4836",
  "global_eip" : {
    "enterprise_project_id" : 0,
    "name" : "geip-f833",
    "created_at" : "2023-12-11T09:44:44Z",
    "updated_at" : "2023-12-11T09:44:45Z",
    "id" : "393f69a0-e007-45ee-89f0-872d11620f31",
    "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,
    "is_charged" : true,
    "tags" : [ {
      "key" : "tag1",
      "value" : "tom"
    } ],
    "ip_address" : "10.83.68.92",
    "ipv6_address" : null,
    "polluted" : false,
    "internet_bandwidth_info" : {
      "id" : "63d8437d-e0b4-4704-967c-1bc74e5926ef",
      "size" : 100
    },
    "global_connection_bandwidth_info" : null,
    "associate_instance_info" : null
  }
}