API网关 APIG-查看版本详情:响应参数
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
name |
String |
API名称。 支持汉字、英文、数字、中划线、下划线、点、斜杠、中英文格式下的小括号和冒号、中文格式下的顿号,且只能以英文、汉字和数字开头,3-255个字符。
说明:
中文字符必须为UTF-8或者unicode编码。 |
type |
Integer |
API类型
|
version |
String |
API的版本 最大长度:16 |
req_protocol |
String |
API的请求协议
缺省值:HTTPS |
req_method |
String |
API的请求方式,当API的请求协议为GRPC类型协议时请求方式固定为POST。 |
req_uri |
String |
请求地址。可以包含请求参数,用{}标识,比如/getUserInfo/{userId},支持 * / %- _ . 等特殊字符,总长度不超过512,且满足URI规范。
说明:
需要服从URI规范。 |
auth_type |
String |
API的认证方式
|
auth_opt |
AuthOpt object |
认证方式参数 |
cors |
Boolean |
是否支持跨域
缺省值:false |
match_mode |
String |
API的匹配方式 |
backend_type |
String |
后端类型
|
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 |
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编码。 应用场景:
缺省值:true |
id |
String |
API编号 |
status |
Integer |
API状态
|
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策略后端列表 |
sl_domain |
String |
系统默认分配的子域名 |
sl_domains |
Array of strings |
系统默认分配的子域名列表 |
version_id |
String |
版本编号 |
参数 |
参数类型 |
描述 |
---|---|---|
app_code_auth_type |
String |
AppCode简易认证类型,仅在auth_type为APP时生效,默认为DISABLE:
缺省值: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
说明:
中文字符必须为UTF-8或者unicode编码。 |
req_method |
String |
请求方式,后端类型为GRPC时请求方式固定为POST |
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 |
enable_sm_channel |
Boolean |
是否启用SM商密通道。 仅实例支持SM系列商密算法的实例时支持开启。 |
id |
String |
编号 |
status |
Integer |
后端状态
|
register_time |
String |
注册时间 |
update_time |
String |
修改时间 |
vpc_channel_info |
VpcInfo object |
VPC通道详情。如果vpc_channel_status = 1,则这个object类型为必填信息 |
vpc_channel_status |
Integer |
是否使用VPC通道
|
参数 |
参数类型 |
描述 |
---|---|---|
id |
String |
编号 |
name |
String |
API分组名称 |
status |
Integer |
状态
|
sl_domain |
String |
系统默认分配的子域名 |
register_time |
String |
创建时间 |
update_time |
String |
最近修改时间 |
on_sell_status |
Integer |
是否已上架云商店:
|
url_domains |
Array of UrlDomain objects |
分组上绑定的独立域名列表 |
sl_domain_access_enabled |
Boolean |
调试域名是否可以访问,true表示可以访问,false表示禁止访问 缺省值:true |
参数 |
参数类型 |
描述 |
---|---|---|
id |
String |
域名编号 |
domain |
String |
访问域名 |
cname_status |
Integer |
域名cname状态:
|
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 |
证书算法类型:
|
type |
String |
证书可见范围:
缺省值:global |
参数 |
参数类型 |
描述 |
---|---|---|
function_urn |
String |
函数URN |
remark |
String |
描述信息。长度不超过255个字符
说明:
中文字符必须为UTF-8或者unicode编码。 |
invocation_type |
String |
调用类型
|
network_type |
String |
对接函数的网络架构类型
|
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 |
id |
String |
编号 |
register_time |
String |
注册时间 |
status |
Integer |
后端状态
|
update_time |
String |
修改时间 |
参数 |
参数类型 |
描述 |
---|---|---|
remark |
String |
描述信息。长度不超过255个字符
说明:
中文字符必须为UTF-8或者unicode编码。 |
result_content |
String |
返回结果 |
version |
String |
版本。字符长度不超过64 |
authorizer_id |
String |
后端自定义认证ID |
id |
String |
编号 |
register_time |
String |
注册时间 |
status |
Integer |
后端状态
|
update_time |
String |
修改时间 |
参数 |
参数类型 |
描述 |
---|---|---|
name |
String |
参数名称。 长度为1 ~ 32位的字符串,字符串由英文字母、数字、中划线、下划线、英文句号组成,且只能以英文开头。 |
type |
String |
参数类型 |
location |
String |
参数位置 |
default_value |
String |
参数默认值 |
sample_value |
String |
参数示例值 |
required |
Integer |
是否必须
location为PATH时,required默认为1,其他场景required默认为2 |
valid_enable |
Integer |
是否开启校验
缺省值: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 |
是否透传
|
orchestrations |
Array of strings |
请求参数匹配编排规则的生效优先级与列表顺序保持一致,列表中靠前的配置匹配优先级较高; 如果编排规则列表中包含none_value类型的规则,则none_value类型的规则优先级最高,至多绑定一个none_value类型的规则; 如果编排规则列表中包含default类型的规则,则default类型的规则优先级最低,至多绑定一个default类型的规则; 当编排规则为预处理策略时,该规则不能作为除default以外的最后一个编排规则; 每个API仅允许选择一个参数绑定编排规则,且编排规则不能重复,支持绑定的编排规则数量有配额限制,具体请参见产品介绍的“约束与限制”章节。 |
id |
String |
参数编号 |
参数 |
参数类型 |
描述 |
---|---|---|
function_urn |
String |
函数URN |
invocation_type |
String |
调用类型
|
network_type |
String |
对接函数的网络架构类型
|
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 |
id |
String |
编号 |
effect_mode |
String |
关联的策略组合模式:
|
name |
String |
策略后端名称。字符串由中文、英文字母、数字、下划线组成,且只能以中文或英文开头。 最小长度:3 最大长度:64 |
backend_params |
Array of BackendParam objects |
后端参数列表 |
conditions |
Array of CoditionResp objects |
策略条件列表 |
authorizer_id |
String |
后端自定义认证对象的ID |
参数 |
参数类型 |
描述 |
---|---|---|
id |
String |
编号 |
effect_mode |
String |
关联的策略组合模式:
|
name |
String |
策略后端名称。字符串由中文、英文字母、数字、下划线组成,且只能以中文或英文开头。 最小长度:3 最大长度:64 |
backend_params |
Array of BackendParam objects |
后端参数列表 |
conditions |
Array of CoditionResp objects |
策略条件列表 |
authorizer_id |
String |
后端自定义认证对象的ID |
result_content |
String |
返回结果 |
参数 |
参数类型 |
描述 |
---|---|---|
id |
String |
编号 |
effect_mode |
String |
关联的策略组合模式:
|
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、GRPC、GRPCS,后端类型为GRPC时可选GRPC、GRPCS |
req_method |
String |
请求方式:GET、POST、PUT、DELETE、HEAD、PATCH、OPTIONS、ANY,后端类型为GRPC时固定为POST |
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 |
enable_sm_channel |
Boolean |
是否启用SM商密通道。 仅实例支持SM系列商密算法的实例时支持开启。 |
vpc_channel_info |
VpcInfo object |
VPC通道详情。如果vpc_channel_status = 1,则这个object类型为必填信息 |
vpc_channel_status |
Integer |
是否使用VPC通道:
|
参数 |
参数类型 |
描述 |
---|---|---|
origin |
String |
参数类别:
|
name |
String |
参数名称。 字符串由英文字母、数字、中划线、下划线、英文句号组成,且只能以英文开头。 最小长度:1 最大长度:32 |
remark |
String |
描述。字符长度不超过255
说明:
中文字符必须为UTF-8或者unicode编码。 |
location |
String |
参数位置:PATH、QUERY、HEADER |
value |
String |
参数值。字符长度不超过255 origin类别为REQUEST时,此字段值为req_params中的参数名称; origin类别为CONSTANT时,此字段值为参数真正的值; origin类别为SYSTEM时,此字段值为系统参数名称,系统参数分为网关内置参数、前端认证参数和后端认证参数,当api前端安全认证方式为自定义认证时,可以填写前端认证参数,当api开启后端认证时,可以填写后端认证参数。 网关内置参数取值及对应含义:
前端认证参数取值:以“$context.authorizer.frontend.”为前缀,如希望自定义认证校验通过返回的参数为aaa,那么此字段填写为$context.authorizer.frontend.aaa 后端认证参数取值:以“$context.authorizer.backend.”为前缀,如希望自定义认证校验通过返回的参数为aaa,那么此字段填写为$context.authorizer.backend.aaa |
id |
String |
参数编号 |
req_param_id |
String |
对应的请求参数编号 |
参数 |
参数类型 |
描述 |
---|---|---|
req_param_name |
String |
关联的请求参数对象名称。策略类型为param时必选 |
sys_param_name |
String |
系统参数-网关内置参数名称。策略类型为system时必选。支持以下参数
|
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 |
策略条件
策略类型为param,system,cookie,frontend_authorizer时必选 |
condition_origin |
String |
策略类型
|
condition_value |
String |
策略值。 最大长度:1024 |
mapped_param_name |
String |
参数编排规则编排后生成的参数名称,当condition_origin为orchestration的时候必填,并且生成的参数名称必须在api绑定的编排规则中存在 |
mapped_param_location |
String |
参数编排规则编排后生成的参数所在的位置,当condition_origin为orchestration的时候必填,并且生成的参数所在的位置必须在api绑定的编排规则中存在 |
id |
String |
编号 |
req_param_id |
String |
关联的请求参数对象编号 |
req_param_location |
String |
关联的请求参数对象位置 |
参数 |
参数类型 |
描述 |
---|---|---|
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
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 |
error_msg |
String |
错误描述 |
状态码: 403
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 |
error_msg |
String |
错误描述 |
状态码: 404
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 |
error_msg |
String |
错误描述 |
状态码: 500
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 |
error_msg |
String |
错误描述 |
- API网关基本概念_云原生API网关_API网关APIG-华为云
- 什么是API网关_API网关有什么作用_API网关APIG-华为云
- API网关双重认证_双重认证方式_API网关APIG-华为云
- API网关有哪些使用场景_API网关作用_API网关APIG-华为云
- GaussDB数据库参数调优_GaussDB版本_高斯数据库参数调优
- API网关流量控制策略_流量管控_API网关APIG-华为云
- API网关支持http到https自动重定向_开放API_API网关APIG-华为云
- 调用API_API调用流程_API网关APIG-华为云
- 使用API网关开放本地数据中心服务能力_开放API_API网关APIG-华为云
- API网关跨VPC开放后端服务_API开放后端服务_API网关APIG-华为云