检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
SDK概述 本文介绍了ROMA API提供的开放API的SDK语言版本,列举了最新版本SDK的获取地址。 SDK列表 提供了ROMA API支持的SDK列表,您可以在GitHub仓库选择APIG或ROMA服务查看SDK更新历史、获取安装包以及查看指导文档。
配置获取的API请求信息。 添加Header参数“X-HW-ID”,参数值为“凭证信息”的“Key”。 添加Header参数“X-HW-AppKey”,参数值为“凭证信息”的“Secret”。 调用成功后,显示“200 OK”。
获取并安装Visual Studio,如果未安装,请至Visual Studio官方网站下载。 打开工程 双击SDK包中的“csharp.sln”文件,打开工程。
获取用户Token,请求内容示例如下: curl -X POST https://{iam_endpoint}/v3/auth/tokens -H 'content-type: application/json' -d '{ "auth": { "identity": {
根据下表相关任务,了解如何管理应用。 表1 应用相关任务 相关任务 使用场景 操作步骤 查看应用 查看应用下不同区域关联的不同实例资源和项目资源,包含应用信息、实例信息、调用密钥、APPCode等。 在搜索框中输入需要查看的应用名称。
概述 使用APP认证调用API APP认证需要通过SDK访问。 使用IAM认证调用API 支持Token认证和AK/SK认证两种。 Token认证:通过Token认证调用请求。Token认证无需使用SDK签名,优先使用Token认证。
API认证 APP认证工作原理 APP认证-Java IAM认证 其他认证 自定义认证 对后端服务进行签名 02 购买 ROMA API本身不收费,但部分功能需要关联对应资源才能使用,关联的资源需要提前购买。
使用的应用未被授权访问该API API运行时可获取变量 表2 网关错误响应消息体支持的变量 运行时变量名称 描述 $context.apiId API的ID $context.appId API消费者的APP对象ID $context.requestId 当次API调用生成请求ID
前端自定义认证:如果您希望使用自己的认证系统,而不是APP认证/华为IAM认证对API的访问进行认证鉴权时,您可以使用自定义认证,通过您自定义的函数进行认证鉴权。
在控制台单击,选择区域,在“ROMA API”下选择待操作的应用。 在左侧导航栏选择“API管理 > API服务”。 在当前应用关联的实例中,根据实际业务选择实例。 在页面上单击服务名称,进入API服务详情页面。 单击“API运行”页签。
API消费 4 API分析 快速获取API指标,方便API管理者维护和运营。 API分析 5 管理中心 支持购买实例和创建应用。 管理中心
创建应用 开始使用ROMA API前,您需要先创建应用,然后在应用中创建和管理您的API资源。 账号用户可管理其下所有IAM用户所创建的应用和资源,IAM用户只能管理自己创建的应用和资源,默认无法查看其他IAM用户创建的应用和资源。
应用管理 创建应用 管理应用 父主题: 管理中心
应用是一个系统资源的集合,API的全生命周期是在应用中实现,因此在开启API的全生命周期管理之前,您需要在“管理中心”先创建应用。 API设计 API设计者主要负责API整体的规划和设计,提前Mock调测和规范检查。
应用场景 企业API文档规范统一 当今企业随着系统内部功能逐渐增多,子系统数量成倍增长,各个系统间调用依赖愈发重要,此时拥有一个API接口文档系统显得极为关键。
AppCode 仅手动输入方式需要填写AppCode的值。 绑定凭据配额策略 登录ROMA API控制台。 在控制台单击,选择区域,在“ROMA API”下选择待操作的应用。 在左侧的导航栏选择“API管理 > 凭据管理”。 在当前应用关联的实例中,根据实际业务选择实例。
应用状态显示异常是什么原因? 应用的状态基于应用关联的资源状态来显示: 应用关联的ROMA/APIG实例状态异常,或者关联ROMA集成应用不存在时,应用资源会变成异常状态。 有一个应用资源状态显示异常,整个应用的状态就会显示异常。 修复或移除对应的异常资源,应用状态会恢复正常。
授权API 仅使用APP认证方式的API,才需要授权,发布API后,通过指定授权给某些应用,让指定应用能够调用API。 选择需要授权的API。 选择“更多 > 授权”。 在弹窗中设置授权信息。 选择授权应用。 设置访问参数。 选择是否开启绿色通道。
删除应用是否会删除关联的实例? 不会。 删除应用只是删除应用和实例的关联关系,并不会删除实例本身的任何资源。
API API(Application Programming Interface,应用程序编程接口)是一些预先定义的函数,应用将自身的服务能力封装成API,并通过API Connect开放给用户调用。API包括基本信息、前后端的请求路径和参数以及请求相关协议。