文档首页/ 弹性公网IP EIP/ API参考/ API/ 带宽(V2.0)/ 共享带宽移除弹性公网IP
更新时间:2024-08-15 GMT+08:00
分享

共享带宽移除弹性公网IP

功能介绍

共享带宽移除弹性公网IP。

接口约束

在共享带宽中批量移除弹性公网IP时,一次可批量操作100个弹性公网IP。

调用方法

请参见如何调用API

URI

POST /v2.0/{project_id}/bandwidths/{bandwidth_id}/remove

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID,获取项目ID请参见获取项目ID

bandwidth_id

String

带宽唯一标识

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

bandwidth

RemoveFromSharedBandwidthOption object

带宽对象

表3 RemoveFromSharedBandwidthOption

参数

是否必选

参数类型

描述

charge_mode

String

  • 功能说明:弹性公网IP从共享带宽移除后,会为此弹性公网IP创建独占带宽进行计费。 此参数表示弹性公网IP从共享带宽移除后,使用的独占带宽的计费类型。(bandwidth/traffic)

枚举值:

  • bandwidth

  • traffic

publicip_info

Array of RemovePublicipInfo objects

  • 功能说明:要从共享带宽中移除的弹性公网IP信息

  • 约束:WHOLE类型的带宽支持多个弹性公网IP,跟租户的配额相关,默认一个共享带宽的配额为20

size

Integer

  • 功能说明:弹性公网IP从共享带宽移除后,会为此弹性公网IP创建独占带宽进行计费。此参数表示弹性公网IP从共享带宽移除后,使用的独占带宽的带宽大小。(M)

  • 取值范围:默认1Mbit/s~2000Mbit/s(具体范围以各区域配置为准,请参见控制台对应页面显示)。

表4 RemovePublicipInfo

参数

是否必选

参数类型

描述

publicip_type

String

  • 功能说明:如果publicip_id为弹性公网IP的id,则该字段可自动忽略。如果publicip_id为IPv6端口PORT的id,则该字段必填:5_dualStack(目前仅北京4局点支持)

最大长度:36

publicip_id

String

  • 功能说明:带宽对应的弹性公网IP或IPv6端口PORT的唯一标识

最大长度:36

响应参数

请求示例

将id为d91b0028-6f6b-4478-808a-297b75b6812a、1d184b2c-4ec9-49b5-a3f9-27600a76ba3f的弹性公网IP移出按流量计费的共享带宽,支持多个弹性公网IP移除共享带宽。

{
  "bandwidth" : {
    "size" : 22,
    "publicip_info" : [ {
      "publicip_id" : "d91b0028-6f6b-4478-808a-297b75b6812a",
      "publicip_type" : "5_dualStack"
    }, {
      "publicip_id" : "1d184b2c-4ec9-49b5-a3f9-27600a76ba3f"
    } ],
    "charge_mode" : "traffic"
  }
}

响应示例

SDK代码示例

SDK代码示例如下。

将id为d91b0028-6f6b-4478-808a-297b75b6812a、1d184b2c-4ec9-49b5-a3f9-27600a76ba3f的弹性公网IP移出按流量计费的共享带宽,支持多个弹性公网IP移除共享带宽。

 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
61
62
63
64
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.eip.v2.region.EipRegion;
import com.huaweicloud.sdk.eip.v2.*;
import com.huaweicloud.sdk.eip.v2.model.*;

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

public class RemovePublicipsFromSharedBandwidthSolution {

    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");

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

        EipClient client = EipClient.newBuilder()
                .withCredential(auth)
                .withRegion(EipRegion.valueOf("<YOUR REGION>"))
                .build();
        RemovePublicipsFromSharedBandwidthRequest request = new RemovePublicipsFromSharedBandwidthRequest();
        RemovePublicipsFromSharedBandwidthRequestBody body = new RemovePublicipsFromSharedBandwidthRequestBody();
        List<RemovePublicipInfo> listBandwidthPublicipInfo = new ArrayList<>();
        listBandwidthPublicipInfo.add(
            new RemovePublicipInfo()
                .withPublicipType("5_dualStack")
                .withPublicipId("d91b0028-6f6b-4478-808a-297b75b6812a")
        );
        listBandwidthPublicipInfo.add(
            new RemovePublicipInfo()
                .withPublicipId("1d184b2c-4ec9-49b5-a3f9-27600a76ba3f")
        );
        RemoveFromSharedBandwidthOption bandwidthbody = new RemoveFromSharedBandwidthOption();
        bandwidthbody.withChargeMode(RemoveFromSharedBandwidthOption.ChargeModeEnum.fromValue("traffic"))
            .withPublicipInfo(listBandwidthPublicipInfo)
            .withSize(22);
        body.withBandwidth(bandwidthbody);
        request.withBody(body);
        try {
            RemovePublicipsFromSharedBandwidthResponse response = client.removePublicipsFromSharedBandwidth(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为d91b0028-6f6b-4478-808a-297b75b6812a、1d184b2c-4ec9-49b5-a3f9-27600a76ba3f的弹性公网IP移出按流量计费的共享带宽,支持多个弹性公网IP移除共享带宽。

 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
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkeip.v2.region.eip_region import EipRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkeip.v2 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"]

    credentials = BasicCredentials(ak, sk)

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

    try:
        request = RemovePublicipsFromSharedBandwidthRequest()
        listPublicipInfoBandwidth = [
            RemovePublicipInfo(
                publicip_type="5_dualStack",
                publicip_id="d91b0028-6f6b-4478-808a-297b75b6812a"
            ),
            RemovePublicipInfo(
                publicip_id="1d184b2c-4ec9-49b5-a3f9-27600a76ba3f"
            )
        ]
        bandwidthbody = RemoveFromSharedBandwidthOption(
            charge_mode="traffic",
            publicip_info=listPublicipInfoBandwidth,
            size=22
        )
        request.body = RemovePublicipsFromSharedBandwidthRequestBody(
            bandwidth=bandwidthbody
        )
        response = client.remove_publicips_from_shared_bandwidth(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为d91b0028-6f6b-4478-808a-297b75b6812a、1d184b2c-4ec9-49b5-a3f9-27600a76ba3f的弹性公网IP移出按流量计费的共享带宽,支持多个弹性公网IP移除共享带宽。

 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
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    eip "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/eip/v2"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/eip/v2/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/eip/v2/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")

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

    client := eip.NewEipClient(
        eip.EipClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.RemovePublicipsFromSharedBandwidthRequest{}
	publicipTypePublicipInfo:= "5_dualStack"
	var listPublicipInfoBandwidth = []model.RemovePublicipInfo{
        {
            PublicipType: &publicipTypePublicipInfo,
            PublicipId: "d91b0028-6f6b-4478-808a-297b75b6812a",
        },
        {
            PublicipId: "1d184b2c-4ec9-49b5-a3f9-27600a76ba3f",
        },
    }
	bandwidthbody := &model.RemoveFromSharedBandwidthOption{
		ChargeMode: model.GetRemoveFromSharedBandwidthOptionChargeModeEnum().TRAFFIC,
		PublicipInfo: listPublicipInfoBandwidth,
		Size: int32(22),
	}
	request.Body = &model.RemovePublicipsFromSharedBandwidthRequestBody{
		Bandwidth: bandwidthbody,
	}
	response, err := client.RemovePublicipsFromSharedBandwidth(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

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

状态码

状态码

描述

204

POST操作正常返回

错误码

请参见错误码

相关文档