huawei-cloud-api-definitions-CFW 0.1.20250822

Huawei Cloud API definitions, generated from OpenAPI spec
Documentation
1
{"base_path":"/","components":null,"consumes":"","definitions":{"AddAddressItemsInfoDto":{"description":"地址组成员信息","example":{"address_items":[{"address":"192.168.25.23","address_type":0,"description":"des param","name":"item1"},{"address":"192.168.25.23","address_type":0,"description":"des param","name":"item1"}],"set_id":"1f1e070a-c5c0-4baf-b9dc-29dfa1abb049"},"properties":{"address_items":{"description":"地址组成员列表","items":{"description":"成员信息","properties":{"address":{"description":"ip","type":"string"},"address_type":{"description":"地址类型0 ipv4,1 ipv6","type":"integer"},"description":{"description":"地址组成员描述","type":"string"}},"required":["address"]},"type":"array"},"set_id":{"description":"地址组id,可通过[查询地址组列表接口](ListAddressSets.xml)查询获得,通过返回值中的data.records.set_id(.表示各对象之间层级的区分)获得。","type":"string"}},"title":"AddAddressItemsInfoDto","type":"object"},"AddAddressItemsResponse":{"properties":{"data":{"$ref":"#/definitions/AddressItems","description":"添加地址组成员返回数据"}},"type":"object"},"AddressItemIdWithoutName":{"properties":{"id":{"description":"地址组成员id","type":"string"}},"type":"object"},"AddressItems":{"properties":{"covered_ip":{"description":"覆盖ip列表","items":{"$ref":"#/definitions/CoveredIPVO"},"type":"array"},"items":{"description":"地址组成员id列表","items":{"$ref":"#/definitions/AddressItemIdWithoutName"},"type":"array"}},"type":"object"},"CoveredIPVO":{"properties":{"covered_Ip":{"description":"覆盖ip地址。","type":"string"},"ip":{"description":"ip地址","type":"string"}},"type":"object"},"ErrorRsp":{"description":"**参数解释**:\n失败时返回的错误信息\n**取值范围**:\n不涉及","properties":{"error_code":{"description":"**参数解释**:\n错误码\n**取值范围**:\n不涉及","readOnly":true,"type":"string"},"error_msg":{"description":"**参数解释**:\n错误描述\n**取值范围**:\n不涉及","readOnly":true,"type":"string"}}}},"description":null,"group_id":"908dce82fb734ea0801d7bf646ebe440","host":"cfw.cn-north-4.myhuaweicloud.com","id":"c07156f59ac44aa0b3a5e8dd1706da3d","info_version":"v1","method":"post","name":"AddAddressItem","parameters":{},"paths":{"/v1/{project_id}/address-items":{"post":{"consumes":["application/json"],"description":"添加地址组成员","operationId":"AddAddressItem","parameters":[{"description":"项目ID, 可以从调API处获取,也可以从控制台获取。[项目ID获取方式](cfw_02_0015.xml)","in":"path","name":"project_id","required":true,"type":"string"},{"description":"用户Token。可通过[如何获取用户Token](cfw_02_0008.xml)获取。","in":"header","name":"X-Auth-Token","required":true,"type":"string"},{"description":"添加地址组成员请求体","in":"body","name":"AddAddressItemsUsingPOSTRequestBody","required":true,"schema":{"$ref":"#/definitions/AddAddressItemsInfoDto"}},{"description":"企业项目ID,用户根据组织规划企业项目,对应的ID为企业项目ID,可通过[如何获取企业项目ID](cfw_02_0027.xml)获取,用户未开启企业项目时为0","in":"query","name":"enterprise_project_id","required":false,"type":"string"},{"description":"防火墙id,可通过[防火墙ID获取方式](cfw_02_0028.xml)获取","in":"query","name":"fw_instance_id","required":false,"type":"string"}],"produces":["*/*"],"responses":{"200":{"description":"添加地址组成员返回值","examples":{"application/json":{"data":{"covered_ip":[],"items":[{"id":"65cb47fc-e666-4af4-8c2c-1fbd2f4b1eae"}]}}},"schema":{"$ref":"#/definitions/AddAddressItemsResponse"}},"400":{"description":"Bad Request","examples":{"application/json":{"error_code":"CFW.00200001","error_msg":"空参数错误"}},"schema":{"$ref":"#/definitions/ErrorRsp"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"summary":"添加地址组成员","tags":["地址组管理"],"x-is-registered":"Y","x-order":1,"x-request-examples-1":{"address_items":[{"address":"2.2.2.2","description":""}],"set_id":"8773c082-2a6c-4529-939a-edc28ef1a67c"},"x-request-examples-description-1":"给项目id为9d80d070b6d44942af73c9c3d38e0429的项目下的set_id为8773c082-2a6c-4529-939a-edc28ef1a67c添加ip地址为2.2.2.2,名称为ceshi的地址组成员","x-request-examples-text-1":{"address_items":[{"address":"2.2.2.2","description":""}],"set_id":"8773c082-2a6c-4529-939a-edc28ef1a67c"},"x-request-examples-url-1":"https://{Endpoint}/v1/9d80d070b6d44942af73c9c3d38e0429/address-items","x-support-sdk":"Y"}}},"product_short":"CFW","region_id":"cn-north-4","schemes":["HTTPS"],"security_definitions":null,"summary":"添加地址组成员","tags":"地址组管理","uri":null,"version":"2.0"}