文档首页/ 应用与数据集成平台 ROMA Connect/ API参考/ 历史API/ 服务集成API（V1）/ API分组管理（V1）/ 创建API分组
更新时间：2024-07-03 GMT+08:00
在线调试
CLI示例
查看PDF
分享

创建API分组

功能介绍

API分组是API的管理单元，一个API分组等同于一个服务入口，创建API分组时，返回一个子域名作为访问入口。建议一个API分组下的API具有一定的相关性。

URI

POST /v1/{project_id}/apic/instances/{instance_id}/api-groups

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID，获取方式请参见API参考的“附录 > 获取项目ID”章节。

instance_id

是

String

实例ID

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。
表3 请求Body参数

参数

是否必选

参数类型

描述

name

是

String

API分组的名称。

支持汉字、英文、数字、中划线、下划线、点、斜杠、中英文格式下的小括号和冒号、中文格式下的顿号，且只能以英文、汉字和数字开头，3-255个字符。

说明：

中文字符必须为UTF-8或者unicode编码。

最小长度：3

最大长度：255

remark

否

String

API分组描述。

说明：

中文字符必须为UTF-8或者unicode编码。

最大长度：1000

roma_app_id

否

String

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

分组版本V2时必填。

version

否

String

分组版本

  • V1：全局分组

  • V2：应用级分组

响应参数

状态码： 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_domain_access_enabled

Boolean

调试域名是否可以访问，true表示可以访问，false表示禁止访问

缺省值：true

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

错误描述

请求示例

{
  "name" : "api_group_001",
  "remark" : "group1"
}

响应示例

状态码： 201

Created

{
  "update_time" : "2020-07-31T06:55:55.383169299Z",
  "name" : "api_group_001",
  "on_sell_status" : 2,
  "remark" : "group1",
  "sl_domains" : [ "c77f5e81d9cb4424bf704ef2b0ac7600.apic.****.com", "c77f5e81d9cb4424bf704ef2b0ac7600.apic.****.cn" ],
  "sl_domain" : "c77f5e81d9cb4424bf704ef2b0ac7600.apic.****.com",
  "id" : "c77f5e81d9cb4424bf704ef2b0ac7600",
  "register_time" : "2020-07-31T06:55:55.383169068Z",
  "status" : 1,
  "is_default" : 2,
  "version" : "V1"
}

状态码： 400

Bad Request

{
  "error_code" : "APIG.2011",
  "error_msg" : "Invalid parameter value,parameterName:name. Please refer to the support documentation"
}

状态码： 401

Unauthorized

{
  "error_code" : "APIG.1002",
  "error_msg" : "Incorrect token or token resolution failed"
}

状态码： 403

Forbidden

{
  "error_code" : "APIG.1005",
  "error_msg" : "No permissions to request this method"
}

状态码： 404

Not Found

{
  "error_code" : "APIG.3030",
  "error_msg" : "The instance does not exist;id:f0fa1789-3b76-433b-a787-9892951c620ec"
}

状态码： 500

Internal Server Error

{
  "error_code" : "APIG.9999",
  "error_msg" : "System error"
}

状态码

状态码

描述

201

Created

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

错误码

请参见错误码。

相关文档