获取弹性公网IP详情--边缘计算节点-火山引擎

文档中心

立即注册

导航

边缘计算节点

获取弹性公网IP详情

最近更新时间：2024.07.08 16:21:01首次发布时间：2022.02.25 18:58:31

本接口用于获取弹性公网 IP 详情。

请求说明

请求方式：GET
请求地址：https://veenedge.volcengineapi.com/?Action=GetEIPInstance&Version=2021-04-30

请求参数

下表列出了接口特定的请求参数以及公共请求参数 Action 和 Version。其他公共参数，请参见公共参数。

Query

参数	类型	是否必选	示例值	描述
Action	String	是	GetEIPInstance	公共参数。该参数表示接口名称。取值：GetEIPInstance
Version	String	是	2021-04-30	公共参数。该参数表示接口版本。取值：2021-04-30。
eip_identity	String	是	eip-wqjgxf****	弹性公网 IP 的 ID。您可以通过 ListEIPInstances 接口查询弹性公网 IP 的 ID。
with_binder_info	Boolean	否	false	是否列出绑定的实例。 true：列出绑定的实例。 false（默认值）：不列出绑定的实例。

返回参数

参数	类型	示例值	描述
eip	EIPInstance	请参见返回示例	弹性公网 IP 的详情。

请求示例

GET https://veenedge.volcengineapi.com/?Action=GetEIPInstance&Version=2021-04-30
&eip_identity=eip-lkzspn****
&with_binder_info=true
&<其他公共参数>

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230524152653F89C28C06703A6A4****",
        "Action": "GetEIPInstance",
        "Version": "2021-04-30",
        "Service": "veenedge",
        "Region": "cn-north-1"
    },
    "Result": {
        "eip_instance": {
            "account_identity": 210000****,
            "user_identity": 0,
            "eip_identity": "eip-lkzspn****",
            "eip_name": "**ct02-CTCC",
            "cluster": {
                "cluster_name": "**ct02",
                "country": "CN",
                "region": "EastChina",
                "province": "ZJ",
                "city": "330600",
                "isp": "CTCC",
                "level": "3",
                "alias": "**电信01"
            },
            "eip_type": "IPv4",
            "eip_addr": "115.**.**.4",
            "bandwidth_peak": 20,
            "isp": "CTCC",
            "network_type": "public",
            "binder_resource": {
                "resource_type": "lb",
                "resource_identity": "veew-lb1047700072022322****",
                "resource_name": "HJ_TEST",
                "resource_vpc_identity": "vpc-s8fnxb****",
                "resource_vpc_name": "**电信01-默认VPC",
                "resource_vpc_subnet_cidrs": [
                    "172.**.**.64/26"
                ]
            },
            "status": "bound",
            "desc": "",
            "billing_config": {
                "ip_billing_method": "MonthlyPeak",
                "bandwidth_billing_method": "MonthlyP95"
            },
            "cluster_bwp_id": 67**,
            "create_time": 1672818553,
            "update_time": 1679884662
        }
    }
}

错误码

如果响应正文中包含 Error 字段，则表示 API 请求失败。关于错误码的更多信息，参见错误码。