更新时间:2024-12-16 GMT+08:00
分享

设置IP白名单分组

功能介绍

为指定实例设置IP白名单分组,包含创建、停用、编辑、删除白名单四个功能。设置白名单分组信息会覆盖掉已有的白名单信息,因此在新增IP白名单分组时,需保留已有的白名单信息后再编辑新的白名单分组信息。

调用方法

请参见如何调用API

URI

PUT /v2/{project_id}/instance/{instance_id}/whitelist

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID。获取方法请参见获取项目ID

instance_id

String

实例ID。

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

instance_id

String

实例ID。

enable_whitelist

Boolean

是否启用白名单(true/false)。

whitelist

Array of Whitelist objects

IP白名单分组列表,设置白名单分组信息会覆盖掉已有的白名单信息,因此在新增IP白名单分组时,需保留已有的白名单信息后再编辑新的白名单分组信息。

表3 Whitelist

参数

是否必选

参数类型

描述

group_name

String

白名单分组名称,每个实例支持创建4个分组。

ip_list

Array of strings

白名单分组下的IP列表,每个实例最多可以添加20个IP地址/地址段。如果有多个,可以用逗号分隔。不支持的IP和地址段:0.0.0.0和0.0.0.0/0。

响应参数

状态码: 400

表4 响应Body参数

参数

参数类型

描述

error_msg

String

错误信息。

error_code

String

错误码。

error_ext_msg

String

扩展错误信息(暂未使用,赋值为null)。

状态码: 401

表5 响应Body参数

参数

参数类型

描述

error_msg

String

错误信息。

error_code

String

错误码。

error_ext_msg

String

扩展错误信息(暂未使用,赋值为null)。

状态码: 403

表6 响应Body参数

参数

参数类型

描述

error_msg

String

错误信息。

error_code

String

错误码。

error_ext_msg

String

扩展错误信息(暂未使用,赋值为null)。

状态码: 404

表7 响应Body参数

参数

参数类型

描述

error_msg

String

错误信息。

error_code

String

错误码。

error_ext_msg

String

扩展错误信息(暂未使用,赋值为null)。

状态码: 500

表8 响应Body参数

参数

参数类型

描述

error_msg

String

错误信息。

error_code

String

错误码。

error_ext_msg

String

扩展错误信息(暂未使用,赋值为null)。

请求示例

  • 启用白名单,配置允许访问的IP地址。

    PUT https://{dcs_endpoint}/v2/{project_id}/instance/{instance_id}/whitelist
    
    {
      "enable_whitelist" : true,
      "whitelist" : [ {
        "group_name" : "test001",
        "ip_list" : [ "10.10.10.1", "10.10.10.2" ]
      } ]
    }
  • 启用白名单,配置允许访问的子网掩码。

    PUT https://{dcs_endpoint}/v2/{project_id}/instance/{instance_id}/whitelist

响应示例

SDK代码示例

SDK代码示例如下。

启用白名单,配置允许访问的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
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.dcs.v2.region.DcsRegion;
import com.huaweicloud.sdk.dcs.v2.*;
import com.huaweicloud.sdk.dcs.v2.model.*;

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

public class UpdateIpWhitelistSolution {

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

        DcsClient client = DcsClient.newBuilder()
                .withCredential(auth)
                .withRegion(DcsRegion.valueOf("<YOUR REGION>"))
                .build();
        UpdateIpWhitelistRequest request = new UpdateIpWhitelistRequest();
        request.withInstanceId("{instance_id}");
        ModifyIpWhitelistBody body = new ModifyIpWhitelistBody();
        List<String> listWhitelistIpList = new ArrayList<>();
        listWhitelistIpList.add("10.10.10.1");
        listWhitelistIpList.add("10.10.10.2");
        List<Whitelist> listbodyWhitelist = new ArrayList<>();
        listbodyWhitelist.add(
            new Whitelist()
                .withGroupName("test001")
                .withIpList(listWhitelistIpList)
        );
        body.withWhitelist(listbodyWhitelist);
        body.withEnableWhitelist(true);
        request.withBody(body);
        try {
            UpdateIpWhitelistResponse response = client.updateIpWhitelist(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());
        }
    }
}

启用白名单,配置允许访问的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
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkdcs.v2.region.dcs_region import DcsRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkdcs.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"]
    projectId = "{project_id}"

    credentials = BasicCredentials(ak, sk, projectId)

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

    try:
        request = UpdateIpWhitelistRequest()
        request.instance_id = "{instance_id}"
        listIpListWhitelist = [
            "10.10.10.1",
            "10.10.10.2"
        ]
        listWhitelistbody = [
            Whitelist(
                group_name="test001",
                ip_list=listIpListWhitelist
            )
        ]
        request.body = ModifyIpWhitelistBody(
            whitelist=listWhitelistbody,
            enable_whitelist=True
        )
        response = client.update_ip_whitelist(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

启用白名单,配置允许访问的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
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    dcs "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dcs/v2"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dcs/v2/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dcs/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")
    projectId := "{project_id}"

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

    client := dcs.NewDcsClient(
        dcs.DcsClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.UpdateIpWhitelistRequest{}
	request.InstanceId = "{instance_id}"
	var listIpListWhitelist = []string{
        "10.10.10.1",
	    "10.10.10.2",
    }
	var listWhitelistbody = []model.Whitelist{
        {
            GroupName: "test001",
            IpList: listIpListWhitelist,
        },
    }
	request.Body = &model.ModifyIpWhitelistBody{
		Whitelist: listWhitelistbody,
		EnableWhitelist: true,
	}
	response, err := client.UpdateIpWhitelist(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

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

状态码

状态码

描述

204

设置IP白名单成功。

400

非法请求。

401

认证信息非法。

403

请求被拒绝访问。

404

所请求的资源不存在。

500

内部服务错误

错误码

请参见错误码

相关文档