本文导读

展开导读

文档首页/ 应用与数据集成平台 ROMA Connect/ API参考（阿布扎比区域）/ 服务集成API/ API管理/ 查询API运行时定义

查询API运行时定义

更新时间：2022-12-05 GMT+08:00

查看PDF

功能介绍

查看指定的API在指定的环境上的运行时定义，默认查询RELEASE环境上的运行时定义。

API的定义分为临时定义和运行时定义，分别代表如下含义：

临时定义：API在编辑中的定义，表示用户最后一次编辑后的API的状态
运行时定义：API在发布到某个环境时，对发布时的API的临时定义进行快照，固化出来的API的状态。

访问某个环境上的API，其实访问的就是其运行时的定义

URI

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

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

表2 Query参数
参数	是否必选	参数类型	描述
env_id	否	String	API的发布环境编号

请求参数

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

响应参数

状态码： 200

表4 响应Body参数
参数	参数类型	描述
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规范。说明：需要服从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	标签。支持英文，数字，下划线，且只能以英文开头。支持输入多个标签，不同标签以英文逗号分割。最小长度：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编号
group_name	String	API所属分组的名称
run_env_name	String	发布的环境名
run_env_id	String	发布的环境id
publish_id	String	发布记录的编号
sl_domain	String	分组的二级域名
sl_domains	Array of strings	系统默认分配的子域名列表
req_params	Array of ReqParam objects	API的请求参数列表

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

表6 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：不开启校验
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：否
id	String	参数编号

状态码： 401

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

状态码： 403

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

状态码： 404

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

状态码： 500

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

请求示例

无

响应示例

状态码： 200

{
  "name" : "Api_http",
  "type" : 1,
  "version" : "V0.0.1",
  "req_protocol" : "HTTPS",
  "req_method" : "GET",
  "req_uri" : "/test/http",
  "auth_type" : "AUTHORIZER",
  "authorizer_id" : "8d0443832a194eaa84244e0c1c1912ac",
  "auth_opt" : {
    "app_code_auth_type" : "DISABLE"
  },
  "cors" : false,
  "match_mode" : "NORMAL",
  "backend_type" : "HTTP",
  "remark" : "Web backend Api",
  "group_id" : "c77f5e81d9cb4424bf704ef2b0ac7600",
  "result_normal_sample" : "Normal response example",
  "result_failure_sample" : "Failure response example",
  "id" : "5f918d104dc84480a75166ba99efff21",
  "group_name" : "api_group_001",
  "run_env_id" : "DEFAULT_ENVIRONMENT_RELEASE_ID",
  "run_env_name" : "RELEASE",
  "publish_id" : "9191cdb430724d4b8586ed7f1b962ca2",
  "sl_domain" : "c77f5e81d9cb4424bf704ef2b0ac7600.apic.****.com",
  "sl_domains" : [ "c77f5e81d9cb4424bf704ef2b0ac7600.apic.****.com", "c77f5e81d9cb4424bf704ef2b0ac7600.apic.****.cn" ]
}

状态码： 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.3002",
  "error_msg" : "API 5f918d104dc84480a75166ba99efff21 does not exist"
}

状态码： 500

Internal Server Error

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

状态码

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

错误码

请参见错误码。

父主题： API管理

上一篇：查询API历史版本列表

下一篇：校验API定义

意见反馈

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

有帮助没帮助

提供反馈

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

系统繁忙，请稍后重试

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

内容与产品页面不一致

内容不易理解

缺失示例代码

步骤不可操作

搜不到想要的内容

缺少最佳实践

意见反馈（选填）

0/500

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

字符长度不能超过500

直接提交取消