检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
API服务管理 创建API服务 导出API服务 生成产品 绑定域名 配置环境和环境变量 配置网关响应 父主题: API管理
下载JavaScript SDK生成curl命令,然后将curl命令复制到命令行调用API。 前提条件 已获取API的域名、请求url、请求方法、AppKey和AppSecret等信息,具体参见认证前准备。 调用API示例 使用JavaScript SDK生成curl命令。 下载JavaScript
将鼠标移至测试步骤区域,单击展开。 编辑测试步骤,填写请求信息、请求头和请求体。 如果URL中存在调试域名(创建API服务时,自动生成),请将调试域名更改为实例的弹性IP地址,并且header中需添加参数host,值为调试域名。 单击执行测试。 若执行失败,可单击“查看结果”,查看日志定位原因。
准备待用的签名密钥的Key和Secret。 已在控制台创建签名密钥,并绑定API,具体请参见创建并使用签名密钥。 下载SDK的最新版本。 已获取apigateway-backend-signature-demo。 获取并安装IntelliJ IDEA,如果未安装,请至IntelliJ
“Explorer”功能支持可视化调试和查看API文档。API产品上架到API目录后,消费者可通过“Explorer”功能在线调试API。如果通过APP认证来调用API,那么产品需要先订阅才能选择凭证调用API。 前提条件 应用关联的实例已开启公网访问并配置弹性IP,可参考实例配置参数。 操作步骤。
即多个区域下,多个实例和多个项目等资源的集合。 API设计 API设计提供API文档的标准化设计和变更管控。 API实现 API实现是API开发者在后端开发、部署和业务编排的能力。 API管理 API管理提供了API服务开放、配置运行策略、API安全配置等能力。 API消费 A
签名密钥 签名密钥用于后端服务验证API的身份,在API请求后端服务时,保障后端服务的安全。 签名密钥是由一对Key和Secret组成,当签名密钥创建后,ROMA API向后端服务发送此API的请求时,会增加相应的签名信息,此时需要后端服务依照同样方式进行签名,通过比对签名结果与
准备待用的签名密钥的Key和Secret。 已在控制台创建签名密钥,并绑定API,具体请参见创建并使用签名密钥。 下载SDK的最新版本。 获取并安装Python安装包(可使用2.7或3.X),如果未安装,请至Python官方下载页面下载。 获取并安装IntelliJ IDEA,如果未安装,请至IntelliJ
示例校验签名是否一致。 准备环境 准备待用的签名密钥的Key和Secret。 已在控制台创建签名密钥,并绑定API,具体请参见创建并使用签名密钥。 下载SDK的最新版本。 获取并安装Visual Studio,如果未安装,请至Visual Studio官方网站下载。 打开工程 双击SDK包中的“csharp
xxxxx38CAQExDTALBglghkgBZQMEAgEwg 调用API,请参考认证前准备获取域名、请求方法和URL。参数请根据实际情况填写。 curl -X 请求方法 域名+URL -H "x-auth-token: $Token" -vk 父主题: 使用IAM认证调用API
选择已有策略:单击“选择已有策略”后,选择策略。 创建新策略:请参考表2所示配置策略。 表2 配置凭据配额策略 参数 配置说明 策略名称 填写客户端配额策略的名称,根据规划自定义。建议您按照一定的命名规则填写配额策略名称,方便您快速识别和查找。 首次生效时间点 设置配额策略的生效起始时间点。例如,
填写服务名称,或默认系统自动生成的名称。 在“API接口”列表中勾选要开放的API,单击“立即导入”。 (可选)单击“全局配置(可选)”。 安全配置。 表1 安全配置参数说明 参数 参数说明 安全认证 API使用的认证方式,推荐使用APP认证。 APP认证:表示由ROMA API进行API请求的安全认证。
在左侧导航栏选择“管理中心 > 实例管理”。 单击实例名称或实例卡片右上角的“查看控制台”。 单击“日志分析”。 单击“配置访问日志”。 在弹窗中将“启动日志记录”修改为即启用日志记录能力。 “日志组”和“日志流”设置完成后,单击“确定”。 查看日志分析可单击“日志字段说明”,根据日志字段说明分析日志。
应头,在返回的API响应中指定您配置的响应头。 使用限制 无法修改ROMA API增加的系统响应头(x-apig-*,x-request-id等),包括ROMA API提供的CORS功能增加的响应头。 配置参数说明 表1 配置参数说明 参数 配置说明 Name 响应头名称。每个策
健康检查配置 协议 选择健康检查所使用的协议,可选择“TCP”、“HTTP”和“HTTPS”。 双向认证 仅当“协议”选择“HTTPS”时需要配置。 是否选择“使用backend_client_certificate配置的证书做客户端认证”,若选择,您需在实例详情的“配置参数”页
操作步骤 查看实例 查看实例详情,包括实例的基本信息、配置参数、负载通道和环境管理。 找到需要查看的实例,单击实例名称或实例卡片右上角的“查看控制台”。 单击“实例信息”页签,查看实例基础信息、计费信息和管理信息等。 单击“配置参数”页签,查看参数信息。 单击“负载通道”页签,查看通道信息。
在“SSL证书管理”页面,可执行下表操作。 表1 管理证书 相关任务 使用场景 操作步骤 查看证书 查看证书详情。 单击证书名称,查看证书详情。包括序列号、有效期、签名算法、域名等信息。 编辑证书 修改证书信息。 找到需要编辑的证书,单击所在行的“编辑”,即可修改证书信息。 删除证书 删除不需要的证书。 找到需要删
填写产品基本信息。 在“添加版本和API”区域,选择是否创建产品版本,版本号、实例和API服务,勾选API。 只有已部署到RELEASE环境中的API,才能被添加到API产品中。 每个API仅能被添加到一个API产品,无法同时添加到多个产品中。 完成产品的配置后,单击“立即创建”,创建API产品。
创建环境 创建环境后,在创建API服务或发布API时,可以直接将API部署到环境上。 前提条件 已创建ROMA Connect实例。 操作步骤 登录ROMA API控制台。 在控制台单击,选择区域,在“ROMA API”下选择待操作的应用。 在左侧导航栏选择“管理中心 > 实例管理”。
域资源共享和HTTP响应头管理。 传统策略:流量控制、访问控制和签名密钥。 单击“创建策略”,配置策略信息。 插件策略请参考下表配置: 表1 插件策略配置 参数 配置说明 策略名称 填写策略的名称,根据规划自定义。建议您按照一定的命名规则填写策略名称,方便您快速识别和查找。 策略类型