# 设置IP白名单分组 - UpdateIpWhitelist #### 功能介绍 为指定实例设置IP白名单分组，包含创建、停用、编辑、删除白名单四个功能。设置白名单分组信息会覆盖掉已有的白名单信息，因此在新增IP白名单分组时，需保留已有的白名单信息后再编辑新的白名单分组信息。 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-dcs/api-call-process.html)。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-dcs/api-grant-policy.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | dcs:whitelist:modify | Write | instance \* | - g:EnterpriseProjectId - g:ResourceTag/\ | - | - | #### URI PUT /v2/{project_id}/instance/{instance_id}/whitelist 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释**： 项目ID。获取方法请参见[获取项目ID](https://support.huaweicloud.com/api-dcs/dcs-api-0312045.html)。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | instance_id | 是 | String | **参数解释**： 实例ID。可通过DCS控制台进入实例详情界面查看。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | #### 请求参数 表2请求Body参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | instance_id | 否 | String | **参数解释**： 实例ID。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | enable_whitelist | 是 | Boolean | **参数解释**： 是否启用白名单。 **约束限制**： 不涉及。 **取值范围**： true：启用白名单。 false：关闭白名单。 **默认取值**： 不涉及。 | | whitelist | 是 | Array of [Whitelist] objects | **参数解释**： IP白名单分组列表，设置白名单分组信息会覆盖掉已有的白名单信息，因此在新增IP白名单分组时，需保留已有的白名单信息后再编辑新的白名单分组信息。 **约束限制**： 不涉及。 | 表3Whitelist | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | group_name | 是 | String | **参数解释**： 白名单分组名称。 **约束限制**： 每个实例支持创建4个白名单分组，分组名称不能重复，长度至少四位，且首字段必须为字母，只能包含字母，数字，中划线，下划线。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | ip_list | 是 | Array of strings | **参数解释**： 白名单分组下的IP列表。如果有多个，可以用逗号分隔。 **约束限制**： 单个实例下的IP不能重复，不支持IP部分为0.0.0.0的IP和CIDP。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | #### 响应参数 **状态码：204** **参数解释**： 设置IP白名单成功。 **状态码：400** 表4响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_msg | String | **参数解释**： 错误信息。 **取值范围**： 不涉及。 | | error_code | String | **参数解释**： 错误码。 **取值范围**： 请参见[错误码](https://support.huaweicloud.com/api-dcs/ErrorCode.html)。 | | error_ext_msg | String | **参数解释**： 扩展错误信息（暂未使用，不返回）。 **取值范围**： 不涉及。 | **状态码：401** 表5响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_msg | String | **参数解释**： 错误信息。 **取值范围**： 不涉及。 | | error_code | String | **参数解释**： 错误码。 **取值范围**： 请参见[错误码](https://support.huaweicloud.com/api-dcs/ErrorCode.html)。 | | error_ext_msg | String | **参数解释**： 扩展错误信息（暂未使用，不返回）。 **取值范围**： 不涉及。 | **状态码：403** 表6响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_msg | String | **参数解释**： 错误信息。 **取值范围**： 不涉及。 | | error_code | String | **参数解释**： 错误码。 **取值范围**： 请参见[错误码](https://support.huaweicloud.com/api-dcs/ErrorCode.html)。 | | error_ext_msg | String | **参数解释**： 扩展错误信息（暂未使用，不返回）。 **取值范围**： 不涉及。 | **状态码：404** 表7响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_msg | String | **参数解释**： 错误信息。 **取值范围**： 不涉及。 | | error_code | String | **参数解释**： 错误码。 **取值范围**： 请参见[错误码](https://support.huaweicloud.com/api-dcs/ErrorCode.html)。 | | error_ext_msg | String | **参数解释**： 扩展错误信息（暂未使用，不返回）。 **取值范围**： 不涉及。 | **状态码：500** 表8响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_msg | String | **参数解释**： 错误信息。 **取值范围**： 不涉及。 | | error_code | String | **参数解释**： 错误码。 **取值范围**： 请参见[错误码](https://support.huaweicloud.com/api-dcs/ErrorCode.html)。 | | error_ext_msg | String | **参数解释**： 扩展错误信息（暂未使用，不返回）。 **取值范围**： 不涉及。 | #### 请求示例 - 启用白名单，配置允许访问的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代码示例如下。 - [Java] 启用白名单，配置允许访问的IP地址。 ``` 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("")) .build(); UpdateIpWhitelistRequest request = new UpdateIpWhitelistRequest(); request.withInstanceId("{instance_id}"); ModifyIpWhitelistBody body = new ModifyIpWhitelistBody(); List listWhitelistIpList = new ArrayList<>(); listWhitelistIpList.add("10.10.10.1"); listWhitelistIpList.add("10.10.10.2"); List 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()); } } } ``` - [Python] 启用白名单，配置允许访问的IP地址。 ``` # 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("")) \ .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) ``` - [Go] 启用白名单，配置允许访问的IP地址。 ``` 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, err := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). SafeBuild() if err != nil { fmt.Println(err) return } hcClient, err := dcs.DcsClientBuilder(). WithRegion(region.ValueOf("")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := dcs.NewDcsClient(hcClient) 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](https://console.huaweicloud.com/apiexplorer/#/openapi/DCS/sdk?api=UpdateIpWhitelist&version=v2)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 204 | **参数解释**： 设置IP白名单成功。 | | 400 | **参数解释**： 非法请求。 | | 401 | **参数解释**： 认证失败。 | | 403 | **参数解释**： 请求被拒绝。 | | 404 | **参数解释**： 路径错误。 | | 500 | **参数解释**： 内部错误。 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-dcs/ErrorCode.html)。