文档中心 > DescribeEip
DescribeEip

最近更新时间:2021-12-24

请求方法:GET

接口描述:调用DescribeEip接口查询指定地域已创建的EIP实例列表。


请求参数

Param

名称

类型

是否必选

描述

Action

String

要执行的操作。取值:DescribeEip

RegionId

String

EIP所在的地域。
● HB1-BJMY(华北2-北京2);
● HD1-SHMY(华东1-上海)

AzoneId

String

可用区ID。

InstanceId

String

EIP的ID。

IpAddress

String

EIP的IP地址。

Status

String

EIP状态。

InstanceCode

String

EIP规格。

EipName

String

EIP的名称。

Page

String

页码。

Size

String

页条数。

OrderBy

String

排序方式。

Order

String

排序字段。


返回参数

名称

类型

描述

RequestId

String

请求ID。

Code

String

查询结果编码。

Msg

String

查询结果描述。

Res


EIP的详细信息。

+Page

Integer

当前页码。

+Data

Array


++RegionId

String

节点ID。

++Bandwidth

String

带宽值。

++ParentType

String

绑定资源类型。

++CbwId

String

加入的共享带宽的ID。

++IpAddress

String

弹性公网IP的IP地址。

++Status

String

实例状态

● CREATING: 创建中

● RUNNING: 运行中

● BINDING: 绑定中

● TOPPED: 已关停

● UNBINDING: 解绑中

● WAITING: 等待中

● UPGRADING: 调配中

● UNABLE: 已停服

++InstanceCode

String

实例规格编码。

++InstanceId

String

实例ID。

++AzoneId

String

可用区ID。

++InstanceOperationType


规格信息。

+++End_bandwidth

Integer

规格结束带宽。

+++RangeAttribute

String

范围属性名。

+++Start_bandwidth

Integer

规格开始带宽。

+++Step

Integer

规格步长。

+++SpecificationName

String

规格名称。

+++SpecificationCode

String

规格编码。

+++ComponentCode

String

组件编码。

+++Step_unit

String

规格步长单位。

+++SpecificationClassCode

String

规格族编码。

+++Bandwidth_unit

String

带宽单位。

+++Describe

String

规格描述。

+++StartSize

Integer

规格开始值。

+++EndSize

Integer

规格结束值。

++InstanceOperationInfo


实例运营信息。

+++RegionId

String

节点ID。

+++IsPay

Integer

是否支付,默认为1。

+++Id

String

EIP实例ID。

+++RegionName

String

节点名称。

+++ProductType

String

产品类型,目前:实例、服务。

+++ChargeType

Integer

付费方式 0=预付费 ;1=后付费。

+++OrderId

Integer

订单ID。

+++RentUnit

String

租期单位。

+++OperationStatus

Integer

实例运营状态

● -1:已释放

● 0:已关停

● 1:创建中

● 2:使用中

● 3:创建失败

+++PayType

String

计费类型。

+++InstanceName

String

实例名称

+++IsPayClose

Boolean

关停-是否计费:

● 0:否

● 1:是

+++InstanceEndTime

Integer

实例到期时间。

+++RentCount

Integer

租期。

+++RenewType

Integer

续费方式。

+++UpdateTime

Integer

更新时间。

+++ProductCode

String

产品编码。

+++InstanceStartTime

Integer

实例开始时间。

+++InstanceLabel

Integer

实例用途:

● 0:试用

● 1:正式

+++IsOld

Integer

实例新旧

● 0:新实例

● 1:旧实例

+++FormalPayTime

Integer

正式计费时间。

+++UserName

String

用户名。

+++DueTime

String

实例到期日期。

+++CreateTime

Integer

创建时间。

+++UserId

String

用户ID。

+++IsThirdProduct

Boolean

是否第三方产品。

+++Creator

Boolean

创建者ID。

++InstanceName

String

实例名称。

++UserId

String

用户ID。

+Size

Integer

当前页EIP实例个数。

+Total

Integer

EIP实例总数。

 

示例

请求示例

GET https://api.unicloud.com/networks/eip?Action=DescribeEip

&RegionId=terer-3423jkl34=-234324

&公共请求参数

返回示例

JSON 格式

{

    "Code": "Network.Success",

    "Msg": "获取EIP列表成功",

    "Res": {

        "Page": 1,

        "Data": [

            {

                "RegionId": "cn-beijing",

                "AzoneId":"cn-beijing-a",

                "Bandwidth": 1,

                "ParentType": "",

                "CbwId": "",

                "IpAddress": "101.65.1.145",

                "Status": "RUNNING",

                "InstanceCode": "eip.bgp.static",

                "InstanceId": "eip-5nsjdcasa72ob",

                "InstanceName": "NetifSkUGi0S6",

                "UserId": "cd8bd4f5-5a1f-4887-a886-8efe3ba900a5",

                            "ParentInstanceId": "",

                "InstanceOperationType": {

                    "SpecificationId": "1240524479348604928",

                    "End_bandwidth": "500",

                    "RangeAttribute": "bandwidth",

                    "UpdateTime": 1584695090813,

                    "Start_bandwidth": "1",

                    "Step": "1",

                    "SpecificationName": "BGP静态",

                    "SpecificationCode": "eip.bgp.static",

                    "ComponentCode": "Bandwidth",

                    "Step_unit": "M",

                    "SpecificationClassCode": "eip.bgp.static",

                    "Bandwidth_unit": "M",

                    "CreateTime": 1584599058364,

                    "Describe": "弹性公网IP-BGP静态*Mbps"

                },

                "InstanceOperationInfo": {

                      "InstanceStartTime": 1631110801000,

                      "IsPay": 1,

                      "DueTime": "2021-10-09",

                      "IsOld": 0,

                      "RentUnit": "month",

                      "SubUserId": "cd8bd4f5-5a1f-4887-a886-8efe3ba900a5",

                      "AzId": "HB1-BJMY2",

                      "Creator": "cd8bd4f5-5a1f-4887-a886-8efe3ba900a5",

                      "IsThirdProduct": false,

                      "RegionName": "华北2-北京3",

                      "OperationStatus": 2,

                      "InstanceLabel": 1,

                      "UserName": "yangxiaoke",

                      "ProductCode": "BANDWIDTH_PUBLIC",

                      "CreateTime": 1631110801000,

                      "ProductType": "instance",

                      "PayType": "YEAR_MONTH",

                      "FormalPayTime": 1631110801000,

                      "OrderId": 1435608854313386000,

                      "IsMspProduct": false,

                      "RentCount": 1,

                      "InstanceName": "NetsK8YJm14bQ",

                      "ChargeFlag": 1,

                      "ChargeType": 0,

                      "UserId": "cd8bd4f5-5a1f-4887-a886-8efe3ba900a5",

                      "UpdateTime": 1631110810000,

                      "RenewType": 1,

                      "Id": "eip-k6xu5hbl930r",

                      "InstanceEndTime": 1633708800000,

                      "RegionId": "HB1-BJMYB",

                      "IsPayClose": false

                }

            }

        ],

        "Size": 1,

        "Total": 1

    },

    "RequestId": "22d62a9e-f742-4c4a-8ac0-509ff0376b8f"

}