检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
在导出API页面中,配置API导出相关信息。 表2 导出API 参数 说明 API分组 选择要导出API所在的API分组。 运行环境 选择要导出API所在的发布环境。 API 选择要导出的API。若不配置,则默认导出API分组在所选环境下的所有的API。 API定义范围 选择要导出的API定义信息范围。
查询后端API详情 功能介绍 查询后端API的详细信息。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI GET /v2/{project_id}/apic/inst
导出API 功能介绍 导出分组下API的定义信息,导出文件内容符合swagger标准规范。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI POST /v2/{pro
调试API 功能介绍 调试一个API在指定运行环境下的定义,接口调用者需要具有操作该API的权限。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI POST /v2/
Connect实例控制台选择“服务集成 APIC > API管理”,在“API列表”页签中可获取API的“域名”、“请求方法”和“请求路径”。单击API的名称进入API详情页面,在“调用信息”页签下,获取API的“请求协议”、“入参定义”和“请求体内容描述”。 获取API的认证信息 根据API使用的安全认证方式不同,还要获取相关的请求认证信息:
更新后端API时,status=4为后端API的已部署状态,该状态下后端API请求路径不能修改。 最小长度:2 最大长度:256 method String 后端API请求方法。 支持GET、PUT、POST、DELETE 更新后端API时,status=4为后端API的已部署状
API管理(V1) 创建API 修改API 删除API 查询API详情 查询API列表 批量删除API 批量发布或下线API 调试API 父主题: 服务集成API(V1)
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时,status=4为后端API的已部署状态,该状态下后端API请求路径不能修改。 最小长度:2 最大长度:256 method 是 String 后端API请求方法。 支持GET、PUT、POST、DELETE 更新后端API时,status=4为后端API的已部署
删除API 功能介绍 删除指定的API。 删除API时,会删除该API所有相关的资源信息或绑定关系,如API的发布记录,绑定的后端服务,对APP的授权信息等。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
删除API 功能介绍 删除指定的API。 删除API时,会删除该API所有相关的资源信息或绑定关系,如API的发布记录,绑定的后端服务,对APP的授权信息等。 URI DELETE /v1/{project_id}/apic/instances/{instance_id}/apis/{api_id}
API绑定流控策略 绑定流控策略 解除API与流控策略的绑定关系 查看流控策略绑定的API列表 查看流控策略未绑定的API列表 查看API绑定的流控策略列表 批量解绑流控策略 父主题: 服务集成API
$context.apiName: API的名称 $context.apiId:API的ID $context.appName: API调用者的APP对象名称 $context.appId:API调用者的APP对象ID $context.requestId:当次API调用生成跟踪ID $context
重试或联系技术支持工程师检查是否数据面同步异常 400 APIG.3608 Cannot edit APIs in the API Designer. 没有权限操作API设计器创建的API 不允许操作,请操作其他API 400 APIG.3610 When the backend uses
roma_app_name String API归属的集成应用名称 ld_api_id String 当API的后端为自定义后端时,对应的自定义后端API编号 backend_api BackendApi object 后端信息 api_group_info ApiGroupCommonInfo
导入API 已创建的API产品资产,可以将API导入到资产中。 登录新版ROMA Connect控制台。 在左侧导航栏选择“资产中心>我的资产”。 单击一个API产品类型的资产,并切换到“API资产”页签。 单击“导入api”,弹出“添加API资产”弹窗。 选择“从ROMA中导入”或“外部上传”,进行API导入。
下线API 已发布的API,如果需要暂停对外提供服务,可以将API从相关发布环境中下线。 操作步骤 登录ROMA Connect控制台,在“实例”页面单击实例上的“查看控制台”,进入实例控制台。 在左侧的导航栏选择“服务集成 APIC > API列表”,在页面中单击API右侧的“更多
调试API 在API创建后,您可以使用ROMA Connect提供的调试功能对API进行调试,确保API的功能正常。 约束与限制 后端服务请求路径中含有环境变量的API不支持调试。 在调试API时,API绑定流控策略无效。 若定义后端配置时配置的“后端超时(ms)”与“重试次数”
Connect实例的“服务集成 APIC > API列表”中查看并编辑该发布的API。 支持的动作 接收API调用 配置参数 参数 说明 API名称 填写API的名称,根据规划自定义。该名称会在对应ROMA Connect实例的“服务集成 APIC > API列表”中展示。 安全认证 选择安全认证方式,当前支持以下方式
设备集成API(V1) 产品管理 设备管理 规则引擎 父主题: 历史API