检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
plugin_id 否 String 插件编码 plugin_name 否 String 插件名称,支持模糊查询 precise_search 否 String 指定需要精确匹配查找的参数名称,目前支持插件名称 请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token
实例配置特性 功能介绍 为实例配置需要的特性。 支持配置的特性列表及特性配置示例请参考本手册中的“附录 > 实例支持的APIG特性”章节。 调用方法 请参见如何调用API。 URI POST /v2/{project_id}/apigw/instances/{instance_id}/features
VPC通道 创建VPC通道 删除VPC通道 编辑健康检查配置 在VPC通道中编辑云服务器配置 父主题: 共享版操作指导(仅存量用户使用)
在API的前端设置页面选择安全认证方式为“自定义认证”或使用双重认证(APP认证或IAM认证),并选择指定的自定义认证对象,如果没有,则需要创建自定义认证。 配置API后端 在API的后端设置页面添加策略后端,策略条件的条件来源选择“系统参数-前端认证参数”,并完善参数名称、条件类
参数编排规则编排后生成的参数名称,当condition_origin为orchestration的时候必填,并且生成的参数名称必须在api绑定的编排规则中存在 mapped_param_location 否 String 参数编排规则编排后生成的参数所在的位置,当conditio
id} URI中的参数说明如下表所示。 表2 参数说明 名称 是否必选 类型 说明 group_id 是 String 分组的编号 domain_id 是 String 域名的编号 id 是 String 证书的编号 请求消息 无 响应消息 表3 参数说明 名称 类型 说明 common_name
API被某些特性的IP地址访问到,也可以将这些IP地址加入白名单。这样可以提高API的访问安全性,保护API免受攻击。本节介绍API的黑白名单(ACL策略)管理的对象模型,如表1 ACL策略对象模型所示。 “操作类型”用于描述字段的属性,表示对应字段的值可进行的操作: C:创建;U:更新;R:读取
可以在URI后面用‘?’和‘&’添加不同的查询条件组合。 查询条件可为以下字段以及对应的值:acl_id、env_id、api_id、group_id、api_name、page_size、page_no。 URI中的参数说明如下表所示。 表2 参数说明 名称 是否必选 类型 说明
String 发布的环境编号 publish_id String 发布记录的编号 throttle_apply_id String 与流控策略的绑定关系编号 throttle_name String 绑定的流控策略名称 apply_time Timestamp 已绑定的流控策略的绑定时间 auth_type
API创建成功后,您可根据业务需求配置API策略,管理API等。 调试APIG创建的API 验证API服务的功能是否正常可用。 配置API的发布环境和环境变量(可选) API可以同时提供给不同的环境调用,如生产、测试或开发。 发布APIG创建的API 把API发布到环境中,API只有在发布到环境后,才支持被调用。
x-apigateway-access-controls.policy 指定名称的访问控制策略。 要使用该策略,将x-apigateway-access-control属性值引用为该策略名称。 父主题: APIG的API设计文件扩展定义
查询凭据配额可绑定的凭据列表 功能介绍 查询凭据配额可绑定的凭据列表。支持按凭据名称模糊搜索 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/apigw/instances/{instance_id}/app-quotas/{app_quota_id}/bindable-apps
查询凭据配额已绑定的凭据列表 功能介绍 查询凭据配额已绑定的凭据列表。支持按凭据名称模糊匹配 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/apigw/instances/{instance_id}/app-quotas/{app_quota_id}/bound-apps
字典数据类型 本次查询返回的API列表 表4 apis参数说明 参数 类型 说明 id String API的ID。 name String API名称 group_id String API所属分组的编号 group_name String API所属分组的名称。 type Integer
API不存在或未发布到环境 检查调用API所使用的域名、请求方法、路径和创建的API是否一致;检查API是否发布,如果发布到非生产环境,检查请求X-Stage头是否为发布的环境名;检查调用API使用的域名是否已经绑定到API所在的分组 APIG.0101 The API does
中X-Subject-Token的值)。 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 app_quota_id String 凭据配额编号 name String 配额名称。支持汉字,英文,数字,下划线,且只能以英文和汉字开头,3-255字符 call_limits
a" } 可能原因 appkey配置错误。 解决方法 在API网关控制台页面的左侧导航栏中选择“API管理 > 凭据管理”。 单击对应的凭据名称,进入凭据详情。 查看“Key”值,并重新配置appkey。 Incorrect app authentication information:
String 发布的环境编号 publish_id String 发布记录的编号 throttle_apply_id String 与流控策略的绑定关系编号 throttle_name String 绑定的流控策略名称 apply_time Timestamp 与已绑定的流控策略的绑定时间
String API的认证方式 run_env_name String 发布的环境名 group_name String API所属分组的名称 publish_id String 发布记录的编号 group_id String API所属分组的编号 name String API名称 remark
String API名称 group_id 否 String API分组编号 响应消息 表3 参数说明 名称 类型 说明 total Integer 满足查询条件的API的总个数 size Integer 本次查询返回的API列表长度 apis 字典数据类型 本次查询返回的API列表 表4