检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
安全认证签名的内容是否包括Body体 包括。除了几个必选的请求头部参数,Body体也是签名要素之一。例如有一个使用POST方法上传文件的API,那么在签名过程中,会取这个文件的hash值,参与生成签名信息。 关于签名的详细指导,可参考:签名认证算法详解。 父主题: API认证鉴权
后端服务地址:填写后端服务地址及端口。 路径:后端服务的路径。此处填写“/”。 单击“完成”。 在“API运行”页面中,API的URL不显示调用方法以及协议,仅显示域名跟路径部分。当发送gRPC请求时,填入域名部分即可。 发布API 在“API运行”页面,选择已创建的API,单击“发布最新版本”。 选择API的发布环境,并填写发布说明。
管理终端节点 终端节点用于在VPC和终端节点服务之间建立便捷、安全、私密的连接通道。 在同一区域中,可实现云内跨VPC访问/开放API。 目前除墨西哥城一、北京一区域外,其他区域都支持终端节点管理功能。 图1 同一区域跨VPC访问 操作步骤 进入API网关控制台页面。 在左侧导航栏选择“实例管理”。
调试API 功能介绍 调试一个API在指定运行环境下的定义,接口调用者需要具有操作该API的权限。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI POST /v1.0/apigw/apis/debug/{api_id}
添加或更新VPC通道后端服务器组 功能介绍 在APIG中创建VPC通道后端服务器组,VPC通道后端实例可以选择是否关联后端实例服务器组,以便管理后端服务器节点。 如果指定名称的后端服务器组已存在,则更新对应后端服务器组信息。如果请求体中包含多个重复名称的后端服务器定义,则使用第一个定义。
单击“添加云服务器”。 在弹窗中,选择子网并勾选要添加的云服务器,单击“确定”。 配置完成后,进行健康检查配置。 指定服务器地址。 单击“创建服务器分组”。 在弹窗中填写服务器分组信息,单击“确定”。配置参数请参考表2。 单击“添加后端服务器地址”,在列表中填写后端服务器地址。 表3
system:系统参数。 参数:用于判断与规则中的参数值是否匹配。 定义规则 定义用于规则的判断条件。 单击“添加规则”,编辑规则名称和规则条件。在“条件表达式”弹窗中,选择“定义参数”中的参数名和判断条件,以及输入参数值。 说明: 建议不要设置敏感信息,以防泄露。 =为等于 !=为不等于
以生成应用ID和密钥对(AppKey、AppSecret)。将创建的应用绑定API后,才可以使用APP认证调用API。在API调用过程中,把密钥对替换SDK中的密钥对,API网关服务根据密钥对进行身份核对,完成鉴权。关于使用APP认证的方法,具体请参考《API网关开发指南》。
0/apigw/apps/{app_id}/app-codes[?page_size, page_no] 可以在URI后面用‘?’和‘&’添加不同的查询条件组合。 查询条件可为以下字段以及对应的值:page_size、page_no。 URI中的参数说明如下表所示。 表2 参数说明 名称 是否必选 类型 说明 app_id
统会默认生成全局标识,可在凭据详情中查看。 单击“确定”,创建凭据。 创建凭据成功后,在凭据管理页面显示新建凭据和凭据ID。 单击凭据名称,进入详情页面,查看key和Secret。 绑定API 在“凭据管理”页面,单击凭据名称,进入详情页面。 在“关联API”区域,单击“绑定API”。
删除环境 功能介绍 删除指定的环境。 该操作将导致此API在指定的环境无法被访问,可能会影响相当一部分应用和用户。请确保已经告知用户,或者确认需要强制下线。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI
page_size, page_no, id, name, type] 可以在URI后面用‘?’和‘&’添加不同的查询条件组合。 查询条件可为以下字段以及对应的值:id、name、type、page_size、page_no URI中的参数说明如下表所示。 表2 参数说明 名称 是否必选 类型 说明
tances/{instance_id}/envs/{id} URI中的参数说明如下表所示。 表2 参数说明 名称 是否必选 类型 说明 project_id 是 String 项目ID。可从控制台“我的凭证”中获取region下项目ID,管理员权限可查询。 instance_id
单击“分组名称”,进入分组详细信息页面。单击“域名管理”。 在待绑定域名的分组所在行,单击“更多 > 域名管理”。 单击“绑定独立域名”,设置域名信息。 单击“确定”,将独立域名与API分组绑定。 如果不再需要此域名时,在域名所在行,单击“解除绑定”。 (可选)绑定SSL证书。API分组中的API支持HTTPS请求协议时,需要添加SSL证书。
Override:覆盖 当API响应中存在指定的响应头时,使用当前响应头的值覆盖已有响应头的值。 当API响应中存在多个与指定响应头相同名称的响应头时,该操作只会按当前响应头的值返回一条响应头记录。 当API响应中不存在指定的响应头时,添加当前响应头。 Append:添加 当API响应中存在指定的响应
完成分组信息填写后,单击“确定”,创建API分组。 创建分组成功后,在“API分组”页面的列表中显示新创建的API分组。 API分组创建后,系统为分组自动分配一个内部测试用的子域名,此子域名每天最多可以访问1000次。 共享版中的API,分组子域名可公网访问。 对外开放API时,您需要为API分组绑定您自己的独立域名。
page_size, page_no, id, name, type] 可以在URI后面用‘?’和‘&’添加不同的查询条件组合。 查询条件可为以下字段以及对应的值:id、name、type、page_size、page_no URI中的参数说明如下表所示。 表2 参数说明 名称 是否必选 类型 说明
查询API运行时定义 功能介绍 查看指定的API在指定的环境上的运行时定义,默认查询RELEASE环境上的运行时定义。 API的定义分为临时定义和运行时定义,分别代表如下含义: 临时定义:API在编辑中的定义,表示用户最后一次编辑后的API的状态 运行时定义:API在发布到某个环境时,对发布时的A
查询API运行时定义 功能介绍 查看指定的API在指定的环境上的运行时定义,默认查询RELEASE环境上的运行时定义。 API的定义分为临时定义和运行时定义,分别代表如下含义: 临时定义:API在编辑中的定义,表示用户最后一次编辑后的API的状态 运行时定义:API在发布到某个环境时,对发布时的A
函数代码获取的三种请求参数与API网关自定义认证中的参数关系如下所示: Header中的请求参数:对应自定义认证中参数位置为Header的身份来源,其参数值在您调用使用该前端自定义认证的API时传入 Query中的请求参数:对应自定义认证中参数位置为Query的身份来源,其参数值在您调用使用该前端自定义认证的API时传入