检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
MQS连接开发(RESTful API) Java Demo使用说明 生产消息接口说明 消费消息接口说明 消费确认接口说明 父主题: 消息集成开发指导
API管理 下线API 导入导出API 配置API定时任务 SSL证书管理 附录:API的Swagger扩展定义 父主题: 服务集成指导(旧版界面)
表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 响应参数 状态码: 401 表3 响应Body参数 参数 参数类型
ken接口获取(响应消息头中X-Subject-Token的值)。 表3 请求Body参数 参数 是否必选 参数类型 描述 ld_api_id 否 String 部署的后端API编号 deploy_front_api 否 Boolean 是否自动发布API true:部署完成后自
String 后端API的编号 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 表3 请求Body参数
调试API 在API创建后,您可以使用ROMA Connect提供的调试功能对API进行调试,确保API的功能正常。 约束与限制 后端服务请求路径中含有环境变量的API不支持调试。 在调试API时,API绑定流控策略无效。 若定义后端配置时配置的“后端超时(ms)”与“重试次数”
下线API 已发布的API,如果需要暂停对外提供服务,可以将API从相关发布环境中下线。 操作步骤 登录ROMA Connect控制台,在“实例”页面单击实例上的“查看控制台”,进入实例控制台。 在左侧的导航栏选择“服务集成 APIC > API列表”,在页面中单击API右侧的“更多
下线API 概述 已发布的API,如果需要暂停对外提供服务,可以将API从相关发布环境中下线。 操作步骤 登录ROMA Connect控制台,在“实例”页面单击实例上的“查看控制台”,进入实例控制台。 在左侧的导航栏选择“服务集成 APIC > API管理”,在“API列表”页签中单击API右侧的“更多
表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 响应参数 状态码: 400 表3 响应Body参数 参数 参数类型
配置API授权(可选) 概述 若数据API使用了APP认证方式,则需要配置调用授权,把API授权给指定集成应用。用户调用API时,使用集成应用的Key和Secret进行API请求的安全认证。 前提条件 API的安全认证方式为“APP认证”。 API已发布到环境,否则请先发布API。
配置API授权(可选) 概述 若函数API使用了APP认证方式,则需要配置调用授权,把API授权给指定集成应用。用户调用API时,使用集成应用的Key和Secret进行API请求的安全认证。 前提条件 API的安全认证方式为“APP认证”。 API已发布到环境,否则请先发布API。
在导出API页面中,配置API导出相关信息。 表2 导出API 参数 说明 API分组 选择要导出API所在的API分组。 运行环境 选择要导出API所在的发布环境。 API 选择要导出的API。若不配置,则默认导出API分组在所选环境下的所有的API。 API定义范围 选择要导出的API定义信息范围。
调用API 调用开放的API 配置跨域访问API 定时调用API 查看API调用统计 查看API调用日志 附录:API错误码 响应消息头 父主题: 服务集成指导
查询API历史版本列表 功能介绍 查询某个API的历史版本。每个API在一个环境上最多存在10个历史版本。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI GET /
AM账号 ak 仅当“登录方式”选择“ak/sk”时需要配置。AK/SK是用户在云服务平台的长期身份凭证,您可以参考访问密钥获取AK/SK。 sk 仅当“登录方式”选择“ak/sk”时需要配置。AK/SK是用户在云服务平台的长期身份凭证,您可以参考访问密钥获取AK/SK。 密码
表3 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型
information. 检查认证信息是否正确。 403 APIC.0306 API access denied. 检查是否授权访问API。 401 APIC.0307 The token must be updated. token需要更新。 429 APIC.0308 The throttling
String 用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 表3 请求Body参数 参数 是否必选 参数类型 描述 name 是 String API分组的名称。 支持汉字、英文、数字、中划线、下划线、点、斜杠、中英文格
是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 表4 请求Body参数 参数 是否必选 参数类型 描述 apis 否 Array of strings
导入API 已创建的API产品资产,可以将API导入到资产中。 登录新版ROMA Connect控制台。 在左侧导航栏选择“资产中心>我的资产”。 单击一个API产品类型的资产,并切换到“API资产”页签。 单击“导入api”,弹出“添加API资产”弹窗。 选择“从ROMA中导入”或“外部上传”,进行API导入。