查询API列表

project_id

是

String

项目ID，获取方式请参见获取项目ID。

instance_id

是

String

实例ID，在API网关控制台的“实例信息”中获取。

offset

否

Long

偏移量，表示从此偏移量开始查询，偏移量小于0时，自动转换为0

缺省值：0

limit

否

Integer

每页显示的条目数量，条目数量小于等于0时，自动转换为20，条目数量大于500时，自动转换为500

最小值：1

最大值：500

缺省值：20

id

否

String

API编号

name

否

String

API名称

group_id

否

String

API分组编号

req_protocol

否

String

请求协议

req_method

否

String

请求方法

req_uri

否

String

请求路径

auth_type

否

String

授权类型

env_id

否

String

发布的环境编号

type

否

Integer

API类型

precise_search

否

String

指定需要精确匹配查找的参数名称，目前仅支持name、req_uri

vpc_channel_name

否

String

负载通道名称

return_data_mode

否

String

指定API详情中需要包含的额外返回结果，多个参数之间使用“,”隔开，当brief和其他include参数共同使用时，brief不生效。

目前仅支持brief，include_group，include_group_backend。

brief：默认值，不包含额外信息。

include_group：返回结果中包含api_group_info。

include_group_backend：返回结果中包含backend_api。

缺省值：brief

tags

否

String

API标签，该参数可指定多个，多个不同的参数值为或关系；不指定或为空时，表示不筛选标签；指定为#no_tags#时，表示筛选无标签API。

最小长度：0

最大长度：128

X-Auth-Token

是

String

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

size

Integer

本次返回的列表长度

total

Long

满足条件的记录数

apis

Array of ApiInfoPerPage objects

本次查询到的API列表

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
• GRPCS

缺省值：HTTPS

req_method

String

API的请求方式，当API的请求协议为GRPC类型协议时请求方式固定为POST。

req_uri

String

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

auth_type

String

API的认证方式

• NONE：无认证
• APP：APP认证
• IAM：IAM认证
• AUTHORIZER：自定义认证，当auth_type取值为AUTHORIZER时，authorizer_id字段必须传入

auth_opt

AuthOpt object

认证方式参数

cors

Boolean

是否支持跨域

• TRUE：支持
• FALSE：不支持

缺省值：false

match_mode

String

API的匹配方式

• SWA：前缀匹配
• NORMAL：正常匹配（绝对匹配）

  默认：NORMAL

backend_type

String

后端类型

• HTTP：web后端
• FUNCTION：函数工作流，当backend_type取值为FUNCTION时，func_info字段必须传入
• MOCK：模拟的后端，当backend_type取值为MOCK时，mock_info字段必须传入
• GRPC：grpc后端

remark

String

API描述。字符长度不超过255

group_id

String

API所属的分组编号

body_remark

String

API请求体描述，可以是请求体示例、媒体类型、参数等信息。字符长度不超过20480

result_normal_sample

String

正常响应示例，描述API的正常返回信息。字符长度不超过20480

当API的请求协议为GRPC类型时不支持配置。

result_failure_sample

String

失败返回示例，描述API的异常返回信息。字符长度不超过20480

当API的请求协议为GRPC类型时不支持配置。

authorizer_id

String

前端自定义认证对象的ID

tags

Array of strings

标签。

支持英文，数字，中文，特殊符号（-*#%.:_），且只能以中文或英文开头。

默认支持10个标签，如需扩大配额请联系技术工程师修改API_TAG_NUM_LIMIT配置。

最小长度：1

最大长度：128

response_id

String

分组自定义响应ID

roma_app_id

String

集成应用ID

暂不支持

domain_name

String

API绑定的自定义域名

暂不支持

tag

String

标签

待废弃，优先使用tags字段

content_type

String

请求内容格式类型：

application/json

application/xml

multipart/form-data

text/plain

is_send_fg_body_base64

Boolean

是否对与FunctionGraph交互场景的body进行Base64编码。仅当content_type为application/json时，可以不对body进行Base64编码。

应用场景：

• 自定义认证
• 绑定断路器插件，且断路器后端降级策略为函数后端
• API后端类型为函数工作流

缺省值：true

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所属分组的版本

默认V1，其他版本暂不支持

缺省值：V1

run_env_id

String

发布的环境编号

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

run_env_name

String

发布的环境名称

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

publish_id

String

发布记录编号

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

publish_time

String

发布时间

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

roma_app_name

String

API归属的集成应用名称

暂不支持

ld_api_id

String

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

暂不支持

backend_api

BackendApi object

后端信息

api_group_info

ApiGroupCommonInfo object

api分组信息

req_params

Array of ReqParam objects

API的请求参数列表

app_code_auth_type

String

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

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

缺省值：DISABLE

authorizer_id

String

后端自定义认证对象的ID

url_domain

String

后端服务的地址。

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

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

req_protocol

String

请求协议，后端类型为GRPC时请求协议可选GRPC、GRPCS

remark

String

描述。字符长度不超过255

req_method

String

请求方式，后端类型为GRPC时请求方式固定为POST

version

String

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

req_uri

String

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

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

后端类型为GRPC时请求地址固定为/

timeout

Integer

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

单位：毫秒。

最小值：1

enable_client_ssl

Boolean

是否开启双向认证

retry_count

String

请求后端服务的重试次数，默认为-1，范围[-1,10]。

当该值为-1时，幂等的接口会重试1次，非幂等的不会重试。POST，PATCH方法为非幂等；GET，HEAD，PUT，OPTIONS和DELETE等方法为幂等的。

缺省值：-1

enable_sm_channel

Boolean

是否启用SM商密通道。

仅实例支持SM系列商密算法的实例时支持开启。

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

String

云服务器名称

cascade_flag

Boolean

是否使用级联方式

暂不支持

vpc_channel_proxy_host

String

代理主机

vpc_channel_id

String

VPC通道编号

vpc_channel_port

Integer

VPC通道端口

id

String

编号

name

String

API分组名称

status

Integer

状态

• 1： 有效

sl_domain

String

系统默认分配的子域名

register_time

String

创建时间

update_time

String

最近修改时间

on_sell_status

Integer

是否已上架云商店：

• 1：已上架
• 2：未上架
• 3：审核中

暂不支持

url_domains

Array of UrlDomain objects

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

sl_domain_access_enabled

Boolean

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

缺省值：true

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

ingress_http_port

Integer

访问该域名绑定的http协议入方向端口，-1表示无端口且协议不支持，可使用80默认端口，其他有效端口允许的取值范围为1024~49151，需为实例已开放的HTTP协议的自定义入方向端口。

当创建域名时，该参数未填表示用默认80端口；如果填写该参数，则必须同时填写https_port；如果要http_port和https_port同时使用默认端口，则两个参数都不填。

当修改域名时，该参数未填表示不修改该端口。

最小值：-1

最大值：49151

ingress_https_port

Integer

访问该域名绑定的https协议入方向端口，-1表示无端口且协议不支持，可使用443默认端口，其他有效端口允许的取值范围为1024~49151，需为实例已开放的HTTPS协议的自定义入方向端口。

当创建域名时，该参数未填表示用默认443端口；如果填写该参数，则必须同时填写http_port；如果要http_port和https_port同时使用默认端口，则两个参数都不填。

当修改域名时，该参数未填表示不修改该端口。

最小值：-1

最大值：49151

ssl_infos

Array of SslInfo objects

SSL证书列表。

ssl_id

String

SSL证书编号。

ssl_name

String

SSL证书名称。

algorithm_type

String

证书算法类型：

• RSA
• ECC
• SM2

type

String

证书可见范围：

• instance：当前实例
• global：全局

缺省值：global

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：不开启校验

缺省值：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：否

orchestrations

Array of strings

请求参数匹配编排规则的生效优先级与列表顺序保持一致，列表中靠前的配置匹配优先级较高；

如果编排规则列表中包含none_value类型的规则，则none_value类型的规则优先级最高，至多绑定一个none_value类型的规则；

如果编排规则列表中包含default类型的规则，则default类型的规则优先级最低，至多绑定一个default类型的规则；

当编排规则为预处理策略时，该规则不能作为除default以外的最后一个编排规则；

每个API仅允许选择一个参数绑定编排规则，且编排规则不能重复，支持绑定的编排规则数量有配额限制，具体请参见产品介绍的“约束与限制”章节。

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

400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal Server Error