检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
调用开放的API 概述 API在发布到环境后,即支持被其他用户调用。根据API所使用的安全认证方式不同,调用API的操作有所差异。 前提条件 在调用API前,确保您的业务系统所在网络与API的访问域名或地址互通。 若业务系统与ROMA Connect实例在相同VPC内时,可直接访问API。
是否必选 参数类型 描述 name 是 String 参数名称: 参数位于Headers、 Parameters时,用户自行定义,支持英文、数字、点、中划线、下划线,且需要英文开头,不区分大小写。 参数位于Body时候,参数以application/json、application/xm
接入数据源 概述 在创建数据集成任务前,ROMA Connect需要先接入源端和目标端数据源,确保可以正常从源端读取数据以及向目标端写入数据。 前提条件 在接入数据源前,请确保ROMA Connect实例与您的数据源所在网络互通。 若ROMA Connect实例与数据源在相同VPC内时,可直接访问数据源。
String 应用配置描述 最大长度:1024 config_name 是 String 应用配置名称。 支持英文大小写字符、数字、下划线、中划线、点和@,且只能以英文字母开头。 最小长度:1 最大长度:512 响应参数 状态码: 201 表4 响应Body参数 参数 参数类型 描述 id
查看API绑定的流控策略列表 功能介绍 查询某个API绑定的流控策略列表。每个环境上应该最多只有一个流控策略。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI GET
查询流控策略列表 功能介绍 查询所有流控策略的信息。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI GET /v2/{project_id}/apic/instan
创建Topic 功能介绍 创建Topic。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI POST /v2/{project_id}/mqs/instances/{instance_id}/topics
绑定签名密钥 功能介绍 签名密钥创建后,需要绑定到API才能生效。 将签名密钥绑定到API后,则服务集成请求后端服务时就会使用这个签名密钥进行加密签名,后端服务可以校验这个签名来验证请求来源。 将指定的签名密钥绑定到一个或多个已发布的API上。同一个API发布到不同的环境可以绑定
最大长度:100000 表3 请求Body参数 参数 是否必选 参数类型 描述 device_name 是 String 设备名称,支持中文、中文标点符号()。;,:“”、?《》及英文大小写、数字及英文符号()_,#.?'-@%&!, 长度2-64。 最小长度:2 最大长度:64 status
发布或下线API 功能介绍 对API进行发布或下线。 发布操作是将一个指定的API发布到一个指定的环境,API只有发布后,才能够被调用,且只能在该环境上才能被调用。未发布的API无法被调用。 下线操作是将API从某个已发布的环境上下线,下线后,API将无法再被调用。 调试 您可以在API
导入自定义后端API 功能介绍 导入自定义后端API。导入文件内容需要符合swagger标准规范,自定义扩展字段请参考用户指南的“附录:后端API的Swagger扩展定义”章节 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动
修改ACL策略 功能介绍 修改指定的ACL策略,其中可修改的属性为:acl_name、acl_type、acl_value,其它属性不可修改。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
最小长度:0 最大长度:64 version 是 String 版本号,输入2-50个字符。值以字母或数字开头和结尾。仅允许使用字母、数字、中划线和点号。 最小长度:0 最大长度:64 description 否 String 描述,长度0-200。 最小长度:0 最大长度:200 响应参数
设备用户名,支持英文大小写、英文符号(-)及数字,长度10-50。 最小长度:10 最大长度:50 device_name 是 String 设备名称,支持中文、中文标点符号()。;,:“”、?《》及英文大小写、数字及英文符号()_,#.?'-@%&!, 长度2-64。 最小长度:2 最大长度:64 node_id
批量发布或下线API 功能介绍 将多个API发布到一个指定的环境,或将多个API从指定的环境下线。 URI POST /v1/{project_id}/apic/instances/{instance_id}/apis/publish 表1 路径参数 参数 是否必选 参数类型 描述
最小长度:0 最大长度:64 version 是 String 版本号,输入2-50个字符。值以字母或数字开头和结尾。仅允许使用字母、数字、中划线和点号。 最小长度:0 最大长度:64 description 否 String 描述。 最小长度:0 最大长度:200 响应参数 状态码: 200
创建ACL策略 功能介绍 增加一个ACL策略,策略类型通过字段acl_type来确定(permit或者deny),限制的对象的类型可以为IP或者DOMAIN,这里的DOMAIN对应的acl_value的值为租户名称,而非“www.exampleDomain.com"之类的网络域名。
查看签名密钥绑定的API列表 功能介绍 查询某个签名密钥上已经绑定的API列表。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI GET /v2/{project_i
修改签名密钥 功能介绍 修改指定签名密钥的详细信息。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI PUT /v2/{project_id}/apic/instan
批量发布或下线API 功能介绍 将多个API发布到一个指定的环境,或将多个API从指定的环境下线。 注意:当action = online时,接口返回的响应中publish_id,version_id, publish_time字段才有含义。 调试 您可以在API Explore