检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
调试域名是否可以访问,true表示可以访问,false表示禁止访问 缺省值:true sl_domains Array of strings 系统默认分配的子域名列表 remark String 描述 call_limits Integer 流控时长内分组下的API的总访问次数限制,默认不限,请根据服务的负载能力自行设置
向API调用方返回固定错误或者将请求转发到指定的降级后端。当后端服务恢复正常后,断路器关闭,请求恢复正常。 如果此策略在当前实例中不支持,可提交工单升级实例到最新版本。 策略参数会明文展示,为防止信息泄露,请谨慎配置。 约束与限制 同一个环境中,一个API只能被一个断路器策略绑定,但一个断路器策略可以绑定多个API。
共享版API(仅存量用户使用) API分组管理 API管理 APP管理 APP授权管理 环境管理 环境变量管理 流控策略管理 API绑定流控策略 设置特殊流控 ACL策略管理 API绑定ACL策略 云商店订购信息查询 配置管理 概要查询 签名密钥管理 签名密钥绑定关系管理 域名管理
已创建API,如果未创建API,请通过APIG创建REST API。 克隆API 进入API网关控制台页面。 根据实际业务在左侧导航栏上方选择实例。 在左侧导航栏选择“API管理 > API分组”。 单击分组名称,进入“分组信息”页面。 在“API运行”页面,单击“更多 > 克隆”。
求参数取值,配置不同算法规则,映射为新的请求参数和新的参数值。 创建编排规则 进入API网关控制台页面。 根据实际业务在左侧导航栏上方选择实例。 在左侧导航栏选择“API管理 > API策略”。 单击“编排规则管理”页签。 单击“创建编排规则”,根据下表参数说明,配置编排规则。 表1
怎样保护API的调用安全? 使用身份认证 创建API时,为API调用增加身份认证,如使用IAM认证或API网关提供的APP认证,防止API被恶意调用。 设置访问控制策略 从IP地址(或地址区间)以及账号等不同维度,设置白名单/黑名单。 将API绑定流控策略,通过流控策略保护API。 API网关默认
String 项目ID,获取方式请参见获取项目ID。 instance_id 是 String 实例ID,在API网关控制台的“实例信息”中获取。 ingress_port_id 是 String 实例自定义入方向端口ID。 表2 Query参数 参数 是否必选 参数类型 描述 offset
如果您需要对云上的资源进行精细管理,请使用IAM服务创建IAM用户及用户组,并授权,以使得IAM用户获得具体的操作权限。具体操作请参考创建用户并授权使用APIG。 在创建APIG实例前,确保已存在可用的VPC和子网。 APIG实例可以使用当前账号下已创建的VPC和子网,也可以使用新创建
查询租户配置详情 功能介绍 查询某个租户的配置项及其配置值。 URI 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI GET /v1.0/apigw/config/project[?page_size, page_no, config_id, config_name]
Integer 状态 app_key 否 String APP的KEY creator 否 String APP的创建者,取值如下: USER:用户自行创建 MARKET:云商店分配 page_size 否 Integer 每页显示的条数,默认值:20 page_no 否 Integer
String 函数urn identities 否 List 认证来源 ttl 否 Integer 缓存时间 user_data 否 String 用户数据 表3 identities参数说明 名称 是否必选 类型 说明 name 是 String 参数名称 location 是 String
API调用授权概述 API调用者在调用使用APP认证方式的API时,可以通过用凭据进行API认证或AppCode进行简易的API认证。您可以根据业务需求选择其中一种进行认证,下文介绍具体两种认证方式的配置。 配置APIG的API认证凭据 在API网关中创建一个凭据,生成密钥对(K
查询App Code列表 功能介绍 查询App Code列表。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI GET /v1.0/apigw/apps/{app_id}/app-codes[?page_size
String 函数urn identities 否 List 认证来源 ttl 否 Integer 缓存时间 user_data 否 String 用户数据 表4 identities参数说明 名称 是否必选 类型 说明 name 是 String 参数名称 location 是 String
响应Body参数 参数 参数类型 描述 app_call_limits Integer APP流量限制是指一个API在时长之内被每个APP访问的次数上限,该数值不超过用户流量限制值。输入的值不超过2147483647。正整数。 name String 流控策略名称。支持汉字,英文
查看ACL策略列表 功能介绍 查询所有的ACL策略列表。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI GET /v1.0/apigw/acls[?page_size, page_no, id, name
添加或更新后端实例 功能介绍 为指定的VPC通道添加后端实例 如果指定地址的后端实例已存在,则更新对应后端实例信息。如果请求体中包含多个重复地址的后端实例定义,则使用第一个定义。 引用负载通道类型的负载通道不支持添加或更新后端实例。 调用方法 请参见如何调用API。 URI POST
在APIG实例控制台选择“API管理 > 凭据管理”,进入凭据详情,获取Key和Secret。 AppKey/Key:APP访问密钥ID。与私有访问密钥关联的唯一标识符;访问密钥ID和私有访问密钥一起使用,对请求进行加密签名。 AppSecret/Secret:与访问密钥ID结合
String 实例ID,在API网关控制台的“实例信息”中获取。 group_id 是 String 分组的编号 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接
概要查询 查询API分组概况 查询API概况 查询APP概况 父主题: 共享版API(仅存量用户使用)