文档首页/ 云防火墙 CFW/ API参考/ API/ EIP管理/ 弹性IP开启关闭
更新时间：2024-09-19 GMT+08:00
在线调试
CLI示例
查看PDF
分享

弹性IP开启关闭

功能介绍

开启关闭EIP，客户购买EIP后首次开启EIP防护前需使用ListEips同步EIP资产，sync字段设置为1。

调用方法

请参见如何调用API。

URI

POST /v1/{project_id}/eip/protect

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID, 可以从调API处获取，也可以从控制台获取。项目ID获取方式
表2 Query参数

参数

是否必选

参数类型

描述

enterprise_project_id

否

String

企业项目ID，用户根据组织规划企业项目，对应的ID为企业项目ID，可通过如何获取企业项目ID获取，用户未开启企业项目时为0

fw_instance_id

否

String

防火墙id，可通过防火墙ID获取方式获取

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。可通过如何获取用户Token获取。
表4 请求Body参数

参数

是否必选

参数类型

描述

object_id

是

String

防护对象id，是创建云防火墙后用于区分互联网边界防护和VPC边界防护的标志id，可通过调用查询防火墙实例接口获得，通过返回值中的data.records.protect_objects.object_id（.表示各对象之间层级的区分）获得，注意type为0的为互联网边界防护对象id，type为1的为VPC边界防护对象id。此处仅取type为0的防护对象id，可通过data.records.protect_objects.type（.表示各对象之间层级的区分）获得。

status

是

Integer

EIP切换的状态，0表示防护中，1表示未防护

ip_infos

是

Array of ip_infos objects

切换防护状态的EIP信息列表
表5 ip_infos

参数

是否必选

参数类型

描述

id

否

String

弹性公网IP ID，可通过调用弹性IP列表查询接口获得，通过返回值中的data.records.id（.表示各对象之间层级的区分）获得。

public_ip

否

String

弹性公网IP IPv4地址，可通过调用弹性IP列表查询接口获得，通过返回值中的data.records.public_ip（.表示各对象之间层级的区分）获得。

public_ipv6

否

String

弹性公网IP IPv6地址，可通过调用弹性IP列表查询接口获得，通过返回值中的data.records.public_ipv6（.表示各对象之间层级的区分）获得。

响应参数

状态码： 200

表6 响应Body参数

参数

参数类型

描述

data

EIPSwitchStatusVO object

改变EIP防护状态返回值data
表7 EIPSwitchStatusVO

参数

参数类型

描述

object_id

String

防护对象id，是创建云防火墙后用于区分互联网边界防护和VPC边界防护的标志id，可通过调用查询防火墙实例接口获得，通过返回值中的data.records.protect_objects.object_id（.表示各对象之间层级的区分）获得，注意type为0的为互联网边界防护对象id，type为1的为VPC边界防护对象id。此处仅取type为0的防护对象id，可通过data.records.protect_objects.type（.表示各对象之间层级的区分）获得

fail_eip_id_list

Array of strings

修改eip防护状态失败状态列表，状态包括成功"successful"，失败“fail”

fail_eip_list

Array of FailedEipInfo objects

修改eip防护状态失败信息列表

id

String

防火墙id，可通过防火墙ID获取方式获取
表8 FailedEipInfo

参数

参数类型

描述

id

String

修改状态失败的eipId。

error_message

String

修改状态失败的错误码。

状态码： 400

表9 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

请求示例

  • 开启项目id为857ddec2-55f2-4503-a93a-fe70021b743c，防护对象id为6d3db4fd-fd58-4d8e-914b-ef91aa268f62弹性公网IPid为4a589be0-b40a-4694-94ff-c0710af9a0a2的 EIP（1.2.3.4）流量防护

    https://{Endpoint}/v1/857ddec2-55f2-4503-a93a-fe70021b743c/eip/protect

{
  "object_id" : "6d3db4fd-fd58-4d8e-914b-ef91aa268f62",
  "status" : 0,
  "ip_infos" : [ {
    "id" : "4a589be0-b40a-4694-94ff-c0710af9a0a2",
    "public_ip" : "1.2.3.4"
  } ]
}

  • 关闭项目id为857ddec2-55f2-4503-a93a-fe70021b743c，防护对象id为6d3db4fd-fd58-4d8e-914b-ef91aa268f62弹性公网IPid为4a589be0-b40a-4694-94ff-c0710af9a0a2的 EIP（1.2.3.4）流量防护

    /v1/857ddec2-55f2-4503-a93a-fe70021b743c/eip/protect

{
  "object_id" : "6d3db4fd-fd58-4d8e-914b-ef91aa268f62",
  "status" : 1,
  "ip_infos" : [ {
    "id" : "4a589be0-b40a-4694-94ff-c0710af9a0a2",
    "public_ip" : "1.2.3.4"
  } ]
}

响应示例

状态码： 200

开启关闭EIP防护状态返回值

{
  "data": {
    "fail_eip_id_list": [],
    "fail_eip_list": [],
    "object_id": "ae42418e-f077-41a0-9d3b-5b2f5ad9102b",
    "id": "b0a2dacc-3886-4805-838e-281653d3cd1f"
  }

SDK代码示例

SDK代码示例如下。

Java

  • 开启项目id为857ddec2-55f2-4503-a93a-fe70021b743c，防护对象id为6d3db4fd-fd58-4d8e-914b-ef91aa268f62弹性公网IPid为4a589be0-b40a-4694-94ff-c0710af9a0a2的 EIP（1.2.3.4）流量防护

     1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
    		 
    package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.BasicCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.cfw.v1.region.CfwRegion;
import com.huaweicloud.sdk.cfw.v1.*;
import com.huaweicloud.sdk.cfw.v1.model.*;

import java.util.List;
import java.util.ArrayList;

public class ChangeEipStatusSolution {

    public static void main(String[] args) {
        // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        String ak = System.getenv("CLOUD_SDK_AK");
        String sk = System.getenv("CLOUD_SDK_SK");
        String projectId = "{project_id}";

        ICredential auth = new BasicCredentials()
                .withProjectId(projectId)
                .withAk(ak)
                .withSk(sk);

        CfwClient client = CfwClient.newBuilder()
                .withCredential(auth)
                .withRegion(CfwRegion.valueOf("<YOUR REGION>"))
                .build();
        ChangeEipStatusRequest request = new ChangeEipStatusRequest();
        EipOperateProtectReq body = new EipOperateProtectReq();
        List<EipOperateProtectReqIpInfos> listbodyIpInfos = new ArrayList<>();
        listbodyIpInfos.add(
            new EipOperateProtectReqIpInfos()
                .withId("4a589be0-b40a-4694-94ff-c0710af9a0a2")
                .withPublicIp("1.2.3.4")
        );
        body.withIpInfos(listbodyIpInfos);
        body.withStatus(0);
        body.withObjectId("6d3db4fd-fd58-4d8e-914b-ef91aa268f62");
        request.withBody(body);
        try {
            ChangeEipStatusResponse response = client.changeEipStatus(request);
            System.out.println(response.toString());
        } catch (ConnectionException e) {
            e.printStackTrace();
        } catch (RequestTimeoutException e) {
            e.printStackTrace();
        } catch (ServiceResponseException e) {
            e.printStackTrace();
            System.out.println(e.getHttpStatusCode());
            System.out.println(e.getRequestId());
            System.out.println(e.getErrorCode());
            System.out.println(e.getErrorMsg());
        }
    }
}

  • 关闭项目id为857ddec2-55f2-4503-a93a-fe70021b743c，防护对象id为6d3db4fd-fd58-4d8e-914b-ef91aa268f62弹性公网IPid为4a589be0-b40a-4694-94ff-c0710af9a0a2的 EIP（1.2.3.4）流量防护

     1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
    		 
    package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.BasicCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.cfw.v1.region.CfwRegion;
import com.huaweicloud.sdk.cfw.v1.*;
import com.huaweicloud.sdk.cfw.v1.model.*;

import java.util.List;
import java.util.ArrayList;

public class ChangeEipStatusSolution {

    public static void main(String[] args) {
        // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        String ak = System.getenv("CLOUD_SDK_AK");
        String sk = System.getenv("CLOUD_SDK_SK");
        String projectId = "{project_id}";

        ICredential auth = new BasicCredentials()
                .withProjectId(projectId)
                .withAk(ak)
                .withSk(sk);

        CfwClient client = CfwClient.newBuilder()
                .withCredential(auth)
                .withRegion(CfwRegion.valueOf("<YOUR REGION>"))
                .build();
        ChangeEipStatusRequest request = new ChangeEipStatusRequest();
        EipOperateProtectReq body = new EipOperateProtectReq();
        List<EipOperateProtectReqIpInfos> listbodyIpInfos = new ArrayList<>();
        listbodyIpInfos.add(
            new EipOperateProtectReqIpInfos()
                .withId("4a589be0-b40a-4694-94ff-c0710af9a0a2")
                .withPublicIp("1.2.3.4")
        );
        body.withIpInfos(listbodyIpInfos);
        body.withStatus(1);
        body.withObjectId("6d3db4fd-fd58-4d8e-914b-ef91aa268f62");
        request.withBody(body);
        try {
            ChangeEipStatusResponse response = client.changeEipStatus(request);
            System.out.println(response.toString());
        } catch (ConnectionException e) {
            e.printStackTrace();
        } catch (RequestTimeoutException e) {
            e.printStackTrace();
        } catch (ServiceResponseException e) {
            e.printStackTrace();
            System.out.println(e.getHttpStatusCode());
            System.out.println(e.getRequestId());
            System.out.println(e.getErrorCode());
            System.out.println(e.getErrorMsg());
        }
    }
}

Python

  • 开启项目id为857ddec2-55f2-4503-a93a-fe70021b743c，防护对象id为6d3db4fd-fd58-4d8e-914b-ef91aa268f62弹性公网IPid为4a589be0-b40a-4694-94ff-c0710af9a0a2的 EIP（1.2.3.4）流量防护

     1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
    		 
    # coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkcfw.v1.region.cfw_region import CfwRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkcfw.v1 import *

if __name__ == "__main__":
    # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak = os.environ["CLOUD_SDK_AK"]
    sk = os.environ["CLOUD_SDK_SK"]
    projectId = "{project_id}"

    credentials = BasicCredentials(ak, sk, projectId)

    client = CfwClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(CfwRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = ChangeEipStatusRequest()
        listIpInfosbody = [
            EipOperateProtectReqIpInfos(
                id="4a589be0-b40a-4694-94ff-c0710af9a0a2",
                public_ip="1.2.3.4"
            )
        ]
        request.body = EipOperateProtectReq(
            ip_infos=listIpInfosbody,
            status=0,
            object_id="6d3db4fd-fd58-4d8e-914b-ef91aa268f62"
        )
        response = client.change_eip_status(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

  • 关闭项目id为857ddec2-55f2-4503-a93a-fe70021b743c，防护对象id为6d3db4fd-fd58-4d8e-914b-ef91aa268f62弹性公网IPid为4a589be0-b40a-4694-94ff-c0710af9a0a2的 EIP（1.2.3.4）流量防护

     1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
    		 
    # coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkcfw.v1.region.cfw_region import CfwRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkcfw.v1 import *

if __name__ == "__main__":
    # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak = os.environ["CLOUD_SDK_AK"]
    sk = os.environ["CLOUD_SDK_SK"]
    projectId = "{project_id}"

    credentials = BasicCredentials(ak, sk, projectId)

    client = CfwClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(CfwRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = ChangeEipStatusRequest()
        listIpInfosbody = [
            EipOperateProtectReqIpInfos(
                id="4a589be0-b40a-4694-94ff-c0710af9a0a2",
                public_ip="1.2.3.4"
            )
        ]
        request.body = EipOperateProtectReq(
            ip_infos=listIpInfosbody,
            status=1,
            object_id="6d3db4fd-fd58-4d8e-914b-ef91aa268f62"
        )
        response = client.change_eip_status(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

Go

  • 开启项目id为857ddec2-55f2-4503-a93a-fe70021b743c，防护对象id为6d3db4fd-fd58-4d8e-914b-ef91aa268f62弹性公网IPid为4a589be0-b40a-4694-94ff-c0710af9a0a2的 EIP（1.2.3.4）流量防护

     1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
    		 
    package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    cfw "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cfw/v1"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cfw/v1/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cfw/v1/region"
)

func main() {
    // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak := os.Getenv("CLOUD_SDK_AK")
    sk := os.Getenv("CLOUD_SDK_SK")
    projectId := "{project_id}"

    auth := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        WithProjectId(projectId).
        Build()

    client := cfw.NewCfwClient(
        cfw.CfwClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.ChangeEipStatusRequest{}
	idIpInfos:= "4a589be0-b40a-4694-94ff-c0710af9a0a2"
	publicIpIpInfos:= "1.2.3.4"
	var listIpInfosbody = []model.EipOperateProtectReqIpInfos{
        {
            Id: &idIpInfos,
            PublicIp: &publicIpIpInfos,
        },
    }
	request.Body = &model.EipOperateProtectReq{
		IpInfos: listIpInfosbody,
		Status: int32(0),
		ObjectId: "6d3db4fd-fd58-4d8e-914b-ef91aa268f62",
	}
	response, err := client.ChangeEipStatus(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

  • 关闭项目id为857ddec2-55f2-4503-a93a-fe70021b743c，防护对象id为6d3db4fd-fd58-4d8e-914b-ef91aa268f62弹性公网IPid为4a589be0-b40a-4694-94ff-c0710af9a0a2的 EIP（1.2.3.4）流量防护

     1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
    		 
    package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    cfw "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cfw/v1"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cfw/v1/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cfw/v1/region"
)

func main() {
    // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak := os.Getenv("CLOUD_SDK_AK")
    sk := os.Getenv("CLOUD_SDK_SK")
    projectId := "{project_id}"

    auth := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        WithProjectId(projectId).
        Build()

    client := cfw.NewCfwClient(
        cfw.CfwClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.ChangeEipStatusRequest{}
	idIpInfos:= "4a589be0-b40a-4694-94ff-c0710af9a0a2"
	publicIpIpInfos:= "1.2.3.4"
	var listIpInfosbody = []model.EipOperateProtectReqIpInfos{
        {
            Id: &idIpInfos,
            PublicIp: &publicIpIpInfos,
        },
    }
	request.Body = &model.EipOperateProtectReq{
		IpInfos: listIpInfosbody,
		Status: int32(1),
		ObjectId: "6d3db4fd-fd58-4d8e-914b-ef91aa268f62",
	}
	response, err := client.ChangeEipStatus(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多

更多编程语言的SDK代码示例，请参见API Explorer的代码示例页签，可生成自动对应的SDK代码示例。

状态码

状态码

描述

200

开启关闭EIP防护状态返回值

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

错误码

请参见错误码。

父主题： EIP管理

相关文档