检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
JavaScript SDK使用说明 操作场景 使用JavaScript语言调用APP认证的API时,您需要先获取SDK,然后新建工程,最后参考API调用示例调用API。 JavaScript SDK支持Node.js和浏览器两种运行环境,本章节Node.js开发环境为例介绍。 前提条件
绑定域名 功能介绍 用户自定义的域名,需要CNAME到API分组的子域名上才能生效。 每个API分组下最多可绑定5个域名。绑定域名后,用户可通过自定义域名调用API。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例
API绑定插件 功能介绍 绑定插件到API上。 只能选择发布状态的API 绑定以后及时生效 修改插件后及时生效 相同类型的插件只能绑定一个,原来已经绑定的同类型插件,会直接覆盖。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成
校验API定义 功能介绍 校验API定义。校验API的路径或名称是否已存在 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI POST /v2/{project_id}/
删除API 功能介绍 删除指定的API。 删除API时,会删除该API所有相关的资源信息或绑定关系,如API的发布记录,绑定的后端服务,对APP的授权信息等。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,
修改域名 功能介绍 修改绑定的域名所对应的配置信息。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI PUT /v2/{project_id}/apic/instances
修改环境 功能介绍 修改指定环境的信息。其中可修改的属性为:name、remark,其它属性不可修改。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI PUT /v2/
创建API分组 API分组是同一类业务API的集合,API开发者以API分组为单位,管理分组内的所有API。每个API都要归属到某个API分组下,在创建API前应提前创建API分组。 约束与限制 API分组创建后,系统为分组自动分配一个内部测试用的子域名,此子域名每天最多可以访问1000
创建函数后端 ROMA Connect支持把自定义函数定义为后端服务,把函数的能力以API的形式对外开放。 前提条件 如果后端服务需要使用签名密钥请求发送方进行认证,请提前创建签名密钥。 约束与限制 当前函数API支持的脚本大小最大为32KB。 操作步骤 登录ROMA Connect
创建数据后端 概述 ROMA Connect支持把数据源定义为后端服务,实现从数据源中读写数据,并以API的形式对外开放。 约束与限制 数据源存储的单行数据大小建议不超过2KB,若超过该限制会导致自定义后端响应异常。 当数据源返回numeric类型数据时,如果该数据的小数位精度超过
查看API调用统计 ROMA Connect提供了API的可视化分析和统计能力,支持查看API的调用统计。 约束与限制 Site实例中不支持监控分析。 操作步骤 登录ROMA Connect控制台,在“实例”页面单击实例上的“查看控制台”,进入实例控制台。 在左侧的导航栏选择“服务集成
解除授权 功能介绍 解除API对APP的授权关系。解除授权后,APP将不再能够调用该API。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI DELETE /v2/{project_id
使用插件 概述 ROMA Connect支持通过插件的方式,为API提供灵活的扩展能力。 前提条件 插件和API本身相互独立,只有为API绑定插件后,插件才对API生效。为API绑定插件时需指定发布环境,插件只对指定环境上的API生效。 同一个API在同一个环境中只能绑定一个相同类型的插件
查看实例详情 功能介绍 查看实例详情 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI GET /v2/{project_id}/apic/instances/{instance_id
查询插件详情 功能介绍 查询插件详情。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI GET /v2/{project_id}/apic/instances/{instance_id
切换API版本 功能介绍 API每次发布时,会基于当前的API定义生成一个版本。版本记录了API发布时的各种定义及状态。 多个版本之间可以进行随意切换。但一个API在一个环境上,只能有一个版本生效。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer
APP授权 功能介绍 APP创建成功后,还不能访问API,如果想要访问某个环境上的API,需要将该API在该环境上授权给APP。授权成功后,APP即可访问该环境上的这个API。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成
创建环境 功能介绍 在实际的生产中,API提供者可能有多个环境,如开发环境、测试环境、生产环境等,用户可以自由将API发布到某个环境,供调用者调用。 对于不同的环境,API的版本、请求地址甚至于包括请求消息等均有可能不同。如:某个API,v1.0的版本为稳定版本,发布到了生产环境供生产使用
调试API 功能介绍 调试一个API在指定运行环境下的定义,接口调用者需要具有操作该API的权限。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI POST /v2/{
删除环境 功能介绍 删除指定的环境。 该操作将导致此API在指定的环境无法被访问,可能会影响相当一部分应用和用户。请确保已经告知用户,或者确认需要强制下线。环境上存在已发布的API时,该环境不能被删除。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API