检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
Android 操作场景 使用Android语言调用APP认证的API时,您需要先获取SDK,然后新建工程,最后参考API调用示例调用API。 准备环境 已获取API的域名、请求url、请求方法、AppKey和AppSecret等信息,具体参见认证前准备。 获取并安装Android
找到需要编辑的自定义认证,单击所在行的“编辑”,即可修改自定义认证信息。 删除自定义认证 删除不需要的自定义认证。 找到需要删除的自定义认证,单击所在行的“删除”,即可删除自定义认证。 更新自定义认证 刷新自定义认证信息。 在“自定义认证”页面,单击刷新自定义认证信息。 父主题: 自定义认证
创建自定义认证 自定义认证包含两种认证:前端自定义认证和后端自定义认证。 前端自定义认证:如果您希望使用自己的认证系统,而不是APP认证/华为IAM认证对API的访问进行认证鉴权时,您可以使用自定义认证,通过您自定义的函数进行认证鉴权。 后端自定义认证:当不同的后端服务使用不同的
自定义认证 创建自定义认证 管理自定义认证 父主题: API管理
证中的AppSecret,即可完成签名和请求。您可使用Java、Go、Python、C#、JavaScript、PHP、C++、C、Android进行签名和访问。 客户端须注意本地时间与时钟服务器的同步,避免请求消息头X-Sdk-Date的值出现较大误差。 API网关(即API管
500 自定义认证配置错误 自定义认证方异常,通信失败、返回异常响应等错误 AUTHORIZER_FAILURE 500 自定义认证失败 自定义认证方返回认证失败 AUTHORIZER_IDENTITIES_FAILURE 401 自定义认证身份来源错误 前端自定义认证的身份来源信息缺失或不合法错误
HTTP响应头管理策略 API响应是指ROMA API返回客户端的响应,HTTP响应头是API响应中的一部分。您可以自定义HTTP响应头,在返回的API响应中指定您配置的响应头。 使用限制 无法修改ROMA API增加的系统响应头(x-apig-*,x-request-id等),包括ROMA
配置环境和环境变量 环境是指API的受限使用范围,API只有在发布到环境后,才能被调用。API可以被发布到不同的自定义环境中,如开发环境、测试环境等。RELEASE是系统默认的发布环境,也是正式发布环境。 环境变量是指在环境上创建可管理的一种变量,该变量固定在环境上。通过创建环境
API的同时,也可额外自定义扩展字段。 您可以进行以下操作: 规则集管理 启用规则集 根据业务需求选择适用于API设计文件规范性检查的规则集。 创建规则集 根据业务需求创建规则集。 设置无需检查的接口 设置无需规范性检查的接口。 配置扩展字段 支持统一自定义扩展字段,指定显示区域,字段名必须以“x-”开头。
单击“创建负载通道”。 根据下表参数说明,配置通道信息。 表1 负载通道参数说明 参数类型 参数项 说明 基本信息 通道名称 填写负载通道的名称,根据规划自定义。建议您按照一定的命名规则填写负载通道名称,方便您快速识别和查找。 端口 填写负载通道的服务器访问端口号。 分发算法 选择后端服务请求的分
导入Swagger文件:从用户本地导入API,生成测试用例。选择API文件,单击“打开”。 配置用例参数。 表1 用例参数 参数 配置说明 用例名称 用例的名称,根据规划自定义。 生成用例 生成用例方式分两种: 所有接口生成一个用例:将选择的API接口生成一个用例。 一个接口生成一个用例:将选择的每个API接口分
custom_data_log1 用户自定义日志字段值1。 39 custom_data_log2 用户自定义日志字段值2。 40 custom_data_log3 用户自定义日志字段值3。 41 custom_data_log4 用户自定义日志字段值4。 42 custom_data_log5
择启用,则在使用APP认证或IAM认证对API请求进行安全认证时,同时使用自定义的函数API对API请求进行安全认证。 自定义认证 仅当“后端认证”选择“自定义认证”时可配置。 需要先创建自定义认证,自定义认证通过函数服务实现,在函数服务中编写一个函数,实现您的认证鉴权流程,或者使用函数调用您的统一鉴权服务。
是否对API的调用进行双重安全认证。若选择启用,则在使用APP认证或IAM认证对API请求进行安全认证时,同时使用自定义的函数API对API请求进行安全认证。 自定义认证 自定义认证需要提前创建,单击“新建自定义认证”,请参考创建自定义认证。 支持跨域CORS CORS允许浏览器向跨域服务器,发出XMLHttpRe
选择待导出API所在的API服务。 运行环境 选择待导出API所在的部署环境。 API 默认导出API服务在所选择环境下的所有API。如果只需要导出个别API,可单击“自定义导出API”,勾选需要导出的API。 API定义范围 选择导出的API服务文件中,API定义字段的类型范围。 基础定义:包括API前端请求
oken或者AK/SK)进行认证。如果使用AK/SK进行认证,还需要向API管理者获取用于调用API的SDK。 自定义认证:向API管理者获取请求参数中要携带的自定义认证信息。 无认证:无需认证信息。 调用API 配置请求地址相关参数。 API调用场景 API请求参数配置 使用域名调用API
I支持展示自定义填写。 说明: 如果API已定义formData类型参数,将不展示Body参数,且暂不支持调试。 IAM认证 支持Token认证或AK/SK认证。Explorer自动获取或临时生成Token或AK/SK。 无认证 填写API的Headers参数。 自定义认证 单击“调试结果”页签,查看调试结果。
API管理 API服务管理 APIs管理 API列表 策略管理 自定义认证 SSL证书管理 API测试 凭据管理
填写策略的名称,根据规划自定义。建议您按照一定的命名规则填写策略名称,方便您快速识别和查找。 策略类型 选择策略的类型,不同类型的策略提供不同扩展能力。 跨域资源共享:为API的跨域访问提供指定预检请求头和响应头、自动创建跨域预检请求API的能力。 HTTP响应头管理策略:可以自定义HTTP响
使用APP认证方式的API,支持通过AppCode进行API调用的简易安全认证。 绑定凭据配额策略 凭据配额用于限制凭据在某个时间周期内的API调用次数,支持自定义重置时间。 绑定访问控制策略 客户端访问控制可控制访问API的客户端IP地址,保护后端服务。您可以为客户端设置访问控制策略,允许/禁止某个IP地址的客户端访问API。