检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
进行签名,执行此函数会将生成的签名头加入request变量中。 signer.createSignature(request); 使用curl库访问API,查看访问结果。 static size_t WriteMemoryCallback(void *contents, size_t size
"RELEASE"); 进行签名,执行此函数会将生成的签名头加入request变量中。 sig_sign(¶ms); 使用curl库访问API,查看访问结果。 static size_t WriteMemoryCallback(void *contents, size_t size
在弹窗中修改“名称”,或默认系统自动生成的名称;根据下表说明,选择模板。 表1 API文件模板 模板类型 类型说明 SimpleAPI 提供简单GET请求样例。 DescriptionWithGFM 提供如何在API的描述信息中使用markdown语法,使描述信息更直观。 SimpleBookManagementAPI
权限管理 ROMA API中管理员以及IAM用户创建的应用是隔离的,无法互相访问。如果用户想分配权限给不同的IAM用户,需要手动在应用管理内的权限管理进行分配,或在IAM中给用户添加Tenant Administrator权限。 除应用外,IAM用户也需拥有应用关联资源的权限才可进行对应操作,具体可参考:
当API响应中存在指定的响应头时,删除当前响应头。 当API响应中存在多个与指定响应头相同名称的响应头时,删除所有相同名称的响应头。 skip:跳过 当API响应中存在指定的响应头时,跳过当前响应头。 当API响应中存在多个与指定响应头相同名称的响应头时,均不作处理直接返回。 当
单击“创建环境”,填写“环境名称”和“描述”。 单击“确定”,创建完成。 访问环境 通过RESTful API可以访问API默认的RELEASE环境,如果访问其他环境,需要在请求头中添加X-Stage头,内容为环境名。例如访问名为“DEVELOP”的环境,则添加“X-Stage: DEVELOP”。
选择“更多 > 授权”。 在弹窗中设置授权信息。 选择授权应用。 设置访问参数。 选择是否开启绿色通道。 说明: 仅能授权自己有权限的应用。 访问参数会被添加到后端签名认证信息中,并发送给后端服务,后端服务根据携带的访问参数返回不同的响应参数。 开启绿色通道后,需要设置白名单和黑名单。
使用APP认证调用API 认证前准备 APP认证工作原理 Java Go Python C# JavaScript PHP C++ C Android curl
单击“创建策略”,选择策略类型。 插件策略:通过插件的形式,提供灵活的扩展能力。目前支持跨域资源共享和HTTP响应头管理。 传统策略:流量控制、访问控制和签名密钥。 单击“创建策略”,配置策略信息。 插件策略请参考下表配置: 表1 插件策略配置 参数 配置说明 策略名称 填写策略的名称
试能力,支持导入Swagger文档一键生成API,以便更快速地开放API业务。 API策略 支持传统策略和插件策略。传统策略包括流量控制、访问控制、签名密钥;插件策略包括跨域资源共享、HTTP响应头管理以及更多的插件能力,进而提供更丰富的API安全、运维能力。 API测试 通过导
功能名称 功能描述 相关文档 1 凭据管理 凭据策略用于API运行时的策略管理,支持配置APPCode、绑定应用配额策略和绑定访问控制策略,且只有管理员(IAM用户拥有“Tenant Administrator”权限)能设置。 凭据管理 2 HTTP响应头管理 API响应是指ROMA
APIs管理 创建API 调试API 发布API 管理API 流量控制 访问控制 签名密钥 跨域资源共享 父主题: API管理
API支持把API服务中的API资源作为一个产品,共享给其他用户使用。 操作步骤 登录ROMA API控制台。 在控制台单击,选择区域,在“ROMA API”下选择待操作的应用。 在左侧导航栏选择“API管理 > API服务”。 在当前应用关联的实例中,根据实际业务选择实例。 在需要生成产品的API服务所在行单击“生成产品”。
如果API已绑定流控策略,在调试API时,流控策略无效。 操作步骤 登录ROMA API控制台。 在控制台单击,选择区域,在“ROMA API”下选择待操作的应用。 在左侧导航栏选择“API管理 > API服务”。 在当前应用关联的实例中,根据实际业务选择实例。 在页面上单击服务名称,进入API服务详情页面。
删除应用是否会删除关联的实例? 不会。 删除应用只是删除应用和实例的关联关系,并不会删除实例本身的任何资源。
上架目录 将API产品上架到API目录,供其他用户查看和使用。 操作步骤 登录ROMA API控制台。 在控制台单击,选择区域,在“ROMA API”下选择待操作的应用。 在左侧导航栏选择“API消费 > API产品”。 选择需要上架的API产品,单击产品名称。 在“版本列表”中,选择上架版本,单击“上架”。
调用API 调用已发布的API 配置跨域访问API 错误码 父主题: API消费
删除、更新等操作管理自定义认证。 操作步骤 登录ROMA API控制台。 在控制台单击,选择区域,在“ROMA API”下选择待操作的应用。 在左侧导航栏选择“API管理 > API策略”。 在当前应用关联的实例中,根据实际业务选择实例。 单击“自定义认证”页签。 在“自定义认证”页面,可执行下表操作。
概述 ROMA API目前提供部分API接口信息。 ROMA实例接口信息请参考:《API参考》。 APIG实例接口信息请参考:《API参考》。
API管理(除API测试) 应用需关联APIG实例/ROMA Connect实例 API测试 应用需关联CodeArts项目 API消费 无 API分析 应用需关联APIG实例/ROMA Connect实例 应用管理 不支持关联2019年6月份之前创建的ROMA Connect实例。 配额管理 限制项 默认限制