检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
String 后端API为签名认证时绑定的签名密钥编号 最小长度:1 最大长度:64 roma_app_id String 后端API归属的集成应用编号 更新后端API时,status=4为后端API的已部署状态,该状态下后端API归属的集成应用编号不能修改。 最小长度:1 最大长度:65
auth_type String API的认证方式 run_env_name String 发布的环境名 group_name String API所属分组的名称 publish_id String 发布记录的编号 group_id String API所属分组的编号 name String
查询网关信息 主题Topic Topic /v1/devices/{gatewayId}/topo/query 消息发送方 边设备 消息接收方 物联网平台 参数说明 字段名 必选/可选 类型 参数描述 mid 必选 Integer 命令ID。 nodeId 必选 String 设备标识。
call_limits Integer 流控时长内分组下的API的总访问次数限制,默认不限,请根据服务的负载能力自行设置 暂不支持 time_interval Integer 流控时长 暂不支持 time_unit String 流控的时间单位 暂不支持 is_default Integer
objects 本次查询到的后端API部署结果对象列表 表4 LdApiDeployHistoryInfo 参数 参数类型 描述 id String 部署的编号 ld_api_id String 部署的后端API编号 group_id String 部署的前端API分组编号 env_id
String 后端API为签名认证时绑定的签名密钥编号 最小长度:1 最大长度:64 roma_app_id 是 String 后端API归属的集成应用编号 更新后端API时,status=4为后端API的已部署状态,该状态下后端API归属的集成应用编号不能修改。 最小长度:1 最大长度:65
ken的值)。 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 size Integer 本次返回的列表长度 total Long 满足条件的记录数 his Array of LdApiTestHistoryInfo objects 本次查询到的测试结果对象列表
删除API 功能介绍 删除指定的API。 删除API时,会删除该API所有相关的资源信息或绑定关系,如API的发布记录,绑定的后端服务,对APP的授权信息等。 URI DELETE /v1/{project_id}/apic/instances/{instance_id}/apis/{api_id}
头中X-Subject-Token的值)。 表3 请求Body参数 参数 是否必选 参数类型 描述 env_id 是 String 需要授权的环境编号 最小长度:1 最大长度:65 app_ids 是 Array of strings APP的编号列表 api_ids 是 Array
怎样保证API对应的后端服务器的安全? 通过以下方法确保API的后端服务器的安全: 为API绑定签名密钥。在绑定签名密钥后,APIC到后端服务的请求增加签名信息,后端服务收到请求后计算签名信息,验证计算后的签名信息与APIC的签名信息是否一致。 使用HTTPS对请求进行加密。使用
Integer 每页显示的条目数量。 请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 响应参数 状态码:
消息头中X-Subject-Token的值)。 表3 请求Body参数 参数 是否必选 参数类型 描述 name 是 String API分组的名称。 支持汉字、英文、数字、中划线、下划线、点、斜杠、中英文格式下的小括号和冒号、中文格式下的顿号,且只能以英文、汉字和数字开头,3-255个字符。
ken接口获取(响应消息头中X-Subject-Token的值)。 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 size Integer 本次返回的列表长度 total Long 满足条件的记录数 signs Array of SignatureWithBindNum
Key 根据选择的密钥类型,填写不同的密钥信息。 HMAC:填写HMAC认证所使用密钥对的Key。 Basic Auth:填写Basic Auth认证所使用的用户名。 Aes:填写AES认证所使用的密钥key。 Secret 根据选择的密钥类型,填写不同的密钥信息。 HMAC
path String 健康检查时的目标路径。protocol = http或https时必选 method String 健康检查时的请求方法 缺省值:GET port Integer 健康检查的目标端口,缺少或port = 0时为VPC中主机的端口号。 若此端口存在非0值,则使用此端口进行健康检查。
返回结果 状态码 请求发送以后,您会收到响应,包含状态码、响应消息头和消息体。 状态码是一组从1xx到5xx的数字代码,状态码表示了请求响应的状态,完整的状态码列表请参见状态码。 对于获取用户Token接口,如果调用后返回状态码为“201”,则表示请求成功。 响应消息头 对应请求
添加网关子设备 主题Topic Topic /v1/devices/{gatewayId}/topo/add 消息发送方 边设备 消息接收方 物联网平台 参数说明 字段名 必选/可选 类型 参数描述 mid 必选 Integer 命令ID。 deviceInfos 必选 List<DeviceInfos>
Connect向该API的后端服务发送请求时,会使用签名密钥中的Key和Secret在后端服务请求中增加相应的签名信息。此时需要后端服务依照同样方式进行签名,通过比对签名结果与请求的Authorization头中携带的签名是否一致,来校验ROMA Connect发过来的请求是否合法。 创建签名密钥
ject-Token的值)。 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 size Integer 本次返回的列表长度 total Long 满足条件的记录数 envs Array of EnvInfo objects 本次返回的环境列表 表5 EnvInfo
缺省值:10 task_name 否 String 需要搜索的任务名称,支持模糊搜索,大小写敏感,非必填参数,如果为空,搜索所有任务。 最小长度:0 最大长度:100 execute_status 否 String 需要搜索任务的执行状态,非必填参数,如果为空,搜索所有任务: UNSTARTED(未启动)