EIP Instance

Updated at：2025-10-16

Apply for EIP

Function declaration

                Java
                
                public CreateEipResponse createEip(CreateEipRequest request) {
    ......
}

Parameter meaning

Please refer to the OpenAPI documentation Request Parameters for Applying for an EIP

Response value

Operation succeeded

Plain Text

1{
2 "metadata": For details, refer to the metadata section in the appendix,
3    "eip":"180.181.3.133"
4}

Operation failed

For response exception list of operation failure, refer to the EIP Exception List.

Code example

For specific code examples, please refer to ExampleCreateEip.java

EIP bandwidth scaling

Function declaration

                Java
                
                public void resizeEip(ResizeEipRequest request) {
    ......
}

Parameter meaning

Please refer to the OpenAPI documentation Request Parameters for Bandwidth Resizing of EIP

Response value

Operation succeeded

None

Operation failed

For response exception list of operation failure, refer to the EIP Exception List.

Code example

For specific code examples, please refer to ExampleResizeEip.java

Bind EIP

Function declaration

                Java
                
                public void bindEip(BindEipRequest request) {
    ......
}

Parameter meaning

Please refer to the OpenAPI documentation Request Parameters for Binding Eni

Response value

Operation succeeded

None

Operation failed

For response exception list of operation failure, refer to the EIP Exception List.

Code example

For specific code examples, refer to ExampleBindEip.java

Unbind EIP

Function declaration

                Java
                
                public void unbindEip(UnbindEipRequest request) {
    ......
}

Parameter meaning

Please refer to the OpenAPI documentation Request Parameters for Unbinding Eni

Response value

Operation succeeded

None

Operation failed

For response exception list of operation failure, refer to the EIP Exception List.

Code example

For specific code examples, refer to ExampleUnBindEip.java

Release EIP

Function declaration

                Java
                
                public void releaseEip(ReleaseEipRequest request) {
    ......
}

Parameter meaning

Please refer to the OpenAPI documentation Request Parameters for Releasing EIP

Response value

Operation succeeded

None

Operation failed

For response exception list of operation failure, refer to the EIP Exception List.

Code example

For specific code examples, please refer to ExampleReleaseEip.java

Query EIP list

Function declaration

                Java
                
                public ListEipsResponse listEips(ListEipsRequest request) {
    ......
}

Parameter meaning

Please refer to the OpenAPI documentation Request Parameters for Querying EIP List

Response value

Operation succeeded

Plain Text

1{
2 "metadata": For details, refer to the metadata section in the appendix,
3    "eipList": [
4        {
5            "name":"eip-xrllt5M-1",
6            "eip": "180.181.3.133",
7            "eipId": "ip-xxxxxxxx",
8            "status":"binded",
9            "instanceType": "BCC",
10            "instanceId": "i-IyWRtII7",
11            "shareGroupId": "eg-0c31c93a",
12            "eipInstanceType": "shared",
13            "bandwidthInMbps": 5,
14            "paymentTiming":"Prepaid",
15            "billingMethod":null,
16            "createTime":"2016-03-08T08:13:09Z",
17            "expireTime":"2016-04-08T08:13:09Z",
18            "region":"bj",
19            "routeType":"BGP",
20            "tags": [
21            {
22                "tagKey": "aa",
23                "tagValue": "bb"
24            }
25        ]
26        },
27        {
28            "name":"eip-scewa1M-1",
29            "eip": "180.181.3.134",
30            "eipId": "ip-xxxxxxxx",
31            "status":"binded",
32            "instanceType": "BCC",
33            "instanceId": "i-KjdgweC4",
34            "shareGroupId": null,
35            "eipInstanceType": "normal",
36            "bandwidthInMbps": 1,
37            "paymentTiming":"Postpaid",
38            "billingMethod":"ByTraffic",
39            "createTime":"2016-03-08T08:13:09Z",
40            "expireTime":null,
41            "region":"bj",
42            "routeType":"BGP",
43            "tags": [
44            {
45                "tagKey": "key",
46                "tagValue": "value"
47            }
48        ]
49        },
50    ],
51    "marker":"eip-DCB50385",
52    "isTruncated": true,
53    "nextMarker": "eip-DCB50387",
54    "maxKeys": 2
55}

Operation failed

For response exception list of operation failure, refer to the EIP Exception List.

Code example

For specific code examples, please refer to ExampleListEip.java

Renew EIP

Function declaration

                Java
                
                public void purchaseReservedEip(PurchaseReservedEipRequest request) {
    ......
}

Parameter meaning

Please refer to the OpenAPI documentation Request Parameters for Renewing EIP

Response value

Operation succeeded

None

Operation failed

For response exception list of operation failure, refer to the EIP Exception List.

Code example

For specific code examples, please refer to ExampleRenewEip.java

EIP renewal has been enabled

Function declaration

                Java
                
            

                public void startAutoRenew(AutoRenewEipRequest request) {
    ......
}
public void stopAutoRenew(StopAutoRenewEipRequest request) {
    ......
}
            

Parameter meaning

Please refer to the OpenAPI documentation Request Parameters for EIP Auto-renewal

Response value

Operation succeeded

None

Operation failed

For response exception list of operation failure, refer to the EIP Exception List.

Code example

For specific code examples, refer to ExampleAutoRenewEip.java, ExampleStopAutoRenewEipjava

Enable EIP direct

Function declaration

                Java
                
                public void directEip(DirectEipRequest request) {
    ......
}

Parameter meaning

Please refer to the OpenAPI documentation Request Parameters for Enabling EIP Direct

Response value

Operation succeeded

None

Operation failed

For response exception list of operation failure, refer to the EIP Exception List.

Code example

For specific code examples, please refer to ExampleDirectEip.java

Disable EIP direct

Function declaration

                Java
                
                public void unDirectEip(DirectEipRequest request) {
    ......
}

Parameter meaning

Please refer to the OpenAPI documentation Request Parameters for Disabling EIP Direct

Response value

Operation succeeded

None

Operation failed

For response exception list of operation failure, refer to the EIP Exception List.

Code example

For specific code examples, please refer to ExampleUnDirectEip.java

Query EIP list in bucket trash

Function declaration

                Java
                
                public ListRecycleEipsResponse listRecycleEips(ListRecycleEipsRequest request) {
    ......
}

Parameter meaning

Please refer to the OpenAPI documentation Request Parameters for Querying List of EIPs in Bucket Trash

Response value

Operation succeeded

Plain Text

1{
2 "metadata": For details, refer to the metadata section in the appendix,
3    "nextMarker": "ip-d51ec70b",
4    "marker": "ip-1dd4f675",
5    "maxKeys": 1,
6    "isTruncated": true,
7    "eipList": [
8        {
9			"name":"eip-xxxx-1",
10            "eip": "180.181.3.133",
11            "eipId": "ip-xxxxxxxx",
12            "status": "paused",
13            "routeType":"BGP",
14            "bandwidthInMbps": 5,
15            "paymentTiming":"Postpaid",
16            "billingMethod":"ByTraffic",
17            "recycleTime":"2022-02-13T04:28:00Z",
18            "scheduledDeleteTime":"2022-02-20T04:28:00Z",
19        }
20    ]
21}

Operation failed

For response exception list of operation failure, refer to the EIP Exception List.

Code example

For specific code examples, please refer to ExampleListRecycleEips.java

Selective release of EIP

Function declaration

                Java
                
                public void optionalReleaseEip(OptionalReleaseEipRequest request) {
    ......
}

Parameter meaning

Please refer to the OpenAPI documentation Request Parameters for Selective Release of EIP

Response value

Operation succeeded

None

Operation failed

For response exception list of operation failure, refer to the EIP Exception List.

Code example

For specific code examples, please refer to ExampleOptionalReleaseEip.java

Release EIPs in the bucket trash

Function declaration

                Java
                
                public void releaseEipFromRecycle(RecycleOperateEipRequest request) {
    ......
}

Parameter meaning

Please refer to the OpenAPI documentation Request Parameters for Releasing EIPs in Bucket Trash

Response value

Operation succeeded

None

Operation failed

For response exception list of operation failure, refer to the EIP Exception List.

Code example

For specific code examples, refer to ExampleReleaseEipFromRecycle.java

Restore EIPs in the bucket trash

Function declaration

                Java
                
                public void restoreEipFromRecycle(RecycleOperateEipRequest request) {
    ......
}

Parameter meaning Please refer to the OpenAPI documentation Request Parameters for Restoring EIPs from Bucket Trash

Response value

Operation succeeded

None

Operation failed

For response exception list of operation failure, refer to the EIP Exception List.

Code example

For specific code examples, please refer to ExampleRestoreEipFromRecycle.java

Appendix

Public response information in Metadata format

Plain Text

1 {
2      "bceRequestId":"f5f0821d-45fe-439b-bbf4-fc48b639f84a",
3      "contentLength":28,
4      "contentType":"application/json;charset=UTF-8",
5      "date":1701917695000,
6      "server":"openresty/1.15.8.1"
7 }

GO-SDK

EipBP Instance