应用与数据集成平台 ROMA Connect-创建API分组:响应参数

时间:2023-11-01 16:22:59

响应参数

状态码: 201

表4 响应Body参数

参数

参数类型

描述

id

String

编号

name

String

API分组名称

status

Integer

状态

  • 1: 有效

  • 2: 锁定

sl_domain

String

系统默认分配的子域名

register_time

String

创建时间

update_time

String

最近修改时间

on_sell_status

Integer

是否已上架云市场:

  • 1:已上架

  • 2:未上架

  • 3:审核中

ROMA Connect暂未对接云市场,此字段默认返回2

url_domains

Array of UrlDomain objects

分组上绑定的独立域名列表

sl_domains

Array of strings

系统默认分配的子域名列表

remark

String

描述

call_limits

Integer

流控时长内分组下的API的总访问次数限制,默认不限,请根据服务的负载能力自行设置

暂不支持

time_interval

Integer

流控时长

暂不支持

time_unit

String

流控的时间单位

暂不支持

is_default

Integer

是否为默认分组

version

String

分组版本

  • V1:全局分组

  • V2:应用级分组

roma_app_id

String

分组归属的集成应用编号。

分组版本V2时必填。

roma_app_name

String

分组归属的集成应用名称

表5 UrlDomain

参数

参数类型

描述

id

String

域名编号

domain

String

访问域名

cname_status

Integer

域名cname状态:

  • 1:未解析

  • 2:解析中

  • 3:解析成功

  • 4:解析失败

ssl_id

String

SSL证书编号

ssl_name

String

SSL证书名称

min_ssl_version

String

最小ssl协议版本号。支持TLSv1.1或TLSv1.2

缺省值:TLSv1.1

verified_client_certificate_enabled

Boolean

是否开启客户端证书校验。只有绑定证书时,该参数才生效。当绑定证书存在trusted_root_ca时,默认开启;当绑定证书不存在trusted_root_ca时,默认关闭。

缺省值:false

is_has_trusted_root_ca

Boolean

是否存在信任的根证书CA。当绑定证书存在trusted_root_ca时为true。

缺省值:false

ssl_infos

Array of SslInfo objects

SSL证书列表

暂不支持

表6 SslInfo

参数

参数类型

描述

ssl_id

String

SSL证书编号

ssl_name

String

SSL证书名称

algorithm_type

String

证书算法类型:

  • RSA

  • ECC

  • SM2

暂不支持

type

String

证书可见范围:

  • instance:当前实例

  • global:全局

缺省值:global

状态码: 400

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码: 401

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码: 403

表9 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码: 404

表10 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码: 500

表11 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

support.huaweicloud.com/api-roma/CreateApiGroup.html