检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
查看应用绑定的API详情 操作场景 在应用绑定API后,查看应用绑定的API详情。 前提条件 已创建应用。 应用已绑定API。 操作步骤 进入共享版控制台。 选择“调用API > 应用管理”,进入到应用管理信息页面。 单击待查看的应用名称,进入应用详情页面。 单击待查看的API名称,进入API详情页面,查看API详情。
单击“Invoke”发送请求。 在“Response”区域中返回API的Response,且状态码显示“0 OK”,表示调用成功。 父主题: 基于API网关专享版实现gRPC服务的路由转发
批量导出API 功能介绍 按API ID列表批量导出指定分组、指定环境中发布的API的基础/全量/扩展Swagger定义。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 请求方法 URI POST /v1.0/apigw/openapi/apis?env_id
自动生成App Code 功能介绍 创建App Code时,可以不指定具体值,由后台自动生成随机字符串填充。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI PUT /v1.0/apigw/apps/{app_id}/app-codes
API分组管理(待下线) 对象模型 创建API分组 修改API分组 删除API分组 查看分组详情 查询分组列表 父主题: 专享版API(V1)(待下线)
设置特殊流控(待下线) 对象模型 创建特殊设置 修改特殊设置 删除特殊设置 查看特殊设置列表 父主题: 专享版API(V1)(待下线)
查看ACL策略绑定的API列表 查看ACL策略未绑定的API列表 解除API与ACL策略的绑定 批量解除API与ACL策略的绑定 父主题: 专享版API(V1)(待下线)
查询API列表 功能介绍 查看API列表,返回API详细信息、发布信息等,但不能查看到后端服务信息。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI GET /v1.0/apigw/apis[?page_size
查看变量详情 功能介绍 查看指定的环境变量的详情。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI GET /v1.0/apigw/env-variables/{id} URI中的参数说明如下表所示。 表2
解除绑定 功能介绍 解除API与流控策略的绑定关系。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI DELETE /v1.0/apigw/throttle-bindings/{id} URI中的参数说明如下表所示。
查看ACL策略详情 功能介绍 查询指定ACL策略的详情。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI GET /v1.0/apigw/acls/{id} URI中的参数说明如下表所示。 表2 参数说明
前提条件 已在函数工作流服务中完成函数创建。 用户还需具备FunctionGraph Administrator角色权限。 操作步骤 进入共享版控制台。 在“开放API > 自定义认证”页签,单击“创建自定义认证”,弹出“创建自定义认证”对话框。 填写如表1所示信息。 表1 自定义认证参数
有上线函数工作流服务,则不支持使用自定义认证。 已在API中使用的自定义认证无法被删除。 前提条件 已创建自定义认证。 操作步骤 进入共享版控制台。 在“开放API > 自定义认证”页签,在待删除的自定义认证所在行,单击“删除”,弹出对话框。 单击“确定”。 父主题: 自定义认证
在特殊应用/租户没有作用之后,删除为流控策略添加的特殊应用/租户。本节以删除特殊应用为例。 前提条件 已创建流控策略。 已添加特殊应用/租户。 删除特殊应用 进入共享版控制台。 选择“开放API > 流量控制”,进入到流量控制信息页面。 单击待删除特殊应用的流量控制策略的名称,进入流量控制详情页面。 单击“特殊应用”,进入“特殊应用”页面。
开启重定向功能的API的前端请求协议必须为“HTTPS”或“HTTP&HTTPS”。 验证重定向 验证重定向功能是否生效。 父主题: API网关专享版支持http到https自动重定向
创建API分组 功能介绍 API分组是API的管理单元,一个API分组等同于一个服务入口,创建API分组时,返回一个子域名作为访问入口。建议一个API分组下的API具有一定的相关性。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI
创建流控策略 功能介绍 当API上线后,系统会默认给每个API提供一个流控策略,API提供者可以根据自身API的服务能力及负载情况变更这个流控策略。 流控策略即限制API在一定长度的时间内,能够允许被访问的最大次数。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1
删除流控策略 功能介绍 删除指定的流控策略,以及该流控策略与API的所有绑定关系。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI DELETE /v1.0/apigw/throttles/{id} URI中的参数说明如下表所示。
对象模型 本节介绍签名密钥与API的绑定关系的对象模型,如下表所示。 “操作类型”用于描述字段的属性,表示对应字段的值可进行的操作: C:创建;U:更新;R:读取。 “是否必选”列表示对于“操作类型”为“C”的创建操作,对应字段是否为必选字段。 表1 签名密钥与API绑定关系对象模型
导入API到已有分组 功能介绍 导入swagger格式的文件, 在已有分组中创建或更新API。swagger文件支持json以及yaml格式。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 请求方法 URI PUT /v1.0/apigw/openapi?group_id={0}&mode={1}