检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
将签名密钥绑定到API后,则API网关请求后端服务时就会使用这个签名密钥进行加密签名,后端服务可以校验这个签名来验证请求来源。 将指定的签名密钥绑定到一个或多个已发布的API上。同一个API发布到不同的环境可以绑定不同的签名密钥;一个API在发布到特定环境后只能绑定一个签名密钥。 调用方法 请参见如何调用API。 URI
为了让API响应结果为函数中返回的context中的字段(如果您使用的是专享版网关,并且实例支持authorizer_context_support_num_bool特性,那么context中的value的类型可以为boolean类型或number类型),需要修改网关响应模板。在API所在的分组中,“
对于共享版,域名必须完成备案,并将其CNAME解析到API分组对应的子域名。不能将无法在公网访问的域名,或者将他人所有的域名绑定给API分组。 对于专享版,可以配置内网域名,域名不需要备案,并将A记录解析到实例的入口地址。 父主题: 开放API
是否开启双向认证。如果开启,则使用实例配置中的backend_client_certificate配置项的证书 缺省值:false status 否 Integer 健康检查状态 1:可用 2:不可用 timeout 是 Integer 超时时间:检查期间,无响应的时间,单位为秒。必须小于time_interval字段取值。
项目ID,获取方式请参见获取项目ID。 instance_id 是 String 实例ID,在API网关控制台的“实例信息”中获取。 throttle_id 是 String 流控策略的编号 strategy_id 是 String 特殊配置的编号 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述
id String 特殊配置的编号 call_limits Integer 特殊对象在流控时间内能够访问API的最大次数限制 apply_time String 设置时间 app_name String 作用的APP名称 app_id String 作用的APP编号 object_id
String 筛选的特殊租户的账号ID 请求消息 无 响应消息 表3 参数说明 名称 类型 说明 throttle_specials 字典数据类型 本次查询返回的特殊配置列表 total Integer 符合条件的特殊设置总数 size Integer 本次查询返回的列表长度 表4
修改域名 功能介绍 修改绑定的域名所对应的配置信息。使用实例自定义入方向端口的特性时,注意开启/关闭客户端校验会对相同域名的不同端口同时生效。 调用方法 请参见如何调用API。 URI PUT /v2/{project_id}/apigw/instances/{instance_
String 筛选的特殊应用名称 user 否 String 筛选的特殊租户的账号ID 请求消息 无 响应消息 表3 参数说明 名称 类型 说明 throttle_specials 字典数据类型 本次查询返回的特殊配置列表 total Integer 符合条件的特殊设置总数 size
删除签名密钥 功能介绍 删除指定的签名密钥,删除签名密钥时,其配置的绑定关系会一并删除,相应的签名密钥会失效。 调用方法 请参见如何调用API。 URI DELETE /v2/{project_id}/apigw/instances/{instance_id}/signs/{sign_id}
检查是否创建OPTIONS方式的API,每个分组只需创建一个OPTIONS方式的API。 参数配置如下: 所属分组:选择已开启CORS的API所在分组。 请求方法:选择OPTIONS。 请求协议:选择与已开启CORS的API相同的请求协议。 请求路径:选择与已开启CORS的API相同的请求路径或者
服务标识名 此处选择已创建的工作负载中的Pod标签“app”和“deployment-demo”,指定工作负载。 服务标识值 标签 自动选择工作负载的另外一个Pod标签“version=v1”。 配置生成的API信息。 表8 配置生成的API信息 参数 配置说明 请求协议 API请求协议,默认选择“HTTPS”协议。
DeleteGatewayResponse 修改分组下指定错误类型的自定义响应 ApiGroup UpdateGatewayResponseType 删除分组指定错误类型的自定义响应配置 ApiGroup DeleteGatewayResponseType 实例配置特性 Feature CreateFeatureV2
certificate_id 是 String 证书的编号 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 表3 请求Body参数
所属实例ID,当type=instance时必填 trusted_root_ca 否 String 信任的根证书CA algorithm_type 否 String 证书算法类型: RSA ECC SM2 cert_content_sign 否 String 签名类型证书内容,仅
有没有API导入示例? API的后端地址是否可以绑定为ELB地址? 如何创建API? 更多 API创建 如何创建一个API? 是否支持多后端节点? 部署在华为云上的服务如何开放? 使用VPC通道有哪些注意事项? 更多 API认证鉴权 安全认证签名的内容是否包括Body体? 是否支持HTTPS双向认证?
String API的编号 api_name String API的名称 group_name String API绑定的分组名称 api_type Integer API类型 api_remark String API的描述信息 env_id String api授权绑定的环境ID auth_role
certificate/{id} URI中的参数说明如下表所示。 表2 参数说明 名称 是否必选 类型 说明 group_id 是 String 分组的编号 domain_id 是 String 域名的编号 id 是 String 证书的编号 请求消息 无 响应消息 表3 参数说明
sdk-request:签名算法的调用示例。 校验后端签名示例 示例演示如何编写一个基于ASP.Net Core的服务器,作为API的后端,并且实现一个IAuthorizationFilter,对API网关(即API管理)的请求做签名校验。 API绑定签名密钥后,发给后端的请求中才会添加签名信息。
String API的编号 api_name String API的名称 group_name String API绑定的分组名称 api_type Integer API类型 api_remark String API的描述信息 env_id String api授权绑定的环境ID auth_role