检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
对API的修改是否需要重新发布? 需要。 API发布后,如果再次编辑API参数,需要重新发布才能将修改后的信息同步到环境中。 关于API重新发布的详细指导,请参考发布API。 父主题: API发布
签名前准备 获取签名密钥信息: 在APIG实例控制台选择“API管理 > API策略 > 策略管理”,单击签名密钥名称进入详情页面,在“策略内容”区域查看Key和Secret。 父主题: 对后端服务进行签名
API管理”,进入到API管理信息页面。 单击待查看发布历史的API名称,进入API详情页面。 单击“发布历史”,进入“发布历史”页签。 查看API的发布历史信息。 图2 发布历史 在版本所在行,单击“查看版本”,弹出此版本详细信息对话框。 查看API基本信息、API请求、后端请求、入参定义、参数映射、常量参数和返回结果。
API请求体描述,可以是请求体示例、媒体类型、参数等信息。字符长度不超过20480 说明: 中文字符必须为UTF-8或者unicode编码。 result_normal_sample String 正常响应示例,描述API的正常返回信息。字符长度不超过20480 说明: 中文字符必须为UTF-8或者unicode编码。
修改签名密钥 功能介绍 修改指定签名密钥的详细信息。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI PUT /v1.0/apigw/signs/{id} URI中的参数说明如下表所示。 表2 参数说明 名称
修改流控策略 功能介绍 修改指定流控策略的详细信息。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI PUT /v1/{project_id}/apigw/instances/{instance_id}/throttles/{id}
修改签名密钥 功能介绍 修改指定签名密钥的详细信息。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI PUT /v1/{project_id}/apigw/instances/{instance_id}/signs/{id}
管理员权限可查询。 instance_id 是 String 实例ID,可从API网关控制台的专享版实例信息中获取。 id 是 String 环境的ID,可通过查询环境信息获取该ID 请求消息 表3 参数说明 参数 是否必选 类型 说明 name 是 String 环境的名称
String 环境的ID,可通过查询环境信息获取该ID 请求消息 表3 参数说明 参数 是否必选 类型 说明 name 是 String 环境的名称 支持英文,数字,下划线,且只能以英文字母开头,3 ~ 64字符。 remark 否 String 描述信息 字符长度不能大于255。 说明:
应。默认网关响应为“default”。 匹配模式 此处选择“前缀匹配”。 安全认证 选择API认证方式,此处选择“无认证”。(无认证模式,安全级别低,所有用户均可访问,不推荐在实际业务中使用) 配置后端信息后,单击“下一步”。 表6 HTTP/HTTPS类型定义后端服务 参数 配置说明
请求路径:选择与已开启CORS的API相同的请求路径或者与已开启CORS的API匹配的请求路径。 匹配模式:选择前缀匹配。 安全认证:“无认证”模式安全级别低,所有用户均可访问,不推荐使用。 支持跨域CORS:勾选。 父主题: API创建
当使用APP认证,且开启了简易认证模式,API请求既可以选择使用Key和Secret做签名和校验,也可以选择使用AppCode进行简易认证。 为了确保安全,简易认证仅支持HTTPS或GRPCS方式调用API,不支持HTTP。 每个凭据最多可创建5个AppCode。 生成APPCode 进入API网关控制台页面。
查询签名密钥列表 功能介绍 查询所有签名密钥的信息。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI GET /v1/{project_id}/apigw/instances/{instance_id}/signs[
使用APIG专享版实现http到https自动重定向 当用户的API采用http协议访问时,由于http没有传输安全与认证安全保障,可以使用API网关的重定向功能将API升级为安全的https协议访问,同时兼容已有的http协议。 使用APIG专享版实现gRPC服务的路由转发 当用户使
在编辑API中增加后端超时时间。 如果“后端服务地址”在ECS(Elastic Cloud Server),ECS的安全组的出/入方向规则可能拦截了请求。 检查后端服务所在ECS的安全组,确保出/入方向端口规则和协议都设置正确。 请求协议配置错误,如后端服务为HTTP,在API网关配置为HTTPS。
查询签名密钥列表 功能介绍 查询所有签名密钥的信息。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI GET /v1.0/apigw/signs[?page_size, page_no, id, name]
单个用户调用API次数上限,仅在API的安全认证方式为APP认证或IAM认证时适用。 不超过“API流量限制”。 与“时长”配合使用,表示单位时间内的单个用户请求次数上限。 如果主账号下有多个子用户访问API,按主账号累计的调用次数进行限制。 凭据流量限制 单个凭据调用API次数上限,仅在API的安全认证方式为APP认证时适用。
删除APP的访问控制 功能介绍 删除凭据的访问控制信息。 调用方法 请参见如何调用API。 URI DELETE /v2/{project_id}/apigw/instances/{instance_id}/apps/{app_id}/app-acl 表1 路径参数 参数 是否必选
查询签名密钥列表 功能介绍 查询所有签名密钥的信息。 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/apigw/instances/{instance_id}/signs 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是
查询流控策略列表 功能介绍 查询所有流控策略的信息。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI GET /v1/{project_id}/apigw/instances/{instance_id}/throttles[