云服务器内容精选

  • 响应示例 状态码: 200 查询地址组细节返回体 { "data" : { "address_set_type" : 0, "address_type" : 0, "description" : "", "id" : "cf18f0b1-0ce7-4eb8-83b6-4b33c8448e16", "name" : "ABC" } } 状态码: 400 Bad Request { "error_code" : "CFW.00200005", "error_msg" : "操作内容不存在" }
  • URI GET /v1/{project_id}/address-sets/{set_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID, 可以从调API处获取,也可以从控制台获取。项目ID获取方式 set_id 是 String 地址组id,可通过查询地址组列表接口查询获得,通过返回值中的data.records.set_id(.表示各对象之间层级的区分)获得。 表2 Query参数 参数 是否必选 参数类型 描述 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参数 参数 参数类型 描述 data data object 查询地址组详情数据 表5 data 参数 参数类型 描述 id String 地址组id name String 地址组名称 description String 地址组描述 address_set_type Integer 地址组类型,0表示自定义地址组,1表示WAF回源IP地址组,2表示DDoS回源IP地址组,3表示NAT64转换地址组 address_type Integer 地址类型0 ipv4,1 ipv6 状态码: 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述
  • 响应示例 状态码: 200 删除规则返回数据 { "data" : { "id" : "ceaa0407-b9c8-4dfd-9eca-b6ead2dfd031", "name" : "name" } } 状态码: 400 Bad Request { "error_code" : "CFW.00900016", "error_msg" : "导入任务进行中,请任务结束后再操作" }
  • URI DELETE /v1/{project_id}/acl-rule/{acl_rule_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID, 可以从调API处获取,也可以从控制台获取。项目ID获取方式 acl_rule_id 是 String 规则id,可通过查询防护规则接口查询获得,通过返回值中的data.records.rule_id(.表示各对象之间层级的区分)获得。 表2 Query参数 参数 是否必选 参数类型 描述 enterprise_project_id 否 String 企业项目ID,用户根据组织规划企业项目,对应的ID为企业项目ID,可通过如何获取企业项目ID获取,用户未开启企业项目时为0 fw_instance_id 否 String 防火墙id,可通过防火墙ID获取方式获取
  • URI POST /v1/{project_id}/cfw/logs/configuration 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID, 可以从调API处获取,也可以从控制台获取。项目ID获取方式 表2 Query参数 参数 是否必选 参数类型 描述 fw_instance_id 是 String 防火墙id,可通过防火墙ID获取方式获取 enterprise_project_id 否 String 企业项目ID,用户根据组织规划企业项目,对应的ID为企业项目ID,可通过如何获取企业项目ID获取,用户未开启企业项目时为0
  • 请求示例 给项目id为408972e72dcd4c1a9b033e955802a36b下的防火墙4d6c860a-0338-49e8-ac64-fcaeb4182ba5添加日志流配置,lts分组id为20282428-a8f9-4e75-8246-165e64cf8ba8,访问控制日志流关闭,流量日志流关闭,攻击日志流关闭,lts关闭。 https://{Endpoint}/v1/408972e72dcd4c1a9b033e955802a36b/cfw/logs/configuration?fw_instance_id=4d6c860a-0338-49e8-ac64-fcaeb4182ba5&enterprise_project_id=default { "fw_instance_id" : "4d6c860a-0338-49e8-ac64-fcaeb4182ba5", "lts_enable" : 0, "lts_log_group_id" : "20282428-a8f9-4e75-8246-165e64cf8ba8", "lts_attack_log_stream_enable" : 0, "lts_access_log_stream_enable" : 0, "lts_flow_log_stream_enable" : 0 }
  • 请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。可通过如何获取用户Token获取。 表4 请求Body参数 参数 是否必选 参数类型 描述 fw_instance_id 是 String 防火墙id,可通过防火墙ID获取方式获取 lts_enable 是 Integer 是否开启LTS,1表示是,0表示不是 lts_log_group_id 是 String LTS日志分组id,可通过查询LTS( 云日志 服务)下查询账号下所有日志组接口获得,通过返回值中的log_groups.log_group_id(.表示各对象之间层级的区分)获得 lts_attack_log_stream_id 否 String 攻击日志流id,可通过查询LTS(云日志服务)下查询指定日志组下的所有日志流接口获得,通过返回值中的log_streams.log_stream_id(.表示各对象之间层级的区分)获得 lts_attack_log_stream_enable 否 Integer 是否开启攻击日志流,1表示是,0表示不是 lts_access_log_stream_id 否 String 访问控制日志流id,可通过查询LTS(云日志服务)下查询指定日志组下的所有日志流接口获得,通过返回值中的log_streams.log_stream_id(.表示各对象之间层级的区分)获得 lts_access_log_stream_enable 否 Integer 是否开启访问控制流,1表示是,0表示不是 lts_flow_log_stream_id 否 String 流量日志id,可通过查询LTS(云日志服务)下查询指定日志组下的所有日志流接口获得,通过返回值中的log_streams.log_stream_id(.表示各对象之间层级的区分)获得 lts_flow_log_stream_enable 否 Integer 是否开启流量日志,1表示是,0表示不是
  • 请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。可通过如何获取用户Token获取。 表4 请求Body参数 参数 是否必选 参数类型 描述 fw_instance_id 是 String 防火墙实例id,创建 云防火墙 后用于标志防火墙由系统自动生成的标志id,可通过调用查询防火墙实例接口。 object_id 是 String 防护对象id,是创建云防火墙后用于区分互联网边界防护和VPC边界防护的标志id,可通过调用查询防火墙实例接口获得,通过返回值中的data.records.protect_objects.object_id(.表示各对象之间层级的区分)获得,注意type为0的为互联网边界防护对象id,type为1的为VPC边界防护对象id,type可通过data.records.protect_objects.type(.表示各对象之间层级的区分)获得 domain_names 是 Array of DomainSetInfoDto objects 域名 列表 表5 DomainSetInfoDto 参数 是否必选 参数类型 描述 domain_name 是 String 域名,如www.test.com description 否 String 域名描述
  • 请求示例 给项目id为14181c1245cf4fd786824efe1e2b9388下的域名组添加域名,防火墙id为546af3f8-88e9-47f2-a205-2346d7090925,防护对象id为ae42418e-f077-41a0-9d3b-5b2f5ad9102b,域名组id为78719348-6d79-477e-acec-676a29842ab2,域名为www.bnm.com和www.vbc.com https://{Endpoint}v1/14181c1245cf4fd786824efe1e2b9388/domain-set/domains/78719348-6d79-477e-acec-676a29842ab2?fw_instance_id=546af3f8-88e9-47f2-a205-2346d7090925&enterprise_project_id=default { "domain_names" : [ { "description" : "", "domain_name" : "www.bnm.com" }, { "description" : "", "domain_name" : "www.vbc.com" } ], "fw_instance_id" : "546af3f8-88e9-47f2-a205-2346d7090925", "object_id" : "ae42418e-f077-41a0-9d3b-5b2f5ad9102b" }
  • URI POST /v1/{project_id}/domain-set/domains/{set_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID, 可以从调API处获取,也可以从控制台获取。项目ID获取方式 set_id 是 String 域名组id,可通过查询域名组列表接口查询获得,通过返回值中的data.records.set_id(.表示各对象之间层级的区分)获得。 表2 Query参数 参数 是否必选 参数类型 描述 enterprise_project_id 否 String 企业项目ID,用户根据组织规划企业项目,对应的ID为企业项目ID,可通过如何获取企业项目ID获取,用户未开启企业项目时为0 fw_instance_id 否 String 防火墙id,可通过防火墙ID获取方式获取
  • URI DELETE /v1/{project_id}/black-white-list/{list_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID, 可以从调API处获取,也可以从控制台获取。项目ID获取方式 list_id 是 String 黑白名单列表id,可通过查询黑白名单列表接口查询获得,通过返回值中的data.records.list_id(.表示各对象之间层级的区分)获得。 表2 Query参数 参数 是否必选 参数类型 描述 enterprise_project_id 否 String 企业项目ID,用户根据组织规划企业项目,对应的ID为企业项目ID,可通过如何获取企业项目ID获取,用户未开启企业项目时为0 fw_instance_id 否 String 防火墙id,可通过防火墙ID获取方式获取
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 data BlackWhiteListId object 删除黑白名单响应数据 表5 BlackWhiteListId 参数 参数类型 描述 id String 黑白名单id name String 黑白名单名称,为黑白名单的地址 状态码: 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述
  • 请求示例 删除项目id为9d80d070b6d44942af73c9c3d38e0429下的黑白名单id为2eee3fe8-0b9b-49ac-8e7f-eaafa321e99a的黑白名单 https://{Endpoint}/v1/9d80d070b6d44942af73c9c3d38e0429/black-white-list/2eee3fe8-0b9b-49ac-8e7f-eaafa321e99a
  • 响应示例 状态码: 200 查询服务组详情返回值 { "data" : { "service_set_type" : 0, "id" : "221cfdca-3abf-4c30-ab0d-516a03c70866", "name" : "ceshi2" } } 状态码: 400 Bad Request { "error_code" : "CFW.00200005", "error_msg" : "操作内容不存在" }