文档首页/ 应用与数据集成平台 ROMA Connect/ API参考/ 服务集成API/ API管理/ 查询API列表

更新时间：2024-07-03 GMT+08:00

在线调试

CLI示例

查看PDF

查询API列表

功能介绍

查看API列表，返回API详细信息、发布信息等，但不能查看到后端服务信息和API请求参数信息。

URI

GET /v2/{project_id}/apic/instances/{instance_id}/apis

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	项目ID，获取方式请参见API参考的“附录 > 获取项目ID”章节。
instance_id	是	String	实例ID

表2 Query参数
参数	是否必选	参数类型	描述
offset	否	Long	偏移量，表示从此偏移量开始查询，偏移量小于0时，自动转换为0 缺省值：0
limit	否	Integer	每页显示的条目数量最小值：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。
vpc_channel_id	否	String	负载通道编号
vpc_channel_name	否	String	负载通道名称。
roma_app_name	否	String	集成应用名称
roma_app_id	否	String	集成应用编号

请求参数

表3 请求Header参数
参数	是否必选	参数类型	描述
X-Auth-Token	是	String	用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。

响应参数

状态码： 200

表4 响应Body参数
参数	参数类型	描述
size	Integer	本次返回的列表长度
total	Long	满足条件的记录数
apis	Array of ApiInfoPerPage objects	本次查询到的API列表

表5 ApiInfoPerPage
参数	参数类型	描述
name	String	API名称。支持汉字、英文、数字、中划线、下划线、点、斜杠、中英文格式下的小括号和冒号、中文格式下的顿号，且只能以英文、汉字和数字开头。说明：中文字符必须为UTF-8或者unicode编码。最小长度：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规范。 /apic/health_check为服务集成预置的健康检查路径，当req_method=GET时不支持req_uri=/apic/health_check。说明：需要服从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描述。不允许带有<、>字符说明：中文字符必须为UTF-8或者unicode编码。最小长度：0 最大长度：1000
group_id	String	API所属的分组编号最小长度：1 最大长度：65
body_remark	String	API请求体描述，可以是请求体示例、媒体类型、参数等信息。说明：中文字符必须为UTF-8或者unicode编码。最大长度：20480
result_normal_sample	String	正常响应示例，描述API的正常返回信息。说明：中文字符必须为UTF-8或者unicode编码。最大长度：20480
result_failure_sample	String	失败返回示例，描述API的异常返回信息。说明：中文字符必须为UTF-8或者unicode编码。最大长度：20480
authorizer_id	String	前端自定义认证对象的ID 最小长度：1 最大长度：65
tags	Array of strings	标签。支持英文、数字、中文、特殊符号（-#%.:_），且只能以中文或英文开头。默认支持10个标签，如需扩大配额请联系技术工程师修改API_TAG_NUM_LIMIT配置。最小长度：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
content_type	String	请求内容格式类型： application/json application/xml multipart/form-data text/plain
id	String	API编号
status	Integer	API状态 1：有效 2: 锁定
arrange_necessary	Integer	是否需要编排：1,是;2,否
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	发布记录编号存在多个发布记录时，发布记录编号之间用\|隔开
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的请求参数列表

表6 AuthOpt
参数	参数类型	描述
app_code_auth_type	String	AppCode简易认证类型，仅在auth_type为APP时生效，默认为DISABLE： DISABLE：不开启简易认证 HEADER：开启简易认证且AppCode位置在HEADER 缺省值：DISABLE

表7 BackendApi
参数	参数类型	描述
authorizer_id	String	后端自定义认证对象的ID
url_domain	String	后端服务的地址。不使用VPC通道时，url_domain为必填。由主机（IP或域名）和端口号组成，总长度不超过255。格式为主机:端口（如：apig.example.com:7443）。如果不写端口，则HTTPS默认端口号为443，HTTP默认端口号为80。支持环境变量，使用环境变量时，每个变量名的长度为3 ~ 32位的字符串，字符串由英文字母、数字、下划线、中划线组成，且只能以英文开头
req_protocol	String	请求协议
remark	String	描述。说明：中文字符必须为UTF-8或者unicode编码。最大长度：255
req_method	String	请求方式
version	String	web后端版本，字符长度不超过16
req_uri	String	请求地址。可以包含请求参数，用{}标识，比如/getUserInfo/{userId}，支持 * / %- _ .等特殊字符，总长度不超过512，且满足URI规范。支持环境变量，使用环境变量时，每个变量名的长度为3 ~ 32位的字符串，字符串由英文字母、数字、中划线、下划线组成，且只能以英文开头。说明：需要服从URI规范。
timeout	Integer	服务集成请求后端服务的超时时间。最大超时时间可通过实例特性backend_timeout配置修改，可修改的上限为600000 单位：毫秒。最小值：1
enable_client_ssl	Boolean	是否开启双向认证
retry_count	String	服务集成请求后端服务的重试次数，默认为-1，范围[-1,10] 缺省值：-1
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通道

表8 VpcInfo
参数	参数类型	描述
ecs_id	String	云服务器ID
ecs_name	String	云服务器名称
cascade_flag	Boolean	是否使用级联方式暂不支持
vpc_channel_proxy_host	String	代理主机
vpc_channel_id	String	VPC通道编号最大长度：64
vpc_channel_port	Integer	VPC通道端口

表9 ApiGroupCommonInfo
参数	参数类型	描述
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	分组上绑定的独立域名列表

**表10** 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证书列表

**表11** SslInfo
参数	参数类型	描述
ssl_id	String	SSL证书编号
ssl_name	String	SSL证书名称
algorithm_type	String	证书算法类型： RSA ECC SM2
type	String	证书可见范围： instance：当前实例 global：全局缺省值：global

**表12** ReqParam
参数	参数类型	描述
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	描述信息。说明：中文字符必须为UTF-8或者unicode编码。最大长度：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类型的规则；每个API仅允许选择一个参数绑定编排规则，且编排规则不能重复，支持绑定的编排规则数量有配额限制，具体请参见产品介绍的“配额说明”章节
id	String	参数编号

状态码： 400

**表13** 响应Body参数
参数	参数类型	描述
error_code	String	错误码
error_msg	String	错误描述

状态码： 401

**表14** 响应Body参数
参数	参数类型	描述
error_code	String	错误码
error_msg	String	错误描述

状态码： 403

**表15** 响应Body参数
参数	参数类型	描述
error_code	String	错误码
error_msg	String	错误描述

状态码： 404

**表16** 响应Body参数
参数	参数类型	描述
error_code	String	错误码
error_msg	String	错误描述

状态码： 500

**表17** 响应Body参数
参数	参数类型	描述
error_code	String	错误码
error_msg	String	错误描述

请求示例

无

响应示例

状态码： 200

{
  "total" : 1,
  "size" : 1,
  "apis" : [ {
    "name" : "Api_http",
    "type" : 1,
    "version" : "V0.0.1",
    "req_protocol" : "HTTPS",
    "req_method" : "GET",
    "req_uri" : "/test/http",
    "auth_type" : "AUTHORIZER",
    "auth_opt" : {
      "app_code_auth_type" : "DISABLE"
    },
    "cors" : false,
    "match_mode" : "NORMAL",
    "backend_type" : "HTTP",
    "remark" : "Web backend API",
    "group_id" : "c77f5e81d9cb4424bf704ef2b0ac7600",
    "body_remark" : "",
    "result_normal_sample" : "",
    "result_failure_sample" : "",
    "authorizer_id" : "8d0443832a194eaa84244e0c1c1912ac",
    "tags" : [ "webApi" ],
    "roma_app_id" : "f37f5e81d9cb4424bf704ef2b0ac7600",
    "domain_name" : "",
    "id" : "5f918d104dc84480a75166ba99efff21",
    "status" : 1,
    "arrange_necessary" : 2,
    "register_time" : "2020-07-31T12:42:51Z",
    "update_time" : "2020-08-02T16:32:47.046289Z",
    "group_name" : "api_group_001",
    "group_version" : "V1",
    "run_env_name" : "RELEASE",
    "run_env_id" : "DEFAULT_ENVIRONMENT_RELEASE_ID",
    "publish_id" : "6f918d104dc84480a75166ba99efff41",
    "publish_time" : "2020-07-31 12:42:51",
    "roma_app_name" : "roma-3xfg",
    "ld_api_id" : "",
    "backend_api" : null,
    "api_group_info" : null,
    "req_params" : null
  } ]
}

状态码： 400

Bad Request

{
  "error_code" : "APIG.2012",
  "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"
}

状态码

状态码	描述
200	OK
400	Bad Request
401	Unauthorized
403	Forbidden
404	Not Found
500	Internal Server Error

错误码

请参见错误码。

父主题： API管理

上一篇：查询API详情

下一篇：批量发布或下线API

意见反馈

文档内容是否对您有帮助？

有帮助没帮助

提供反馈

提交成功！非常感谢您的反馈，我们会继续努力做到更好！

系统繁忙，请稍后重试

在使用文档中是否遇到以下问题

内容与产品页面不一致

内容不易理解

缺失示例代码

步骤不可操作

搜不到想要的内容

缺少最佳实践

意见反馈（选填）

0/500

请至少选择一项反馈信息并填写问题反馈

字符长度不能超过500

直接提交取消