查看版本详情

project_id

是

String

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

instance_id

是

String

实例ID

version_id

是

String

API版本的编号

X-Auth-Token

是

String

用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。

name

String

API名称。

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

最小长度：3

最大长度：255

type

Integer

API类型

• 1：公有API

• 2：私有API

version

String

API的版本

最大长度：16

req_protocol

String

API的请求协议

• HTTP

• HTTPS

• BOTH：同时支持HTTP和HTTPS

缺省值：HTTPS

req_method

String

API的请求方式

req_uri

String

请求地址。可以包含请求参数，用{}标识，比如/getUserInfo/{userId}，支持 * % - _ . 等特殊字符，总长度不超过512，且满足URI规范。

auth_type

String

API的认证方式

• NONE：无认证

• APP：APP认证

• IAM：IAM认证

• AUTHORIZER：自定义认证

auth_opt

AuthOpt object

认证方式参数

cors

Boolean

是否支持跨域

• TRUE：支持

• FALSE：不支持

缺省值：false

match_mode

String

API的匹配方式

• SWA：前缀匹配

• NORMAL：正常匹配（绝对匹配） 默认：NORMAL

backend_type

String

后端类型

• HTTP：web后端

• FUNCTION：函数工作流

• MOCK：模拟的后端

remark

String

API描述。

不允许带有<、>字符

最小长度：0

最大长度：1000

group_id

String

API所属的分组编号

最小长度：1

最大长度：65

body_remark

String

API请求体描述，可以是请求体示例、媒体类型、参数等信息。

最大长度：20480

result_normal_sample

String

正常响应示例，描述API的正常返回信息。

最大长度：20480

result_failure_sample

String

失败返回示例，描述API的异常返回信息。

最大长度：20480

authorizer_id

String

前端自定义认证对象的ID

最小长度：1

最大长度：65

tags

Array of strings

标签。

支持英文，数字，下划线，且只能以英文开头。支持输入多个标签，不同标签以英文逗号分割。

最小长度：1

最大长度：128

response_id

String

分组自定义响应ID

暂不支持

最小长度：1

最大长度：65

roma_app_id

String

API归属的集成应用编号

API分组为全局分组时或API绑定自定义域名时必填。

最小长度：1

最大长度：65

domain_name

String

API绑定的自定义域名，使用自定义域名时roma_app_id字段必填。

最大长度：255

tag

String

标签

待废弃，优先使用tags字段

最大长度：255

id

String

API编号

status

Integer

API状态

• 1： 有效

arrange_necessary

Integer

是否需要编排

register_time

String

API注册时间

update_time

String

API修改时间

group_name

String

API所属分组的名称

group_version

String

API所属分组的版本

run_env_name

String

发布的环境名称

存在多个发布记录时，环境名称之间用|隔开

run_env_id

String

发布的环境编号

存在多个发布记录时，环境编号之间用|隔开

publish_id

String

发布记录编号

存在多个发布记录时，发布记录编号之间用|隔开

roma_app_name

String

API归属的集成应用名称

ld_api_id

String

当API的后端为自定义后端时，对应的自定义后端API编号

func_info

ApiFunc object

函数工作流后端详情

mock_info

ApiMock object

mock后端详情

req_params

Array of ReqParam objects

API的请求参数列表

backend_params

Array of BackendParam objects

API的后端参数列表

policy_functions

Array of ApiPolicyFunctionResp objects

函数工作流策略后端列表

policy_mocks

Array of ApiPolicyMockResp objects

mock策略后端列表

backend_api

BackendApi object

web后端详情

policy_https

Array of ApiPolicyHttpResp objects

web策略后端列表

sl_domain

String

系统默认分配的子域名

sl_domains

Array of strings

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

version_id

String

版本编号

publish_time

String

版本发布时间

app_code_auth_type

String

AppCode简易认证类型，仅在auth_type为APP时生效，默认为DISABLE：

• DISABLE：不开启简易认证

• HEADER：开启简易认证且AppCode位置在HEADER

缺省值：DISABLE

function_urn

String

函数URN

remark

String

描述信息。

最大长度：255

invocation_type

String

调用类型

• async： 异步

• sync：同步

version

String

版本。

最大长度：64

timeout

Integer

ROMA Connect APIC请求后端服务的超时时间。最大超时时间可通过实例特性backend_timeout配置修改，可修改的上限为600000

单位：毫秒。

最小值：1

authorizer_id

String

后端自定义认证ID

id

String

编号

register_time

String

注册时间

status

Integer

后端状态

• 1： 有效

update_time

String

修改时间

remark

String

描述信息。

最大长度：255

result_content

String

返回结果

version

String

版本。字符长度不超过64

authorizer_id

String

后端自定义认证ID

id

String

编号

register_time

String

注册时间

status

Integer

后端状态

• 1： 有效

update_time

String

修改时间

name

String

参数名称。 由英文字母、数字、中划线、下划线、英文句号组成，且只能以英文开头。

最小长度：1

最大长度：32

type

String

参数类型

location

String

参数位置

default_value

String

参数默认值

sample_value

String

参数示例值

required

Integer

是否必须

• 1：是

• 2：否

location为PATH时，required默认为1，其他场景required默认为2

valid_enable

Integer

是否开启校验

• 1：开启校验

• 2：不开启校验

remark

String

描述信息。

最大长度：255

enumerations

String

参数枚举值

min_num

Integer

参数最小值

参数类型为NUMBER时有效

max_num

Integer

参数最大值

参数类型为NUMBER时有效

min_size

Integer

参数最小长度

参数类型为STRING时有效

max_size

Integer

参数最大长度

参数类型为STRING时有效

regular

String

正则校验规则

暂不支持

json_schema

String

JSON校验规则

暂不支持

pass_through

Integer

是否透传

• 1：是

• 2：否

id

String

参数编号

function_urn

String

函数URN

invocation_type

String

调用类型

• async： 异步

• sync：同步

timeout

Integer

ROMA Connect APIC请求后端服务的超时时间。最大超时时间可通过实例特性backend_timeout配置修改，可修改的上限为600000

单位：毫秒。

最小值：1

version

String

版本。字符长度不超过64

id

String

编号

name

String

策略后端名称。字符串由中文、英文字母、数字、下划线组成，且只能以中文或英文开头。

最小长度：3

最大长度：64

conditions

Array of ConditionResp objects

策略条件列表

backend_params

Array of BackendParam objects

后端参数列表

effect_mode

String

关联的策略组合模式：

• ALL：满足全部条件

• ANY：满足任一条件

authorizer_id

String

后端自定义认证对象的ID

最小长度：1

最大长度：65

id

String

编号

name

String

策略后端名称。字符串由中文、英文字母、数字、下划线组成，且只能以中文或英文开头。

最小长度：3

最大长度：64

conditions

Array of ConditionResp objects

策略条件列表

backend_params

Array of BackendParam objects

后端参数列表

effect_mode

String

关联的策略组合模式：

• ALL：满足全部条件

• ANY：满足任一条件

authorizer_id

String

后端自定义认证对象的ID

最小长度：1

最大长度：65

result_content

String

返回结果

authorizer_id

String

后端自定义认证对象的ID

url_domain

String

后端服务的地址。

由主机（IP或域名）和端口号组成，总长度不超过255。格式为主机:端口（如：apig.example.com:7443）。如果不写端口，则HTTPS默认端口号为443，HTTP默认端口号为80。

支持环境变量，使用环境变量时，每个变量名的长度为3 ~ 32位的字符串，字符串由英文字母、数字、下划线、中划线组成，且只能以英文开头

req_protocol

String

请求协议

remark

String

描述。

最大长度：255

req_method

String

请求方式

version

String

web后端版本，字符长度不超过16

req_uri

String

请求地址。可以包含请求参数，用{}标识，比如/getUserInfo/{userId}，支持 * % - _ . 等特殊字符，总长度不超过512，且满足URI规范。

支持环境变量，使用环境变量时，每个变量名的长度为3 ~ 32位的字符串，字符串由英文字母、数字、中划线、下划线组成，且只能以英文开头。

timeout

Integer

ROMA Connect APIC请求后端服务的超时时间。最大超时时间可通过实例特性backend_timeout配置修改，可修改的上限为600000

单位：毫秒。

最小值：1

enable_client_ssl

Boolean

是否开启双向认证

id

String

编号

status

Integer

后端状态

• 1： 有效

register_time

String

注册时间

update_time

String

修改时间

vpc_channel_info

VpcInfo object

VPC通道详情。如果vpc_channel_status = 1，则这个object类型为必填信息

vpc_channel_status

Integer

是否使用VPC通道

• 1：使用VPC通道

• 2：不使用VPC通道

ecs_id

String

云服务器ID

ecs_name

Integer

云服务器名称

cascade_flag

Boolean

是否使用级联方式

暂不支持

vpc_channel_proxy_host

String

代理主机

vpc_channel_id

String

VPC通道编号

最大长度：64

vpc_channel_port

String

VPC通道端口

id

String

编号

name

String

策略后端名称。字符串由中文、英文字母、数字、下划线组成，且只能以中文或英文开头。

最小长度：3

最大长度：64

conditions

Array of ConditionResp objects

策略条件列表

backend_params

Array of BackendParam objects

后端参数列表

effect_mode

String

关联的策略组合模式：

• ALL：满足全部条件

• ANY：满足任一条件

authorizer_id

String

后端自定义认证对象的ID

最小长度：1

最大长度：65

url_domain

String

策略后端的Endpoint。 由域名（或IP地址）和端口号组成，总长度不超过255。格式为域名:端口（如：apig.example.com:7443）。如果不写端口，则HTTPS默认端口号为443， HTTP默认端口号为80。 支持环境变量，使用环境变量时，每个变量名的长度为3 ~ 32位的字符串，字符串由英文字母、数字、“_”、“-”组成，且只能以英文开头。

req_protocol

String

请求协议：HTTP、HTTPS

req_method

String

请求方式：GET、POST、PUT、DELETE、HEAD、PATCH、OPTIONS、ANY

req_uri

String

请求地址。可以包含请求参数，用{}标识，比如/getUserInfo/{userId}，支持 * % - _ . 等特殊字符，总长度不超过512，且满足URI规范。

支持环境变量，使用环境变量时，每个变量名的长度为3 ~ 32位的字符串，字符串由英文字母、数字、中划线、下划线组成，且只能以英文开头。

timeout

Integer

ROMA Connect APIC请求后端服务的超时时间。最大超时时间可通过实例特性backend_timeout配置修改，可修改的上限为600000

单位：毫秒。

最小值：1

enable_client_ssl

Boolean

是否开启双向认证

vpc_channel_info

VpcInfo object

VPC通道详情。如果vpc_channel_status = 1，则这个object类型为必填信息

vpc_channel_status

Integer

是否使用VPC通道：

• 1： 使用VPC通道

• 2：不使用VPC通道

req_param_name

String

关联的请求参数对象名称。策略类型为param时必选

condition_type

String

策略条件

• exact：绝对匹配

• enum：枚举

• pattern：正则

策略类型为param时必选

condition_origin

String

策略类型

• param：参数

• source：源IP

condition_value

String

策略值

id

String

编号

req_param_id

String

关联的请求参数对象编号

req_param_location

String

关联的请求参数对象位置

name

String

参数名称。 字符串由英文字母、数字、中划线、下划线、英文句号组成，且只能以英文开头。

最小长度：1

最大长度：32

location

String

参数位置：PATH、QUERY、HEADER

origin

String

参数类别：REQUEST、CONSTANT、SYSTEM

value

String

参数值。字符长度不超过255，类别为REQUEST时，值为req_params中的参数名称；类别为CONSTANT时，值为参数真正的值；类别为SYSTEM时，值为网关参数名称

最大长度：255

remark

String

描述。

最大长度：255

id

String

参数编号

req_param_id

String

对应的请求参数编号

error_code

String

错误码

error_msg

String

错误描述

error_code

String

错误码

error_msg

String

错误描述

error_code

String

错误码

error_msg

String

错误描述

error_code

String

错误码

error_msg

String

错误描述

200

OK

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error