文档首页/ API网关 APIG/ API参考（吉隆坡区域）/ 专享版API（V2）/ 专享版-API管理/ 查询API详情

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

在线调试

CLI示例

查看PDF

查询API详情

功能介绍

查看指定的API的详细信息。

调用方法

请参见如何调用API。

URI

GET /v2/{project_id}/apigw/instances/{instance_id}/apis/{api_id}

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	项目ID，获取方式请参见获取项目ID。
instance_id	是	String	实例ID，在API网关控制台的“实例信息”中获取。
api_id	是	String	API的编号

请求参数

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

响应参数

状态码： 200

表3 响应Body参数
参数	参数类型	描述
name	String	API名称。支持汉字、英文、数字、中划线、下划线、点、斜杠、中英文格式下的小括号和冒号、中文格式下的顿号，且只能以英文、汉字和数字开头，3-255个字符。说明：中文字符必须为UTF-8或者unicode编码。
type	Integer	API类型 1：公有API 2：私有API 枚举值： 1 2
version	String	API的版本最大长度：16
req_protocol	String	API的请求协议 HTTP HTTPS BOTH：同时支持HTTP和HTTPS GRPCS 缺省值：HTTPS 枚举值： HTTP HTTPS BOTH GRPCS
req_method	String	API的请求方式，当API的请求协议为GRPC类型协议时请求方式固定为POST。枚举值： GET POST PUT DELETE HEAD PATCH OPTIONS ANY
req_uri	String	请求地址。可以包含请求参数，用{}标识，比如/getUserInfo/{userId}，支持 * / %- _ . 等特殊字符，总长度不超过512，且满足URI规范。说明：需要服从URI规范。
auth_type	String	API的认证方式 NONE：无认证 APP：APP认证 IAM：IAM认证 AUTHORIZER：自定义认证，当auth_type取值为AUTHORIZER时，authorizer_id字段必须传入当API的请求协议为GRPC类型时不支持自定义认证。枚举值： NONE APP IAM AUTHORIZER
auth_opt	AuthOpt object	认证方式参数
cors	Boolean	是否支持跨域 TRUE：支持 FALSE：不支持缺省值：false 枚举值： true false
match_mode	String	API的匹配方式 SWA：前缀匹配 NORMAL：正常匹配（绝对匹配）默认：NORMAL 枚举值： SWA NORMAL
backend_type	String	后端类型 HTTP：web后端 FUNCTION：函数工作流，当backend_type取值为FUNCTION时，func_info字段必须传入 MOCK：模拟的后端，当backend_type取值为MOCK时，mock_info字段必须传入 GRPC：grpc后端枚举值： HTTP FUNCTION MOCK GRPC
remark	String	API描述。字符长度不超过255 说明：中文字符必须为UTF-8或者unicode编码。
group_id	String	API所属的分组编号
body_remark	String	API请求体描述，可以是请求体示例、媒体类型、参数等信息。字符长度不超过20480 说明：中文字符必须为UTF-8或者unicode编码。
result_normal_sample	String	正常响应示例，描述API的正常返回信息。字符长度不超过20480 说明：中文字符必须为UTF-8或者unicode编码。当API的请求协议为GRPC类型时不支持配置。
result_failure_sample	String	失败返回示例，描述API的异常返回信息。字符长度不超过20480 说明：中文字符必须为UTF-8或者unicode编码。当API的请求协议为GRPC类型时不支持配置。
authorizer_id	String	前端自定义认证对象的ID，API请求协议为GRPC类型时不支持前端自定义认证
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 暂不支持枚举值： application/json application/xml multipart/form-data text/plain
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	web后端详情
api_group_info	ApiGroupCommonInfo object	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策略后端列表
policy_https	Array of ApiPolicyHttpResp objects	web策略后端列表

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

表5 BackendApi
参数	参数类型	描述
authorizer_id	String	后端自定义认证对象的ID，后端类型为GRPC时不支持后端自定义认证
url_domain	String	后端服务的地址。由主机（IP或域名）和端口号组成，总长度不超过255。格式为主机:端口（如：apig.example.com:7443）。如果不写端口，则HTTPS默认端口号为443，HTTP默认端口号为80。支持环境变量，使用环境变量时，每个变量名的长度为3 ~ 32位的字符串，字符串由英文字母、数字、下划线、中划线组成，且只能以英文开头
req_protocol	String	请求协议，后端类型为GRPC时请求协议可选GRPCS 枚举值： HTTP HTTPS GRPCS
remark	String	描述。字符长度不超过255 说明：中文字符必须为UTF-8或者unicode编码。
req_method	String	请求方式，后端类型为GRPC时请求方式固定为POST 枚举值： GET POST PUT DELETE HEAD PATCH OPTIONS ANY
version	String	web后端版本，字符长度不超过16
req_uri	String	请求地址。可以包含请求参数，用{}标识，比如/getUserInfo/{userId}，支持 * / %- _ . 等特殊字符，总长度不超过512，且满足URI规范。支持环境变量，使用环境变量时，每个变量名的长度为3 ~ 32位的字符串，字符串由英文字母、数字、中划线、下划线组成，且只能以英文开头。说明：需要服从URI规范。后端类型为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
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通道

表6 ApiGroupCommonInfo
参数	参数类型	描述
id	String	编号
name	String	API分组名称
status	Integer	状态 1：有效枚举值： 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

表7 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 枚举值： TLSv1.1 TLSv1.2
verified_client_certificate_enabled	Boolean	是否开启客户端证书校验。只有绑定证书时，该参数才生效。当绑定证书存在trusted_root_ca时，默认开启；当绑定证书不存在trusted_root_ca时，默认关闭。缺省值：false
is_has_trusted_root_ca	Boolean	是否存在信任的根证书CA。当绑定证书存在trusted_root_ca时为true。缺省值：false

表8 ApiFunc
参数	参数类型	描述
function_urn	String	函数URN
remark	String	描述信息。长度不超过255个字符说明：中文字符必须为UTF-8或者unicode编码。
invocation_type	String	调用类型 async：异步 sync：同步枚举值： async sync
network_type	String	对接函数的网络架构类型 V1：非VPC网络架构 V2：VPC网络架构枚举值： V1 V2
version	String	函数版本当函数别名URN和函数版本同时传入时，函数版本将被忽略，只会使用函数别名URN 最大长度：64
alias_urn	String	函数别名URN 当函数别名URN和函数版本同时传入时，函数版本将被忽略，只会使用函数别名URN
timeout	Integer	API网关请求后端服务的超时时间。函数网络架构为V1时最大超时时间为60000，V2最大超时时间可通过实例特性backend_timeout配置修改，可修改的上限为600000。单位：毫秒。最小值：1
authorizer_id	String	后端自定义认证ID
req_protocol	String	函数后端的请求协议：HTTPS、GRPCS，默认值为HTTPS，前端配置中的请求协议为GRPCS时可选GRPCS。缺省值：HTTPS 枚举值： HTTPS GRPCS
id	String	编号
register_time	String	注册时间
status	Integer	后端状态 1：有效
update_time	String	修改时间

表9 ApiMock
参数	参数类型	描述
remark	String	描述信息。长度不超过255个字符说明：中文字符必须为UTF-8或者unicode编码。
result_content	String	返回结果
version	String	版本。字符长度不超过64
authorizer_id	String	后端自定义认证ID
id	String	编号
register_time	String	注册时间
status	Integer	后端状态 1：有效
update_time	String	修改时间

**表10** ReqParam
参数	参数类型	描述
name	String	参数名称。长度为1 ~ 32位的字符串，字符串由英文字母、数字、中划线、下划线、英文句号组成，且只能以英文开头。
type	String	参数类型枚举值： STRING NUMBER
location	String	参数位置枚举值： PATH QUERY HEADER
default_value	String	参数默认值
sample_value	String	参数示例值
required	Integer	是否必须 1：是 2：否 location为PATH时，required默认为1，其他场景required默认为2 枚举值： 1 2
valid_enable	Integer	是否开启校验 1：开启校验 2：不开启校验缺省值：2 枚举值： 1 2
remark	String	描述信息。长度不超过255个字符说明：中文字符必须为UTF-8或者unicode编码。
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：否枚举值： 1 2
id	String	参数编号

**表11** ApiPolicyFunctionResp
参数	参数类型	描述
function_urn	String	函数URN
invocation_type	String	调用类型 async：异步 sync：同步枚举值： async sync
network_type	String	对接函数的网络架构类型 V1：非VPC网络架构 V2：VPC网络架构枚举值： V1 V2
version	String	函数版本当函数别名URN和函数版本同时传入时，函数版本将被忽略，只会使用函数别名URN 最大长度：64
alias_urn	String	函数别名URN 当函数别名URN和函数版本同时传入时，函数版本将被忽略，只会使用函数别名URN
timeout	Integer	API网关请求后端服务的超时时间。函数网络架构为V1时最大超时时间为60000，V2最大超时时间可通过实例特性backend_timeout配置修改，可修改的上限为600000。单位：毫秒。最小值：1
req_protocol	String	函数后端的请求协议：HTTPS、GRPCS，默认值为HTTPS，前端配置中的请求协议为GRPCS时可选GRPCS。缺省值：HTTPS 枚举值： HTTPS GRPCS
id	String	编号
effect_mode	String	关联的策略组合模式： ALL：满足全部条件 ANY：满足任一条件枚举值： ALL ANY
name	String	策略后端名称。字符串由中文、英文字母、数字、下划线组成，且只能以中文或英文开头。最小长度：3 最大长度：64
backend_params	Array of BackendParam objects	后端参数列表
conditions	Array of CoditionResp objects	策略条件列表
authorizer_id	String	后端自定义认证对象的ID

**表12** ApiPolicyMockResp
参数	参数类型	描述
id	String	编号
effect_mode	String	关联的策略组合模式： ALL：满足全部条件 ANY：满足任一条件枚举值： ALL ANY
name	String	策略后端名称。字符串由中文、英文字母、数字、下划线组成，且只能以中文或英文开头。最小长度：3 最大长度：64
backend_params	Array of BackendParam objects	后端参数列表
conditions	Array of CoditionResp objects	策略条件列表
authorizer_id	String	后端自定义认证对象的ID
result_content	String	返回结果

**表13** ApiPolicyHttpResp
参数	参数类型	描述
id	String	编号
effect_mode	String	关联的策略组合模式： ALL：满足全部条件 ANY：满足任一条件枚举值： ALL ANY
name	String	策略后端名称。字符串由中文、英文字母、数字、下划线组成，且只能以中文或英文开头。最小长度：3 最大长度：64
backend_params	Array of BackendParam objects	后端参数列表
conditions	Array of CoditionResp objects	策略条件列表
authorizer_id	String	后端自定义认证对象的ID
url_domain	String	策略后端的Endpoint。由域名（或IP地址）和端口号组成，总长度不超过255。格式为域名:端口（如：apig.example.com:7443）。如果不写端口，则HTTPS默认端口号为443， HTTP默认端口号为80。支持环境变量，使用环境变量时，每个变量名的长度为3 ~ 32位的字符串，字符串由英文字母、数字、“_”、“-”组成，且只能以英文开头。
req_protocol	String	请求协议：HTTP、HTTPS、GRPCS，后端类型为GRPC时可选GRPCS 枚举值： HTTP HTTPS GRPCS
req_method	String	请求方式：GET、POST、PUT、DELETE、HEAD、PATCH、OPTIONS、ANY，后端类型为GRPC时固定为POST 枚举值： GET POST PUT DELETE HEAD PATCH OPTIONS ANY
req_uri	String	请求地址。可以包含请求参数，用{}标识，比如/getUserInfo/{userId}，支持 * / %- _ . 等特殊字符，总长度不超过512，且满足URI规范。支持环境变量，使用环境变量时，每个变量名的长度为3 ~ 32位的字符串，字符串由英文字母、数字、中划线、下划线组成，且只能以英文开头。说明：需要服从URI规范。后端类型为GRPC时请求地址固定为/
timeout	Integer	API网关请求后端服务的超时时间。最大超时时间可通过实例特性backend_timeout配置修改，可修改的上限为600000。单位：毫秒。最小值：1
retry_count	String	请求后端服务的重试次数，默认为-1，范围[-1,10]。当该值为-1时，幂等的接口会重试1次，非幂等的不会重试。POST，PATCH方法为非幂等；GET，HEAD，PUT，OPTIONS和DELETE等方法为幂等的。缺省值：-1
vpc_channel_info	VpcInfo object	VPC通道详情。如果vpc_channel_status = 1，则这个object类型为必填信息
vpc_channel_status	Integer	是否使用VPC通道： 1：使用VPC通道 2：不使用VPC通道

**表14** BackendParam
参数	参数类型	描述
origin	String	参数类别：后端服务参数：REQUEST 常量参数：CONSTANT 系统参数：SYSTEM 枚举值： REQUEST CONSTANT SYSTEM
name	String	参数名称。字符串由英文字母、数字、中划线、下划线、英文句号组成，且只能以英文开头。最小长度：1 最大长度：32
remark	String	描述。字符长度不超过255 说明：中文字符必须为UTF-8或者unicode编码。
location	String	参数位置：PATH、QUERY、HEADER 枚举值： PATH QUERY HEADER
value	String	参数值。字符长度不超过255 origin类别为REQUEST时，此字段值为req_params中的参数名称； origin类别为CONSTANT时，此字段值为参数真正的值； origin类别为SYSTEM时，此字段值为系统参数名称，系统参数分为网关内置参数、前端认证参数和后端认证参数，当api前端安全认证方式为自定义认证时，可以填写前端认证参数，当api开启后端认证时，可以填写后端认证参数。网关内置参数取值及对应含义： $context.sourceIp：API调用者的源地址 $context.stage：API调用的部署环境 $context.apiId：API的ID $context.appId：API调用者的APP对象ID $context.requestId：当次API调用生成请求ID $context.serverAddr：网关的服务器地址 $context.serverName：网关的服务器名称 $context.handleTime：本次API调用的处理时间 $context.providerAppId：API拥有者的应用对象ID，暂不支持使用前端认证参数取值：以“$context.authorizer.frontend.”为前缀，如希望自定义认证校验通过返回的参数为aaa，那么此字段填写为$context.authorizer.frontend.aaa 后端认证参数取值：以“$context.authorizer.backend.”为前缀，如希望自定义认证校验通过返回的参数为aaa，那么此字段填写为$context.authorizer.backend.aaa
id	String	参数编号
req_param_id	String	对应的请求参数编号

**表15** CoditionResp
参数	参数类型	描述
req_param_name	String	关联的请求参数对象名称。策略类型为param时必选
sys_param_name	String	系统参数-网关内置参数名称。策略类型为system时必选。支持以下参数 req_path：请求路径。如 /a/b req_method：请求方法。如 GET reqPath：请求路径，废弃。如 /a/b reqMethod：请求方法，废弃。如 GET 枚举值： req_path req_method reqPath reqMethod
cookie_param_name	String	COOKIE参数名称。策略类型为cookie时必选最小长度：0 最大长度：255
frontend_authorizer_param_name	String	系统参数-前端认证参数名称。策略类型为frontend_authorizer时必选，前端认证参数名称以"$context.authorizer.frontend."字符串为前缀。例如，前端认证参数名称为user_name，加上前缀为$context.authorizer.frontend.user_name。
condition_type	String	策略条件 exact：绝对匹配 enum：枚举 pattern：正则策略类型为param，system，cookie，frontend_authorizer时必选枚举值： exact enum pattern
condition_origin	String	策略类型 param：参数 source：源IP system: 系统参数-网关内置参数 cookie: COOKIE参数 frontend_authorizer: 系统参数-前端认证参数枚举值： param source system cookie frontend_authorizer
condition_value	String	策略值。策略类型为param，source，cookie，frontend_authorizer时必填
id	String	编号
req_param_id	String	关联的请求参数对象编号
req_param_location	String	关联的请求参数对象位置

**表16** VpcInfo
参数	参数类型	描述
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通道端口

状态码： 401

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

状态码： 403

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

状态码： 404

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

状态码： 500

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

请求示例

无

响应示例

状态码： 200

{
  "id" : "5f918d104dc84480a75166ba99efff21",
  "tags" : [ "webApi" ],
  "arrange_necessary" : 2,
  "backend_type" : "HTTP",
  "auth_type" : "AUTHORIZER",
  "auth_opt" : {
    "app_code_auth_type" : "DISABLE"
  },
  "authorizer_id" : "8d0443832a194eaa84244e0c1c1912ac",
  "backend_api" : {
    "update_time" : "2020-08-02T16:32:47.077029Z",
    "vpc_channel_status" : 1,
    "vpc_channel_info" : {
      "vpc_channel_id" : "56a7d7358e1b42459c9d730d65b14e59",
      "vpc_channel_proxy_host" : "www.example.com"
    },
    "url_domain" : "56a7d7358e1b42459c9d730d65b14e59",
    "req_protocol" : "HTTPS",
    "id" : "1ce8fda3586d4371bd83c955df37e102",
    "req_method" : "GET",
    "register_time" : "2020-07-31T12:42:51Z",
    "req_uri" : "/test/benchmark",
    "timeout" : 5000,
    "status" : 1,
    "retry_count" : "-1"
  },
  "cors" : false,
  "status" : 1,
  "group_name" : "api_group_001",
  "group_id" : "c77f5e81d9cb4424bf704ef2b0ac7600",
  "group_version" : "V1",
  "match_mode" : "NORMAL",
  "name" : "Api_http",
  "req_protocol" : "HTTPS",
  "req_method" : "GET",
  "req_uri" : "/test/http",
  "type" : 1,
  "version" : "V0.0.1",
  "result_normal_sample" : "Example success response",
  "result_failure_sample" : "Example failure response",
  "register_time" : "2020-07-31T12:42:51Z",
  "update_time" : "2020-08-02T16:32:47.046289Z",
  "remark" : "Web backend API",
  "backend_params" : [ {
    "name" : "X-CONSTANT-HEADER",
    "value" : "demo",
    "location" : "HEADER",
    "origin" : "CONSTANT",
    "remark" : "constant_demo",
    "id" : "8cb2eba19e7a4423a4e835647a8b8d76"
  }, {
    "name" : "app-id",
    "value" : "$context.appId",
    "location" : "HEADER",
    "origin" : "SYSTEM",
    "remark" : "App ID of the API caller",
    "id" : "216ddda836e74d528f364ff589d9dd21"
  } ]
}

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

直接提交取消