检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
每个用户最多可创建2个访问密钥,不支持增加配额。每个访问密钥权限相同,相互独立,包括一对AK/SK,有效期为永久,每个访问密钥仅能下载一次。为了账号安全性,建议您妥善保管并定期修改访问密钥。修改访问密钥的方法为删除旧访问密钥,然后重新生成。 企业联邦用户不能创建访问密钥,但可以创建临时访问凭证(
调用已发布的API API在发布到环境后,即支持被其他用户调用。根据API所使用的安全认证方式不同,调用API的操作有所差异。 获取API的请求消息 在调用API前,您需要向API管理者获取API的请求信息,包括访问域名、请求协议、请求方法、请求路径以及请求参数。 根据API使用的安
范性检查。 API设计 2 API管理 支持API服务和API策略能力,提供API服务定义和策略管理。 支持API创建、调试和发布功能。 API管理 3 API消费 支持从服务中挑选的部分API组合成API产品,以及上架到API目录,供API消费者订阅后调用。 API消费 4 API分析
管理API API创建完成后,在API列表中显示新建API,同时也支持编辑、授权、下线等操作管理API。 管理API 登录ROMA API控制台。 在控制台单击,选择区域,在“ROMA API”下选择待操作的应用。 在左侧导航栏选择“API管理 > API服务”。 在当前应用关联的实例中,根据实际业务选择实例。
Token认证 操作场景 当您使用Token认证方式调用API时,需要获取用户Token并在调用API时将Token值设置到调用请求的“X-Auth-Token”头域中。 调用接口有如下两种认证方式,您可以选择其中一种进行认证鉴权。 Token认证:通过Token认证调用请求。 AK/SK认证:通过AK(Access
自身的服务能力封装成API,并通过API Connect开放给用户调用。API包括基本信息、前后端的请求路径和参数以及请求相关协议。 API服务 API服务是同一种业务API的集合,API开发者以API服务为单位,管理服务内的所有API。 API产品 API产品是从服务中挑选想要
通过Explorer调试API “Explorer”功能支持可视化调试和查看API文档。API产品上架到API目录后,消费者可通过“Explorer”功能在线调试API。如果通过APP认证来调用API,那么产品需要先订阅才能选择凭证调用API。 前提条件 应用关联的实例已开启公网访问并配置弹性IP,可参考实例配置参数。
来校验API请求是否合法。 同一个环境中一个API只能添加一个签名密钥,一个签名密钥可以添加到多个API上。 前提条件 API已发布。 配置签名密钥 登录ROMA API控制台。 在控制台单击,选择区域,在“ROMA API”下选择待操作的应用。 在左侧导航栏选择“API管理 >
单击“创建环境”,填写“环境名称”和“描述”。 单击“确定”,创建完成。 访问环境 通过RESTful API可以访问API默认的RELEASE环境,如果访问其他环境,需要在请求头中添加X-Stage头,内容为环境名。例如访问名为“DEVELOP”的环境,则添加“X-Stage: DEVELOP”。
理员在APIG实例下创建)。 添加AppCode 使用APP认证方式的API,支持通过AppCode进行API调用的简易安全认证。 绑定凭据配额策略 凭据配额用于限制凭据在某个时间周期内的API调用次数,支持自定义重置时间。 绑定访问控制策略 客户端访问控制可控制访问API的客户
APP认证方式调用API,需要提前获取如下信息: 访问服务前,首先需要得到API的请求方法和请求url。 在API服务详情中的“API运行”页面,查看对应API的请求方法和请求url。 图1 API基础定义 您必须将API发布到环境才能访问。 在API服务详情中的“API运行”页面,查看已发布的环境。
调用API 调用已发布的API 配置跨域访问API 错误码 父主题: API消费
选择待导出API所在的部署环境。 API 默认导出API服务在所选择环境下的所有API。如果只需要导出个别API,可单击“自定义导出API”,勾选需要导出的API。 API定义范围 选择导出的API服务文件中,API定义字段的类型范围。 基础定义:包括API前端请求定义和响应定义,不包括后端服务定义。其中A
body_bytes_sent API请求的Body体大小,单位字节。 34 api_name API名称。 35 app_name 当使用APP认证访问时,请求方使用的APP名称。 36 provider_app_id API所属的APP ID。 37 provider_app_name API所属的APP名称。
使用的应用未被授权访问该API API运行时可获取变量 表2 网关错误响应消息体支持的变量 运行时变量名称 描述 $context.apiId API的ID $context.appId API消费者的APP对象ID $context.requestId 当次API调用生成请求ID
Key)认证调用请求。其签名方式和APP认证相似。 使用自定义认证调用API 如果您希望使用自己的认证方式,可以在函数服务中编写一个函数,将其作为您的认证服务。 使用无认证调用API 对API请求不进行认证。 通过多种开发语言对后端服务进行签名 指导API开放者通过创建后端签名,确保后端服务的安全。
/华为IAM认证对API的访问进行认证鉴权时,您可以使用自定义认证,通过您自定义的函数进行认证鉴权。 后端自定义认证:当不同的后端服务使用不同的认证系统时,导致您需要为不同的认证系统定制化开发API,而APIG通过自定义认证功能,将多种认证系统集成,简化API开发的复杂度。您只需要在ROMA
将提示8080端口被监测,请单击“确定”。 在IDE右上角将弹出8080端口访问确认,请单击“确定”,允许外部访问8080端口。 8080端口允许访问后,单击右上角“访问”即可访问运行中的应用。 应用访问成功后,将打开一个新的Web网站,页面中显示如下信息。 (可选)环境清理。
创建SSL证书 如果API服务中的API支持HTTPS请求协议,则在绑定独立域名后,还需为独立域名添加SSL证书。 前提条件 仅支持添加pem编码格式的SSL证书。 添加的SSL证书仅支持RSA、ECDSA和DSA加密算法。 创建SSL证书 登录ROMA API控制台。 在控制台单击,选择区域,在“ROMA
功能总览 功能总览 全部 ROMA API API设计 API实现 API管理 API消费 API分析 管理中心 API SDK OBS 2.0支持ROMA API ROMA API为企业构建规范化的API全流程体系,将企业服务能力包装成标准API服务,上架市场进行售卖。变现自身服