华为云用户手册

  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 表3 请求Body参数 参数 是否必选 参数类型 描述 name 是 String 自定义认证的名称。 长度为3 ~ 64位的字符串,字符串由中文、英文字母、数字、“_”组成,且只能以英文或中文开头。 type 是 String 自定义认证类型 FRONTEND:前端 BACKEND:后端 不支持修改 枚举值: FRONTEND BACKEND authorizer_type 是 String 只能为:FUNC 枚举值: FUNC authorizer_uri 是 String 函数地址。 network_type 否 String 对接函数的网络架构类型 V1:非VPC网络架构 V2:VPC网络架构 缺省值:V1 枚举值: V1 V2 authorizer_version 否 String 函数版本。 当函数别名URN和函数版本同时传入时,函数版本将被忽略,只会使用函数别名URN 最大长度:64 authorizer_alias_uri 否 String 函数别名地址。 当函数别名URN和函数版本同时传入时,函数版本将被忽略,只会使用函数别名URN identities 否 Array of Identity objects 认证来源 ttl 否 Integer 缓存时间 user_data 否 String 用户数据 ld_api_id 否 String 自定义后端服务ID。 暂不支持 need_body 否 Boolean 是否发送body 表4 Identity 参数 是否必选 参数类型 描述 name 是 String 参数名称 location 是 String 参数位置 枚举值: HEADER QUERY validation 否 String 参数校验表达式,默认为null,不做校验
  • 响应示例 状态码: 200 OK { "total" : 1, "size" : 1, "acls" : [ { "bind_num" : 0, "id" : "7eb619ecf2a24943b099833cd24a01ba", "acl_name" : "acl_demo", "entity_type" : "IP", "acl_type" : "PERMIT", "acl_value" : "192.168.1.5,192.168.10.1", "update_time" : "2020-08-04T08:42:43Z" } ] } 状态码: 400 Bad Request { "error_code" : "APIG.2011", "error_msg" : "Invalid parameter value,parameterName:name. Please refer to the support documentation" } 状态码: 401 Unauthorized { "error_code" : "APIG.1002", "error_msg" : "Incorrect token or token resolution failed" } 状态码: 403 Forbidden { "error_code" : "APIG.1005", "error_msg" : "No permissions to request this method" } 状态码: 404 Not Found { "error_code" : "APIG.3030", "error_msg" : "The instance does not exist;id:eddc4d25480b4cd6b512f270a1b8b341" } 状态码: 500 Internal Server Error { "error_code" : "APIG.9999", "error_msg" : "System error" }
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 size Integer 本次返回的列表长度 total Long 满足条件的记录数 acls Array of ApiAclInfoWithBindNum objects 本次查询返回的ACL策略列表 表5 ApiAclInfoWithBindNum 参数 参数类型 描述 acl_name String ACL策略名称 acl_type String 类型 PERMIT(白名单类型) DENY(黑名单类型) acl_value String ACL策略的值 bind_num Integer 绑定的API数量 entity_type String 对象类型 IP DOMAIN DOMAIN_ID id String ACL策略编号 update_time String 更新时间 状态码: 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码: 401 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码: 403 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码: 404 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码: 500 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述
  • URI GET /v2/{project_id}/apigw/instances/{instance_id}/acls 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID,获取方式请参见获取项目ID。 instance_id 是 String 实例ID,在API网关控制台的“实例信息”中获取。 表2 Query参数 参数 是否必选 参数类型 描述 offset 否 Long 偏移量,表示从此偏移量开始查询,偏移量小于0时,自动转换为0 缺省值:0 limit 否 Integer 每页显示的条目数量,条目数量小于等于0时,自动转换为20,条目数量大于500时,自动转换为500 最小值:1 最大值:500 缺省值:20 id 否 String ACL策略编号。 name 否 String ACL策略名称。 acl_type 否 String 类型 PERMIT (白名单类型) DENY (黑名单类型) entity_type 否 String 作用的对象类型: IP DOMAIN precise_search 否 String 指定需要精确匹配查找的参数名称,目前仅支持name
  • 响应示例 状态码: 400 Bad Request { "error_code" : "APIG.3201", "error_msg" : "The API group name already exists" } 状态码: 401 Unauthorized { "error_code" : "APIG.1002", "error_msg" : "Incorrect token or token resolution failed" } 状态码: 403 Forbidden { "error_code" : "APIG.1005", "error_msg" : "No permissions to request this method" } 状态码: 404 Not Found { "error_code" : "APIG.3030", "error_msg" : "The instance does not exist;id:f0fa1789-3b76-433b-a787-9892951c620ec" } 状态码: 500 Internal Server Error { "error_code" : "APIG.9999", "error_msg" : "System error" }
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 表3 请求Body参数 参数 是否必选 参数类型 描述 group_name 是 String 待校验的API分组名称 roma_app_id 否 String 集成应用ID 暂不支持
  • 响应参数 状态码: 400 表4 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码: 401 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码: 403 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码: 404 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码: 500 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述
  • 相关操作 规则添加成功后,默认的“规则状态”为“已开启”,若您暂时不想使该规则生效,可在目标规则所在行的“操作”列,单击“关闭”。 若需要修改添加的全局白名单(原误报屏蔽)规则时,可单击待修改的全局白名单(原误报屏蔽)规则所在行的“修改”,修改全局白名单(原误报屏蔽)规则。 若需要删除添加的全局白名单(原误报屏蔽)规则时,可单击待删除的全局白名单(原误报屏蔽)规则所在行的“删除”,删除全局白名单(原误报屏蔽)规则。
  • 防护效果 假如已添加域名“www.example.com”。可参照以下步骤验证防护效果: 清理浏览器缓存,在浏览器中输入防护域名,测试网站域名是否能正常访问。 不能正常访问,参照网站设置章节重新完成域名接入。 能正常访问,执行2。 参照操作步骤,将您的客户端IP来源地配置为拦截。 清理浏览器缓存,在浏览器中访问“http://www.example.com”页面,正常情况下,WAF会阻断该来源地IP的访问请求,返回拦截页面。 返回Web应用防火墙控制界面,在左侧导航树中,单击“防护事件”,进入“防护事件”页面,查看防护域名拦截日志,您也可以下载防护事件数据。
  • 配置示例-仅允许某一地区来源IP访问请求 假如防护域名“www.example.com”已接入WAF,当您只允许某一地区的IP可以访问防护域名,例如,只允许来源“上海”地区的IP可以访问防护域名,请参照以下步骤处理。 添加一条地理位置访问控制规则,添加“上海”地区的“放行”防护动作。 图2 添加“放行”防护动作 开启地理位置访问控制。 图3 地理位置访问控制配置框 配置一条精准访问防护规则,拦截所有的请求。 图4 拦截所有访问请求 有关配置精准访问防护规则的详细介绍,请参见配置精准访问防护规则定制化防护策略。 清理浏览器缓存,在浏览器中访问“http://www.example.com”页面。 当非“上海”地区的源IP访问页面时,WAF将拦截该访问请求,拦截页面示例如图5所示。 图5 WAF拦截攻击请求 返回Web应用防火墙管理控制台,在左侧导航树中,单击“防护事件”,进入“防护事件”页面,您可以查看到非“上海”地区的源IP都被拦截。
  • 配置示例-拦截某一地区来源IP访问请求 假如防护域名“www.example.com”已接入WAF,您需要拦截所有来源“北京”地区的IP访问防护域名,可以参照以下操作步骤验证防护效果。 添加一条地理位置访问控制规则,设置“北京”地区“拦截”动作。 图6 拦截某一地区访问请求 开启地理位置访问控制。 图7 地理位置访问控制配置框 清理浏览器缓存,在浏览器中访问“http://www.example.com”页面。 当“北京”地区的源IP访问页面时,WAF将拦截该访问请求,拦截页面示例如图8所示。 图8 WAF拦截攻击请求 返回Web应用防火墙管理控制台,在左侧导航树中,单击“防护事件”,进入“防护事件”页面,您可以查看该防护事件。 图9 查看防护事件-拦截某一地区IP访问请求
  • 配置示例-屏蔽Cookie字段 假如防护域名“www.example.com”已接入WAF,您可以参照以下操作步骤验证屏蔽Cookie字段名“jsessionid”防护效果。 添加一条隐私屏蔽规则。 图2 添加“jsessionid”字段名隐私屏蔽规则 开启隐私屏蔽。 图3 隐私屏蔽配置框 在左侧导航树中,单击“防护事件”,进入“防护事件”页面。 在目标防护事件所在行的“操作”列中,单击“详情”,查看事件详细信息。 该防护事件的Cookie字段名“jsessionid”信息被屏蔽。 图4 查看防护事件-隐私屏蔽
  • 配置示例-静态页面防篡改 假如防护域名“www.example.com”已接入WAF,“/admin”静态页面已被篡改,您可以参照以下操作步骤验证防护效果。 在浏览器中访问“http://www.example.com/admin”静态页面。 此时,显示的是被篡改的页面。 图2 静态页面被篡改示例 添加一条网页防篡改规则。 图3 添加网页防篡改规则 开启网页防篡改。 图4 网页防篡改配置框 在浏览器中访问“http://www.example.com/admin”, 等待WAF缓存静态页面。 在浏览器中访问篡改后的页面。 此时,显示的是被篡改前的页面。
  • 多表归一场景注意事项 DRS支持多表对一的数据聚合场景,最佳实践是推荐只选择同步加列DDL,其他大部分DDL同步都可能会因目标表修改而导致其他任务失败或数据不一致的情况发生,常见情况有:同步truncate导致目标数据全部被清空;同步创建索引导致目标表被锁定;同步rename导致其他任务找不到目标表而失败;同步改列导致其他任务因数据类型不兼容而失败。 多表归一高风险操作: DROP、TRUNCATE、RENAME等高危DDL未过滤,导致目标表DROP、TRUNCATE、RENAME。 随意执行DDL,导致同步任务中断未提前识别业务数据冲突,出现同步后数据不一致。 多对一的表不支持Online DDL工具。Online DDL通常会使用临时表和执行rename操作,多对一任务如果未过滤rename会导致目标数据丢失。 多表归一DDL操作技巧: 增加列ADD COLUMN: 配置DRS任务时过滤ADD COLUMN:先在目标库目标表增加列,再在每个多对一任务的源库源表分别增加列。同步任务会自动兼容源表列少于目标表的场景,因此任务不受影响。顺序相反则会导致任务中断。 配置DRS任务时未过滤ADD COLUMN:DRS会自动识别只执行一次DDL,不会导致任务失败。 修改列MODIFY COLUMN: 配置DRS任务时过滤MODIFY COLUMN:需要确保所有源表已经完成同步无时延并且无业务写入,先在目标库目标表修改列,再在每个多对一任务的源库源表分别修改列。 配置DRS任务时未过滤MODIFY COLUMN:DRS会自动识别只执行一次DDL,不会导致任务失败。 删除列DROP COLUMN: 配置DRS任务时过滤DROP COLUMN:先在每个源库源表删除列,多对一任务的所有源表删除列后,再在目标库表删除列。同步任务会自动兼容源表列少于目标表的场景,因此任务不受影响。顺序相反则会导致任务中断。 配置DRS任务时未过滤DROP COLUMN:DRS会自动识别只执行一次DDL,不会导致任务失败。 DROP、TRUNCATE类操作: 高危操作建议配置DRS任务时过滤掉,手工执行。如果未选择过滤,多对一任务一张源表的DROP、TRUNCATE操作会同步到目标表执行DROP、TRUNCATE操作,比如多对一任务DROP掉其中一个表,在目标库就把多对一的表DROP掉了,DROP索引、DROP约束是类似的。
  • 对等连接限制 有重叠子网网段的VPC建立的对等连接,可能不生效。 两个VPC之间不能同时建立多个VPC对等连接。 不同区域的VPC不能创建对等连接。 如果两个VPC的CIDR有重叠,建立对等连接时,只能针对子网建立对等关系。如果两个VPC下的子网网段有重叠,那么该对等关系不生效。建立对等连接时,请确保两个VPC之间没有重叠的子网。 对等连接建立后,需要在本端VPC、对端VPC分别添加对方子网的路由才能通信。 VPC A与B、C分别建立对等连接,如果B、C两个VPC的网段有重叠,A中无法添加具有相同目的网段的路由。 为了安全起见,请不要接受来自未知账号的对等连接申请。 对等连接双方账号都有权限删除对等连接,一方删除对等连接后,对等连接的所有信息会被立刻删除,包括对等连接关联的路由信息。 VPC对等连接路由存在时,VPC无法被删除。 支持在华为云中国站和国际站同一区域创建对等连接。 VPC1与VPC2创建对等连接,默认情况下VPC2不能通过VPC1的EIP访问公网。您可以通过使用NAT网关服务或配置SNAT服务器,使得VPC2下的弹性云服务器可以通过VPC1下绑定了EIP的弹性云服务器访问Internet。具体实现方式请参见无公网IP的弹性云服务器访问Internet。 具体设置VPC对等连接的方法,可参考《虚拟私有云用户指南》。 对等连接建立后,需要在本端VPC、对端VPC分别添加对方子网的路由才能通信,详细操作可参考添加VPC对等连接路由。 在添加对等路由时,建议添加网段路由信息。如果添加点对点路由,DRS任务重建后实例IP会发生改变,此时需要重新添加路由,否则会导致网络不通。
  • 可能原因 原因1:全量阶段刚结束,增量迁移延迟高。全量迁移过程中,源库增量数据还在不断地写入,DRS需要在全量结束之后,将这部分增量数据同步到目标端去,因此时延较高。 原因2:源库有大批量数据变更(导入、更新、删除)。大事务写入在源库执行时间本来就很长,而DRS把数据同步到目标库也需要一段时间,所以此时延迟会慢慢增加,如果此大事务的表没有主键或者索引,恢复时间会相应拉长。 原因3:源库存在大批量DDL操作,DDL执行比较慢,同步到目标导致时延增高。 原因4:DRS任务规格限制。DRS不同规格对应的性能上限不同,详细可参考规格说明,当源库数据写入量过大达到瓶颈时,就会导致任务出现延迟。 原因5:目标库规格受限,达到写入瓶颈。以目标实例为RDS for MySQL为例,用户可以在RDS控制台查看数据库性能指标。 原因6:可能存在热点更新。无主键表的写入会导致热点更新,源库对单一表或单一行的高频更新也会导致热点更新,从而导致时延增大。以RDS for MySQL为例,可以通过RDS的审计日志进行确认,详情可参考RDS审计日志。 原因7:网络不稳定导致的时延增大。
  • 解决方法 解决方法1:针对这种情况,DRS会自动追平时延,无需处理,用户可观察增量时延是否降低。 解决方法2:存在大事务写入的情况时,等待更新完毕,或者从业务上考虑尽量避免大事务写入的情况。用户可查看源库执行历史,看是否有大事务的写入,同时可以在目标库查看DRS数据回放情况。以MySQL为例,可执行show processlist查看。 解决方法3:源库应尽量避免执行批量DDL,如果必须执行DDL,请尽量在业务低峰期执行。 解决方法4:重新创建任务,选择较大规格提升同步性能(目前,DRS同步仅支持任务类型为单AZ的同步任务升级实例规格,不支持降低规格,具体操作及约束限制可参考同步规格变更)。 解决方法5:升级目标库的实例规格,提高目标库实例写入性能。以目标实例为RDS for MySQL为例,参考变更规格,升级实例配置。 解决方法6:如果存在热点更新,需要等待热点更新完毕,或者从业务上尽量避免热点更新。 解决方法7:网络延迟无法避免,用户可以通过专线网络接入源库和目标库实例减少延迟。
  • WAF获取真实IP是从报文中哪个字段获取到的? WAF引擎会根据防护规则确定是否代理转发请求去后端,如果WAF配置了基于IP的规则(比如黑白名单、地理位置、基于IP的精准访问防护规则),那么WAF引擎就会获取真实IP后才能放行或者拦截代理请求。获取真实IP的方法基于以下原则: 在WAF中开启了代理,即添加域名时,“是否已使用代理”选择了“四层代理”或“七层代理”,按以下顺序获取源IP: 优先取“upstream”中配置的源IP头列表,即在域名的基本信息页面配置的“IP标记”,具体的操作请参见配置攻击惩罚的流量标识。如果未取到,执行2。 如果想以TCP连接IP作为客户端IP,“IP标记”应配置为“remote_addr”。 取config中配置的源IP头列表“cdn-src-ip”字段对应的值,未取到,执行3。 取“x-real-ip”字段的值,未取到,执行4。 取“x-forwarded-for”字段左边开始第一个公网IP,未取到,执行5。 取WAF看到的TCP连接IP,“remote_addr”字段对应的值。 在WAF中未开启代理,即添加域名时,“是否已使用代理”选择了“无代理”,直接取“remote_ip”字段的值为真实IP。 获取客户端的真实IP的具体方法,详见获取客户端真实IP。 父主题: 防护日志
  • Web应用防火墙支持哪些工作模式和防护模式? 域名接入WAF后,WAF作为一个反向代理部署在客户端和服务器之间,服务器的真实IP被隐藏起来,Web访问者只能看到WAF的IP地址。 WAF支持以下几种工作模式: 开启防护 暂停防护 Bypass 如果“部署模式”为“云模式”的网站在接入WAF前使用了代理,则不能切换为“Bypass”工作模式。 “部署模式”为“独享模式”的网站不支持“Bypass”工作模式。 有关切换WAF工作模式的详细操作,请参见切换工作模式。 WAF防护规则支持的防护模式说明如表1所示。 表1 支持的防护模式说明 防护规则 防护模式 Web基础防护规则 拦截 仅记录 CC攻击防护规则 人机验证 阻断 动态阻断 仅记录 精准访问防护规则 阻断 放行 仅记录 黑白名单规则 拦截 放行 仅记录 地理位置访问控制规则 拦截 放行 仅记录 须知: WAF专业版、铂金版、独享版和ELB模式支持配置该规则。 网站反爬虫规则 特征反爬虫支持以下防护动作: 拦截 仅记录 须知: WAF专业版、铂金版、独享版和ELB模式支持配置该规则。 拦截:发现攻击行为后立即阻断并记录。 仅记录:发现攻击行为后只记录不阻断攻击。 父主题: 其他类
  • CDN+WAF如何配置? CDN+WAF配置后,流量被CDN加速后转发到WAF,WAF再将流量转到源站,在提升用户访问网站的响应速度与网站的可用性的同时,实现网站流量检测和攻击拦截。 云模式 先将域名解析到CDN,再修改CDN源站信息,将源站域名修改为WAF的“CNAME”,同时,为了防止其他用户提前将您的域名配置到Web应用防火墙上,从而对您的域名防护造成干扰,建议您到DNS服务商处添加一条WAF的子域名和TXT记录。 独享模式 先将域名解析到CDN,再修改CDN源站信息,将源站IP修改为WAF独享引擎实例配置弹性负载均衡绑定的弹性公网IP。 ELB模式 先将域名解析到CDN,再修改CDN源站信息,将源站IP修改为ELB模式实例所绑定ELB的弹性公网IP。 有关同时部署CDN和WAF的详细介绍,请参见“CDN+WAF”联动提升网站防护能力和访问速度。 父主题: WAF与其他华为云服务同时部署
  • 响应示例 状态码: 200 查询DNAT规则成功。 { "dnat_rule" : { "id" : "24dd6bf5-48f2-4915-ad0b-5bb111d39c83", "project_id" : "da261828016849188f4dcc2ef94d9da9", "description" : "aa", "gateway_id" : "0adefb29-a6c2-48a5-8637-2be67fa03fec", "transit_ip_id" : "3faa719d-6d18-4ccb-a5c7-33e65a09663e", "enterprise_project_id" : "2759da7b-8015-404c-ae0a-a389007b0e2a", "network_interface_id" : "dae9393a-b536-491c-a5a2-72edc1104707", "type" : "COMPUTE", "protocol" : "any", "internal_service_port" : "0", "transit_service_port" : "0", "private_ip_address" : "192.168.1.72", "created_at" : "2019-04-29T07:10:01", "updated_at" : "2019-04-29T07:10:01" }, "request_id" : "747a911c17067a39692f75ac146fb47e" }
  • 响应示例 状态码: 200 查询操作成功。 { "request_id" : "36479272a29de0be0a8a8b294c02ab7a", "tags" : [ { "key" : "keys", "values" : [ "value" ] }, { "key" : "key3", "values" : [ "value3", "value33" ] }, { "key" : "key1", "values" : [ "value1" ] }, { "key" : "key2", "values" : [ "value2", "value22" ] } ] }
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 request_id String 请求id。 最小长度:1 最大长度:36 tags Array of Tags objects 标签。 数组长度:1 - 10 表4 Tags 参数 参数类型 描述 key String 键。最大长度128个unicode字符。搜索时不对此参数做校验,key不能为空或者空字符串,不能为空格,校验和使用之前先trim 前后空格。 最小长度:1 最大长度:128 values Array of strings 值列表。每个值最大长度255个unicode字符。 最小长度:0 最大长度:255
  • URI DELETE /v3/{project_id}/private-nat-gateways/{resource_id}/tags/{key} 表1 路径参数 参数 是否必选 参数类型 描述 key 是 String 标签key。 最小长度:1 最大长度:128 project_id 是 String 项目的ID。 最小长度:1 最大长度:32 resource_id 是 String 私网NAT网关的ID。 最小长度:36 最大长度:36
  • 响应示例 状态码: 200 查询公网NAT网关实例成功。 { "nat_gateway" : { "id" : "14338426-6afe-4019-996b-3a9525296e11", "name" : "nat-gateway-name", "description" : "nat-gateway-description", "spec" : "1", "router_id" : "d84f345c-80a1-4fa2-a39c-d0d397c3f09a", "tenant_id" : "70505c941b9b4dfd82fd351932328a2f", "enterprise_project_id" : "2759da7b-8015-404c-ae0a-a389007b0e2a", "internal_network_id" : "89d66639-aacb-4929-969d-07080b0f9fd9", "status" : "ACTIVE", "admin_state_up" : true, "billing_info" : "", "dnat_rules_limit" : 200, "snat_rule_public_ip_limit" : 20, "ngport_ip_address" : "192.168.0.138", "created_at" : "2019-04-22 08:47:13.902312" } }
  • 请求示例 添加私网NAT网关标签,其中,标签键为“key1”,对应的值为“value1”。 POST https://{Endpoint}/v3/cfa563efb77d4b6d9960781d82530fd8/private-nat-gateways/3320166e-b937-40cc-a35c-02cd3f2b3ee2/tags { "tag" : { "key" : "key1", "value" : "value1" } }
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 用户Token也就是调用获取用户Token获取请求认证接口的响应值,该接口是唯一不需要认证的接口。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 最小长度:1 最大长度:10240 表3 请求Body参数 参数 是否必选 参数类型 描述 tag 是 Tag object 标签。 表4 Tag 参数 是否必选 参数类型 描述 key 是 String 键。最大长度128个unicode字符。key不能为空。 最小长度:1 最大长度:128 value 是 String 值。每个值最大长度255个unicode字符。 最小长度:0 最大长度:255
  • 请求示例 查询私网NAT网关实例,其中,操作标识为filter,进行分页查询,查询记录数为10条。 POST https://{Endpoint}/v3/cfa563efb77d4b6d9960781d82530fd8/private-nat-gateways/resource_instances/action { "offset" : "10", "limit" : "10", "action" : "filter", "matches" : [ { "key" : "resource_name", "value" : "resource1" } ], "not_tags" : [ { "key" : "key1", "values" : [ "*value1", "value2" ] } ], "tags" : [ { "key" : "key1", "values" : [ "*value1", "value2" ] } ], "tags_any" : [ { "key" : "key1", "values" : [ "value1", "value2" ] } ], "not_tags_any" : [ { "key" : "key1", "values" : [ "value1", "value2" ] } ] } 查询私网NAT网关实例,其中,操作标识为count,按照条件将总条数返回。 POST https://{Endpoint}/v3/cfa563efb77d4b6d9960781d82530fd8/private-nat-gateways/resource_instances/action { "action" : "count", "not_tags" : [ { "key" : "key1", "values" : [ "value1", "*value2" ] } ], "tags" : [ { "key" : "key1", "values" : [ "value1", "value2" ] }, { "key" : "key2", "values" : [ "value1", "value2" ] } ], "tags_any" : [ { "key" : "key1", "values" : [ "value1", "value2" ] } ], "not_tags_any" : [ { "key" : "key1", "values" : [ "value1", "value2" ] } ], "matches" : [ { "key" : "resource_name", "value" : "resource1" } ] }
  • 响应示例 状态码: 200 查询操作成功。 示例1:action为count时的响应体 示例2:action为filter时的响应体 示例 1 { "request_id" : "a67262f6b7242d63d4ae95e41abf2790", "total_count" : 100 } 示例 2 { "resources" : [ { "resource_detail" : null, "resource_id" : "e5ad289f-9c56-4daf-b08b-2e53a983473a", "resource_name" : "nat_gateways", "tags" : [ { "key" : "key1", "value" : "value1" }, { "key" : "key2", "value" : "value1" } ] } ], "request_id" : "a67262f6b7242d63d4ae95e41abf2790", "total_count" : 1 }
  • 响应参数 状态码: 200 表6 响应Body参数 参数 参数类型 描述 resources Array of Resource objects 资源列表。 数组长度:1 - 2000 request_id String 请求id。 最小长度:1 最大长度:36 total_count Integer 总记录数。 表7 Resource 参数 参数类型 描述 resource_detail Object 资源详情。用于扩展。默认为空。 resource_id String 资源的ID。 最小长度:36 最大长度:36 resource_name String 资源名称,资源没有名称时默认为空字符串。 最小长度:0 最大长度:36 resource_tag Array of ResourceTag objects 标签列表,没有标签默认为空数组。 数组长度:1 - 10 表8 ResourceTag 参数 参数类型 描述 key String 标签key值。 最小长度:1 最大长度:128 value String 标签value。 最小长度:0 最大长度:255
共100000条