云服务器内容精选

  • 请求示例 查询项目id为9d80d070b6d44942af73c9c3d38e0429的项目的地址组id为8773c082-2a6c-4529-939a-edc28ef1a67c的地址组成员信息 https://{Endpoint}/v1/9d80d070b6d44942af73c9c3d38e0429/address-items?set_id=8773c082-2a6c-4529-939a-edc28ef1a67c&limit=10&offset=0
  • 响应示例 状态码: 200 查询地址组成员返回值 { "data" : { "limit" : 10, "offset" : 0, "records" : [ { "address" : "1.1.1.1", "address_type" : 0, "description" : "", "item_id" : "294fab71-34bf-4858-a380-8f7530e1c816" } ], "set_id" : "8773c082-2a6c-4529-939a-edc28ef1a67c", "total" : 1 } } 状态码: 400 Bad Request { "error_code" : "CFW.00200005", "error_msg" : "操作内容不存在" }
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 data data object 查询地址组成员返回数据 表5 data 参数 参数类型 描述 offset Integer 偏移量:指定返回记录的开始位置,必须为数字,取值范围为大于或等于0,默认0 limit Integer 每页显示个数,范围为1-1024 total Integer 地址组成员总数 set_id String 地址组id records Array of records objects 地址组成员记录列表 表6 records 参数 参数类型 描述 item_id String 地址组成员id name String 地址组成员name description String 描述 address_type Integer 地址组类型,0 ipv4,1 ipv6 address String 地址信息 状态码: 400 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述
  • URI GET /v1/{project_id}/address-items 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID, 可以从调API处获取,也可以从控制台获取。项目ID获取方式 表2 Query参数 参数 是否必选 参数类型 描述 set_id 是 String 地址组id,可通过查询地址组列表接口查询获得,通过返回值中的data.records.set_id(.表示各对象之间层级的区分)获得。 key_word 否 String 关键字,包括地址组成员名称或描述的一部分 limit 是 Integer 每页显示个数,范围为1-1024 offset 是 Integer 偏移量:指定返回记录的开始位置,必须为数字,取值范围为大于或等于0,默认0 address 否 String ip地址 enterprise_project_id 否 String 企业项目ID,用户根据组织规划企业项目,对应的ID为企业项目ID,可通过如何获取企业项目ID获取,用户未开启企业项目时为0 fw_instance_id 否 String 防火墙id,可通过防火墙ID获取方式获取 query_address_set_type 否 Integer 查询地址组类型,0表示自定义地址组,1表示预定义地址组
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 id String 地址组id name String 地址组名称 ips String 地址组ip(以逗号分隔的ip或ip段) size Integer 地址组长度 rules Array of RuleInfo objects ip地址组绑定的规则列表 share_info ShareInfo object 共享信息 description String 地址组描述 表5 RuleInfo 参数 参数类型 描述 rule_id String 规则id rule_name String 规则名称 policy_id String 策略id policy_name String 策略名称 表6 ShareInfo 参数 参数类型 描述 share_count Integer 共享用户数 accept_count Integer 接受用户数 process_status Integer 处理状态 状态码: 400 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误信息 状态码: 401 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误信息 状态码: 500 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误信息
  • 请求示例 查询项目id为5c69cf330cda42369cbd726ee1bc5e76,防护对象id为8a41d6a5-f215-428a-a76c-dc923b5d599a的第一页的ip地址组信息 https://{Endpoint}/v1/5c69cf330cda42369cbd726ee1bc5e76/address-sets?object_id=8a41d6a5-f215-428a-a76c-dc923b5d599a&limit=10&offset=0
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 data data object 查询地址组列表返回数据 表5 data 参数 参数类型 描述 offset Integer 偏移量:指定返回记录的开始位置,必须为数字,取值范围为大于或等于0,默认0 limit Integer 每页显示个数 total Integer 总数 records Array of records objects 地址组列表 表6 records 参数 参数类型 描述 set_id String 地址组id ref_count Integer 引用次数 description String 描述信息 name String 地址组名称 address_type Integer 地址类型0 ipv4,1 ipv6 状态码: 400 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度:8 最大长度:36 error_msg String 错误描述 最小长度:2 最大长度:512
  • 响应示例 状态码: 200 OK { "data" : { "limit" : 10, "offset" : 0, "records" : [ { "address_type" : 0, "description" : "", "name" : "ceshi", "ref_count" : 0, "set_id" : "50da1eff-e58d-4380-b899-a78f94137d3b" } ], "total" : 1 }} 状态码: 400 Bad Request { "error_code" : "CFW.0020016", "error_msg" : "实例状态错误"}
  • URI GET /v1/{project_id}/address-sets 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户项目id 表2 Query参数 参数 是否必选 参数类型 描述 object_id 是 String 防护对象id,是创建 云防火墙 后用于区分互联网边界防护和VPC边界防护的标志id,可通过调用查询防火墙实例接口获得,注意type为0的为互联网边界防护对象id,type为1的为VPC边界防护对象id。具体可参考APIExlorer和帮助中心FAQ。 key_word 否 String 关键字 limit 是 Integer 每页显示个数 offset 是 Integer 偏移量:指定返回记录的开始位置,必须为数字,取值范围为大于或等于0,默认0 address 否 String ip地址 address_type 否 Integer 地址类型0 ipv4,1 ipv6 枚举值: 0 1 enterprise_project_id 否 String 企业项目id,用户支持企业项目后,由企业项目生成的id。 fw_instance_id 否 String 防火墙实例id,创建云防火墙后用于标志防火墙由系统自动生成的标志id,可通过调用查询防火墙实例接口获得。具体可参考APIExlorer和帮助中心FAQ。默认情况下,fw_instance_Id为空时,返回帐号下第一个墙的信息;fw_instance_Id非空时,返回与fw_instance_Id对应墙的信息。