检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
校验APP 功能介绍 校验APP是否存在,非APP所有者可以调用该接口校验APP是否真实存在。这个接口只展示app的基本信息id 、name、 remark,其他信息不显示。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法
查看分组详情 功能介绍 查询指定分组的详细信息。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI GET /v1/{project_id}/apigw/instances/{instance_id}/api-groups/{id}
签名密钥流程 创建签名密钥 进入共享版控制台。 单击“开放API > 签名密钥”,进入签名密钥管理信息页面。 单击“创建密钥”,弹出“创建密钥”对话框。 填写如表1所示信息。 表1 密钥信息 信息项 描述 密钥名称 自定义名称,用于识别不同的密钥。 类型 专享版支持选择签名密钥的认证类型,可选择“HMAC”和“Basic”。
签名密钥由一对Key和Secret组成,签名密钥需要绑定到API才能生效。当签名密钥绑定API后,API网关向后端服务发送此API的请求时,会增加相应的签名信息,此时需要后端服务依照同样方式进行签名,通过比对签名结果和API网关传过来的Authorization头中签名是否一致来校验API的合法性。
Not Implemented 请求未完成。服务器不支持所请求的功能。 502 Bad Gateway 请求未完成。服务器从上游服务器收到一个无效的响应。 503 Service Unavailable 由于服务器临时维护或者过载,服务器当前无法处理请求。 504 Gateway Timeout
查看分组详情 功能介绍 查询指定分组的详细信息。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI GET /v1.0/apigw/api-groups/{id} URI中的参数说明如下表所示。 表2 参数说明
您也可以在控制台上API分组详情的“分组信息”页面关闭“调试域名开关”来关闭调试域名,关闭后将隐藏调试域名,且不能通过调试域名调用API。 调试域名不能用于生产业务,且仅限应用程序调试使用。 调试域名默认只能在与实例相同VPC内的服务器上解析和访问,如果调试域名要支持公网解析与访问,请在实例上绑定公网入口弹性IP。
Interface,应用程序编程接口)是一些预先定义的函数,应用将自身的服务能力封装成API,并通过API网关开放给用户调用。 API包括基本信息、前后端的请求路径和参数以及请求相关协议。 API分组 API分组是同一种业务API的集合,API开发者以API分组为单位,管理分组内的所有API。
查询可绑定当前API的插件 功能介绍 查询可绑定当前API的插件信息。 支持分页返回 支持插件名称模糊查询 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/apigw/instances/{instance_id}/apis/{api_id}/attachable-plugins
可以访问调试域名1000次。系统自动分配的域名不能用于生产业务,且仅限应用程序调试使用。 创建API的负载通道(可选) 如果需要访问指定服务器中已部署的后端服务,可通过创建负载通道来实现。反之,跳过此步骤。 创建API 把已有后端服务封装为标准RESTFul API或GRPC API,并对外开放。
Request URI too large” 可能原因:URL(包括请求参数)太长,建议将请求参数放在body体中传递。 有关API调用的报错信息,请参考错误码。 父主题: 调用API
管理)后台约定的规则组装,确保客户端签名、API网关后台认证时使用的请求内容一致。 使用规范请求和其他信息创建待签字符串。 使用AK/SK和待签字符串计算签名。 将生成的签名信息作为请求消息头添加到HTTP请求中,或者作为查询字符串参数添加到HTTP请求中。 API网关收到请求后,执行1~3,计算签名。
在左侧导航栏中选择“API管理 > API策略”,单击“创建策略”,在弹窗中选择“流量控制2.0”。 根据流控诉求,配置策略基本信息。 表1 策略基本信息 参数 配置说明 策略名称 根据规划自定义名称。 流控类型 此处选择“高性能流控”模式。 策略生效范围 此处选择“单个API生效”,对单个API进行流量统计和控制。
单击“环境管理”页签。 单击“创建环境”,根据下表参数说明,填写环境信息。 表1 环境信息 参数 说明 环境名称 API环境名称。支持英文,数字,下划线,且只能以英文开头,长度为3-64个字符。 描述 环境描述信息。长度为1-255个字符。 单击“确定”,创建环境。 创建环境成功后
计费项 计费说明 API网关提供包年/包月模式和按需模式,包年/包月模式计费项信息请参考表1,按需模式计费项信息请参考表2 表1 包年/包月模式计费项信息 计费项目 计费项说明 适用的计费模式 计费公式 版本 API网关提供的实例版本有:基础版、专业版、企业版、铂金版等,您可以根
根据实际业务在左侧导航栏上方选择实例。 在左侧导航栏选择“API管理 > API分组”。 单击“创建API分组 > 导入CCE工作负载”。根据下表参数说明,配置信息。 表1 配置信息 参数 说明 所属分组 CCE工作负载所属分组。支持同步创建新的分组或选择已有分组。 集群 选择集群,可单击“查看云容器引擎CCE”查看。
查看APP详情 功能介绍 查看指定APP的详细信息。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI GET /v1.0/apigw/apps/{id} URI中的参数说明如下表所示。 表2 参数说明 名称
在“自定义入方向端口”页签中,单击“新增入方向端口”。 根据实际业务,选择请求协议,并填写入方向端口。 单击“确定”。 后续操作 在“分组信息”页面的“域名管理”区域,将已绑定独立域名的端口修改为新增的入端口或在绑定独立域名时选择新增的入端口,用户才可以通过不同的端口访问不同的后端服务。
req_param_location String 关联的请求参数对象位置 表29 VpcInfo 参数 参数类型 描述 ecs_id String 云服务器ID ecs_name String 云服务器名称 cascade_flag Boolean 是否使用级联方式 暂不支持 vpc_channel_proxy_host
查看App Code详情 功能介绍 查看App Code详细信息。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI GET /v1.0/apigw/apps/{app_id}/app-codes/{id}