# 添加地址组成员 - AddAddressItem #### 功能介绍 添加地址组成员 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-cfw/cfw_02_0007.html)。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-cfw/cfw_02_0018.html)。 - 如果使用身份策略授权，当前API调用无需身份策略权限。 #### URI POST /v1/{project_id}/address-items 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | 项目ID，可以通过调用API获取，也可以从控制台获取。[项目ID获取方式](https://support.huaweicloud.com/api-cfw/cfw_02_0015.html) | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | enterprise_project_id | 否 | String | 企业项目ID，用户根据组织规划企业项目，对应的ID为企业项目ID，可通过[如何获取企业项目ID](https://support.huaweicloud.com/api-cfw/cfw_02_0027.html)获取，用户未开启企业项目时为0 | | fw_instance_id | 否 | String | 防火墙ID，可通过[防火墙ID获取方式](https://support.huaweicloud.com/api-cfw/cfw_02_0028.html)获取 | #### 请求参数 表3请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | **参数解释**： 用户Token，用于携带用户身份信息，配置后可通过接口鉴权，可通过[如何获取用户Token](https://support.huaweicloud.com/api-cfw/cfw_02_0008.html)获取。 **约束限制**： 不涉及 **取值范围**： 不涉及 **默认取值**： 不涉及 | 表4请求Body参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | set_id | 是 | String | 地址组id，可通过[查询地址组列表接口](https://support.huaweicloud.com/api-cfw/ListAddressSets.html)查询获得，通过返回值中的data.records.set_id（.表示各对象之间层级的区分）获得。 | | address_items | 否 | Array of [address_items] objects | 地址组成员列表 | 表5address_items | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | address_type | 否 | Integer | 地址类型0 ipv4，1 ipv6 | | address | 是 | String | ip地址 | | description | 否 | String | 地址组成员描述 | #### 响应参数 **状态码：200** 表6响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | data | [AddressItems] object | 添加地址组成员返回数据 | 表7AddressItems | 参数 | 参数类型 | 描述 | |:---|:---|:---| | items | Array of [AddressItemIdWithoutName] objects | 地址组成员id列表 | | covered_ip | Array of [CoveredIPVO] objects | 覆盖IP列表 | 表8AddressItemIdWithoutName | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | 地址组成员id | 表9CoveredIPVO | 参数 | 参数类型 | 描述 | |:---|:---|:---| | ip | String | IP地址 | | covered_Ip | String | 覆盖IP地址。 | **状态码：400** 表10响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释**： 错误码 **取值范围**： 不涉及 | | error_msg | String | **参数解释**： 错误描述 **取值范围**： 不涉及 | #### 请求示例 给项目id为9d80d070b6d44942af73c9c3d38e0429的项目下的set_id为8773c082-2a6c-4529-939a-edc28ef1a67c添加IP地址为2.2.2.2，名称为ceshi的地址组成员 ``` https://{Endpoint}/v1/9d80d070b6d44942af73c9c3d38e0429/address-items { "set_id" : "8773c082-2a6c-4529-939a-edc28ef1a67c", "address_items" : [ { "description" : "", "address" : "2.2.2.2", "address_type" : 0 } ] } ``` #### 响应示例 **状态码：200** OK ``` { "data" : { "covered_ip" : [ ], "items" : [ { "id" : "65cb47fc-e666-4af4-8c2c-1fbd2f4b1eae" } ] } } ``` **状态码：400** Bad Request，错误的请求 ``` { "error_code" : "CFW.00200001", "error_msg" : "空参数错误" } ``` #### SDK代码示例 SDK代码示例如下。 - [Java] 给项目id为9d80d070b6d44942af73c9c3d38e0429的项目下的set_id为8773c082-2a6c-4529-939a-edc28ef1a67c添加IP地址为2.2.2.2，名称为ceshi的地址组成员 ``` 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 AddAddressItemSolution { 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("")) .build(); AddAddressItemRequest request = new AddAddressItemRequest(); AddAddressItemsInfoDto body = new AddAddressItemsInfoDto(); List listbodyAddressItems = new ArrayList<>(); listbodyAddressItems.add( new AddAddressItemsInfoDtoAddressItems() .withAddressType(0) .withAddress("2.2.2.2") .withDescription("") ); body.withAddressItems(listbodyAddressItems); body.withSetId("8773c082-2a6c-4529-939a-edc28ef1a67c"); request.withBody(body); try { AddAddressItemResponse response = client.addAddressItem(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为9d80d070b6d44942af73c9c3d38e0429的项目下的set_id为8773c082-2a6c-4529-939a-edc28ef1a67c添加IP地址为2.2.2.2，名称为ceshi的地址组成员 ``` # 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("")) \ .build() try: request = AddAddressItemRequest() listAddressItemsbody = [ AddAddressItemsInfoDtoAddressItems( address_type=0, address="2.2.2.2", description="" ) ] request.body = AddAddressItemsInfoDto( address_items=listAddressItemsbody, set_id="8773c082-2a6c-4529-939a-edc28ef1a67c" ) response = client.add_address_item(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为9d80d070b6d44942af73c9c3d38e0429的项目下的set_id为8773c082-2a6c-4529-939a-edc28ef1a67c添加IP地址为2.2.2.2，名称为ceshi的地址组成员 ``` 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, err := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). SafeBuild() if err != nil { fmt.Println(err) return } hcClient, err := cfw.CfwClientBuilder(). WithRegion(region.ValueOf("")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := cfw.NewCfwClient(hcClient) request := &model.AddAddressItemRequest{} addressTypeAddressItems:= int32(0) descriptionAddressItems:= "" var listAddressItemsbody = []model.AddAddressItemsInfoDtoAddressItems{ { AddressType: &addressTypeAddressItems, Address: "2.2.2.2", Description: &descriptionAddressItems, }, } request.Body = &model.AddAddressItemsInfoDto{ AddressItems: &listAddressItemsbody, SetId: "8773c082-2a6c-4529-939a-edc28ef1a67c", } response, err := client.AddAddressItem(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } ``` - [更多] 更多编程语言的SDK代码示例，请参见[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/CFW/sdk?api=AddAddressItem)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | OK | | 400 | Bad Request，错误的请求 | | 401 | Unauthorized，错误的请求 | | 403 | Forbidden，禁止访问 | | 404 | Not Found，网页未找到 | | 500 | Internal Server Error | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-cfw/ErrorCode.html)。