- 最新动态
- 功能总览
- 服务公告
- 产品介绍
- 计费说明
- 快速入门
-
用户指南
- APIG业务使用流程
- 创建用户并授权使用APIG
- 创建APIG实例
- 开放API
- 配置API调用授权(可选)
- 调用API
-
管理API
- 管理API概述
- 查看或编辑APIG的API信息
- 配置API的自定义认证
- 配置API的参数编排规则
- 自定义API的错误响应信息
- 克隆APIG的API
- 下线APIG的API
- 导入导出API
-
APIG的API设计文件扩展定义
- x-apigateway-auth-type
- x-apigateway-request-type
- x-apigateway-match-mode
- x-apigateway-cors
- x-apigateway-is-send-fg-body-base64
- x-apigateway-any-method
- x-apigateway-backend
- x-apigateway-backend.parameters
- x-apigateway-backend.httpEndpoints
- x-apigateway-backend.httpVpcEndpoints
- x-apigateway-backend.functionEndpoints
- x-apigateway-backend.mockEndpoints
- x-apigateway-backend-policies
- x-apigateway-backend-policies.conditions
- x-apigateway-ratelimit
- x-apigateway-ratelimits
- x-apigateway-ratelimits.policy
- x-apigateway-ratelimits.policy.special
- x-apigateway-access-control
- x-apigateway-access-controls
- x-apigateway-access-controls.policy
- x-apigateway-plugins
- x-apigateway-auth-opt
- x-apigateway-result-normal-sample
- x-apigateway-result-failure-sample
- x-apigateway-authorizer
- x-apigateway-response
- x-apigateway-responses
- x-apigateway-pass-through
- x-apigateway-sample
- x-apigateway-content-type
- x-apigateway-orchestrations
- 配置API策略
- 配置凭据策略
- 管理APIG实例
- 查看监控指标与配置告警
- 查看APIG审计日志
- 共享版操作指导(仅存量用户使用)
- 最佳实践
- 开发指南
-
API参考
- 使用前必读
- API概览
- 如何调用API
-
专享版API(V2)
- 专享版-API分组管理
- 专享版-环境管理
- 专享版-环境变量管理
- 专享版-流控策略管理
- 专享版-API管理
- 专享版-签名密钥管理
- 专享版-签名密钥绑定关系管理
- 专享版-API绑定流控策略
- 专享版-设置特殊流控
- 专享版-APP授权管理
- 专享版-概要查询
- 专享版-域名管理
- 专享版-ACL策略管理
- 专享版-API绑定ACL策略
- 专享版-自定义认证管理
- 专享版-OpenAPI接口
- 专享版-VPC通道管理
- 专享版-监控信息查询
- 专享版-分组自定义响应管理
- 专享版-标签管理
- 专享版-实例特性管理
- 专享版-配置管理
- 专享版-实例管理
- 专享版-实例终端节点管理
- 专享版-实例标签管理
- 专享版-微服务中心管理
- 专享版-SSL证书管理
- 专享版-插件管理
- 专享版-凭据管理
- 专享版-凭据配额管理
- 专享版-异步任务管理
- 专享版-编排规则管理
- 专享版-实例自定义入方向端口管理
- 共享版API(仅存量用户使用)
- 权限策略和授权项
- 附录
- 修订记录
- SDK参考
-
常见问题
- 热门咨询
- 产品咨询
- 开放API
- 发布API
-
调用API
- 调用API失败的可能原因
- 调用API报“414 Request URI too large”
- 调用API报“The API does not exist or has not been published in the environment”
- 调用API报“No backend available”
- API的后端服务报“Backend unavailable”或“Backend timeout”
- API的后端服务报“Backend domain name resolution failed”
- 调用API报“Incorrect IAM authentication information”
- 调用API报“Incorrect app authentication information”
- 修改API后端服务的超时时间上限“backend_timeout”后未生效
- APIG对API请求体的大小是否有限制?
- API调用对请求的响应消息体限制
- 使用iOS系统时,如何使用APP认证调用API?
- 新建一个华为IAM认证方式的API,在配置入参时为什么无法配置HEADER位置的x-auth-token?
- 是否支持移动应用调用API?
- 部署在VPC下的应用是否可以调用API?
- APIG是否支持WebSocket数据传输?
- API的策略后端有多个时,怎么匹配和执行API请求?
- 如何通过APIG访问公网后端服务?
- API认证
- API策略
- 导入导出API
-
更多文档
-
用户指南(吉隆坡区域)
- 产品介绍
- 快速入门
- 新旧版本差异
- 总览
-
API管理
- 创建API分组
- 绑定域名
- 创建环境变量
- 新增网关响应
- 创建API
- 克隆API
- 开启跨域访问
- 调试API
- 授权API
- 发布API
- 下线API
-
导入导出API
- 限制与兼容性说明
- 导入API
- 导出API
-
扩展定义
- x-apigateway-auth-type
- x-apigateway-request-type
- x-apigateway-match-mode
- x-apigateway-cors
- x-apigateway-any-method
- x-apigateway-backend
- x-apigateway-backend.parameters
- x-apigateway-backend.httpEndpoints
- x-apigateway-backend.httpVpcEndpoints
- x-apigateway-backend.functionEndpoints
- x-apigateway-backend.mockEndpoints
- x-apigateway-backend-policies
- x-apigateway-backend-policies.conditions
- x-apigateway-ratelimit
- x-apigateway-ratelimits
- x-apigateway-ratelimits.policy
- x-apigateway-ratelimits.policy.special
- x-apigateway-access-control
- x-apigateway-access-controls
- x-apigateway-access-controls.policy
- x-apigateway-plugins
- 查看API列表
- 支持HTTP2.0
- API策略
- 凭据管理
- 监控分析
- 实例管理
- SDK
- 调用已发布的API
- 权限管理
- 云审计服务支持的关键操作
-
常见问题
- 热门咨询
- API创建
-
API调用
- API调用失败的可能原因有哪些?
- API调用返回错误码如何处理?
- API调用报错“414 Request URI too large”
- "The API does not exist or has not been published in the environment."如何解决?
- No backend available,怎么解决?
- 后端服务调用失败“Backend unavailable”或超时“Backend timeout”原因分析
- 后端服务调用报错域名无法解析“Backend domain name resolution failed”
- 修改后端服务的超时时间上限“backend_timeout”后未生效
- 如何切换调用环境?
- 调用请求包最大支持多少?
- 使用iOS系统时,如何进行APP认证?
- 新建一个IAM认证方式的API,在配置入参时为什么无法配置HEADER位置的x-auth-token?
- 应用(凭据)问题汇总
- 是否支持移动应用调用API?
- 部署在VPC下的应用是否可以调用API?
- API网关是否支持WebSocket数据传输?
- API调用是否支持长连接
- 策略后端有多个时,怎么匹配和执行
- API调用对请求的响应消息体限制
- 如何通过APIG访问公网后端服务
- API认证鉴权
- API控制策略
- API发布
- API导入导出
- API安全
- 其他
- 修订记录
- 开发指南(吉隆坡区域)
-
API参考(吉隆坡区域)
- 使用前必读
- 如何调用API
-
专享版API(V2)
- 专享版-API分组管理
- 专享版-环境管理
- 专享版-环境变量管理
- 专享版-流控策略管理
- 专享版-API管理
- 专享版-签名密钥管理
- 专享版-签名密钥绑定关系管理
- 专享版-API绑定流控策略
- 专享版-设置特殊流控
- 专享版-APP授权管理
- 专享版-概要查询
- 专享版-域名管理
- 专享版-ACL策略管理
- 专享版-API绑定ACL策略
- 专享版-自定义认证管理
- 专享版-OpenAPI接口
- 专享版-VPC通道管理
- 专享版-监控信息查询
- 专享版-分组自定义响应管理
- 专享版-标签管理
- 专享版-实例特性管理
- 专享版-配置管理
- 专享版-实例管理
- 专享版-实例终端节点管理
- 专享版-实例标签管理
- 专享版-SSL证书管理
- 专享版-插件管理
- 专享版-凭据管理
- 专享版-凭据配额管理
- 专享版-异步任务管理
- 权限策略和授权项
- 附录
- 修订记录
-
用户指南(阿布扎比区域)
- 产品介绍
- 快速入门
- 新旧版本差异
- 总览
-
API管理
- 创建API分组
- 导入CCE工作负载
- 绑定域名
- 创建环境变量
- 新增网关响应
- 创建API
- 创建GRPC API
- 克隆API
- 开启跨域访问
- 调试API
- 授权API
- 发布API
- 下线API
-
导入导出API
- 限制与兼容性说明
- 导入API
- 导出API
-
扩展定义
- x-apigateway-auth-type
- x-apigateway-request-type
- x-apigateway-match-mode
- x-apigateway-cors
- x-apigateway-is-send-fg-body-base64
- x-apigateway-any-method
- x-apigateway-backend
- x-apigateway-backend.parameters
- x-apigateway-backend.httpEndpoints
- x-apigateway-backend.httpVpcEndpoints
- x-apigateway-backend.functionEndpoints
- x-apigateway-backend.mockEndpoints
- x-apigateway-backend-policies
- x-apigateway-backend-policies.conditions
- x-apigateway-ratelimit
- x-apigateway-ratelimits
- x-apigateway-ratelimits.policy
- x-apigateway-ratelimits.policy.special
- x-apigateway-access-control
- x-apigateway-access-controls
- x-apigateway-access-controls.policy
- x-apigateway-plugins
- 查看API列表
- 支持HTTP2.0
- API策略
- 凭据管理
- 监控分析
- 实例管理
- SDK
- 调用已发布的API
- 权限管理
- 云审计服务支持的关键操作
-
常见问题
- 热门咨询
- API创建
-
API调用
- API调用失败的可能原因有哪些?
- API调用返回错误码如何处理?
- API调用报错“414 Request URI too large”
- "The API does not exist or has not been published in the environment."如何解决?
- No backend available,怎么解决?
- 后端服务调用失败“Backend unavailable”或超时“Backend timeout”原因分析
- 后端服务调用报错域名无法解析“Backend domain name resolution failed”
- 修改后端服务的超时时间上限“backend_timeout”后未生效
- 如何切换调用环境?
- 调用请求包最大支持多少?
- 使用iOS系统时,如何进行APP认证?
- 新建一个IAM认证方式的API,在配置入参时为什么无法配置HEADER位置的x-auth-token?
- 应用(凭据)问题汇总
- 是否支持移动应用调用API?
- 部署在VPC下的应用是否可以调用API?
- API网关是否支持WebSocket数据传输?
- API调用是否支持长连接
- 策略后端有多个时,怎么匹配和执行
- API调用对请求的响应消息体限制
- 如何通过APIG访问公网后端服务
- API认证鉴权
- API控制策略
- API发布
- API导入导出
- API安全
- 其他
- 修订记录
- 开发指南(阿布扎比区域)
-
API参考(阿布扎比区域)
- 使用前必读
- 如何调用API
-
专享版API(V2)
- 专享版-API分组管理
- 专享版-环境管理
- 专享版-环境变量管理
- 专享版-流控策略管理
- 专享版-API管理
- 专享版-签名密钥管理
- 专享版-签名密钥绑定关系管理
- 专享版-API绑定流控策略
- 专享版-设置特殊流控
- 专享版-APP授权管理
- 专享版-概要查询
- 专享版-域名管理
- 专享版-ACL策略管理
- 专享版-API绑定ACL策略
- 专享版-自定义认证管理
- 专享版-OpenAPI接口
- 专享版-VPC通道管理
- 专享版-监控信息查询
- 专享版-分组自定义响应管理
- 专享版-标签管理
- 专享版-实例特性管理
- 专享版-配置管理
- 专享版-实例管理
- 专享版-实例终端节点管理
- 专享版-实例标签管理
- 专享版-微服务中心管理
- 专享版-SSL证书管理
- 专享版-插件管理
- 专享版-凭据管理
- 专享版-凭据配额管理
- 专享版-异步任务管理
- 权限策略和授权项
- 附录
- 修订记录
- 最佳实践(阿布扎比区域)
- 用户指南(巴黎区域)
- 开发指南(巴黎区域)
- API参考(巴黎区域)
-
用户指南专享版(巴黎区域)
- 产品介绍
- 快速入门
- 新旧版本差异
- 总览
-
API管理
- 创建API分组
- 绑定域名
- 创建环境变量
- 新增网关响应
- 创建API
- 开启跨域访问
- 调试API
- 授权API
- 发布API
- 下线API
-
导入导出API
- 限制与兼容性说明
- 导入API
- 导出API
-
扩展定义
- x-apigateway-auth-type
- x-apigateway-request-type
- x-apigateway-match-mode
- x-apigateway-cors
- x-apigateway-any-method
- x-apigateway-backend
- x-apigateway-backend.parameters
- x-apigateway-backend.httpEndpoints
- x-apigateway-backend.httpVpcEndpoints
- x-apigateway-backend.functionEndpoints
- x-apigateway-backend.mockEndpoints
- x-apigateway-backend-policies
- x-apigateway-backend-policies.conditions
- x-apigateway-ratelimit
- x-apigateway-ratelimits
- x-apigateway-ratelimits.policy
- x-apigateway-ratelimits.policy.special
- x-apigateway-access-control
- x-apigateway-access-controls
- x-apigateway-access-controls.policy
- x-apigateway-plugins
- 查看API列表
- API策略
- 凭据管理
- 监控分析
- 实例管理
- 调用已发布的API
- 权限管理
- 云审计服务支持的关键操作
-
常见问题
- 热门咨询
- API创建
-
API调用
- API调用失败的可能原因有哪些?
- API调用返回错误码如何处理?
- API调用报错“414 Request URI too large”
- "The API does not exist or has not been published in the environment."如何解决?
- No backend available,怎么解决?
- 后端服务调用失败“Backend unavailable”或超时“Backend timeout”原因分析
- 后端服务调用报错域名无法解析“Backend domain name resolution failed”
- 修改后端服务的超时时间上限“backend_timeout”后未生效
- 如何切换调用环境?
- 调用请求包最大支持多少?
- 使用iOS系统时,如何进行APP认证?
- 新建一个IAM认证方式的API,在配置入参时为什么无法配置HEADER位置的x-auth-token?
- 应用(凭据)问题汇总
- 是否支持移动应用调用API?
- 部署在VPC下的应用是否可以调用API?
- API网关是否支持WebSocket数据传输?
- API调用是否支持长连接
- 策略后端有多个时,怎么匹配和执行
- API调用对请求的响应消息体限制
- 如何通过APIG访问公网后端服务
- API认证鉴权
- API控制策略
- API发布
- API导入导出
- API安全
- 其他
- 修订记录
- 开发指南专享版(巴黎区域)
-
API参考专享版 (巴黎区域)
- 使用前必读
- 如何调用API
- 专享版API(V2)
- 权限策略和授权项
- 附录
- 修订记录
-
用户指南(吉隆坡区域)
- 通用参考
展开导读
链接复制成功!
对象模型
本节介绍API及后端服务的对象模型。
参数 |
类型 |
说明 |
操作类型 |
是否必选 |
---|---|---|---|---|
id |
String |
API的编号 |
R |
- |
name |
String |
API的名称 |
CRU |
是 |
group_id |
String |
API所属分组的编号 |
CR |
是 |
type |
Integer |
API的类型:
|
CRU |
是 |
status |
Integer |
API的状态:
默认1 该字段已废弃 |
R |
- |
version |
String |
API的版本 |
CRU |
否 |
req_protocol |
String |
API的访问协议
默认:HTTPS |
CRU |
否 |
req_method |
String |
API的访问方式
|
CRU |
是 |
req_uri |
String |
API的访问地址,不含域名、端口号、请求协议等,是URI |
CRU |
是 |
auth_type |
String |
API的认证方式
|
CRU |
是 |
authorizer_id |
String |
前端自定义认证对象的ID |
CRU |
否 |
match_mode |
String |
API的路由匹配方式:
|
CRU |
是 |
arrange_necessary |
Integer |
是否需要编排
目前默认为:2 |
R |
- |
backend_type |
String |
后端服务类型:
|
CRU |
是 |
register_time |
Timestamp |
API注册时间 |
R |
- |
update_time |
Timestamp |
API修改时间 |
R |
- |
remark |
String |
API描述 |
CRU |
否 |
tag |
String |
API标签 |
CRU |
否 |
cors |
String |
是否支持跨域
默认:FALSE |
CRU |
否 |
response_id |
String |
分组自定义响应ID |
CRU |
否 |
参数 |
类型 |
说明 |
操作类型 |
是否必选 |
---|---|---|---|---|
id |
String |
编号 |
R |
- |
status |
Integer |
状态:
默认1 该字段已废弃 |
R |
- |
version |
String |
版本 |
CRU |
否 |
url_domain |
String |
后端endpoint |
CRU |
是 |
req_protocol |
String |
访问协议
|
CRU |
是 |
req_method |
String |
请求方式
|
CRU |
是 |
req_uri |
String |
访问地址,是URI |
CRU |
是 |
timeout |
Integer |
超时时间,单位:毫秒(1-60000) |
CRU |
是 |
front_api_id |
String |
对应的API编号 |
R |
- |
register_time |
Timestamp |
注册时间 |
R |
- |
update_time |
Timestamp |
修改时间 |
R |
- |
remark |
String |
描述 |
CRU |
否 |
vpc_status |
Integer |
是否使用VPC通道
|
CRU |
否,默认不使用 |
vpc_info |
String |
VPC通道信息 |
CRU |
否 如果vpc_status=1,即:使用VPC通道,则该字段必填 |
authorizer_id |
String |
后端自定义认证对象的ID |
CRU |
否 |
参数 |
类型 |
说明 |
操作类型 |
是否必选 |
---|---|---|---|---|
id |
String |
编号 |
R |
- |
front_api_id |
String |
对应的API编号 |
R |
- |
status |
Integer |
状态:
默认1 该字段已废弃 |
R |
- |
version |
String |
版本 |
CRU |
否 |
result_content |
String |
返回结果 |
CRU |
否 |
register_time |
Timestamp |
注册时间 |
R |
- |
update_time |
Timestamp |
修改时间 |
R |
- |
remark |
String |
描述 |
CRU |
否 |
参数 |
类型 |
说明 |
操作类型 |
是否必选 |
---|---|---|---|---|
id |
String |
编号 |
R |
- |
front_api_id |
String |
对应的API编号 |
R |
- |
name |
String |
参数名称 |
CRU |
是 |
type |
String |
参数类型:
|
CRU |
是 |
location |
String |
参数位置:
|
CRU |
是 |
default_value |
String |
参数默认值 |
CRU |
否 |
sample_value |
String |
参数示例值 |
CRU |
否 |
required |
Integer |
参数是否必须:
|
CRU |
是 |
valid_enable |
Integer |
是否开启参数校验:
|
CRU |
是 |
remark |
String |
参数描述 |
CRU |
否 |
enumerations |
String |
参数枚举值 |
CRU |
否 |
min_num |
String |
参数最小值 |
CRU |
否 |
max_num |
String |
参数最大值 |
CRU |
否 |
min_size |
Integer |
参数最小长度 |
CRU |
否 |
max_size |
Integer |
参数最大长度 |
CRU |
否 |
regular |
String |
正则校验规则(暂不支持) |
CRU |
否 |
json_schema |
String |
JSON校验规则(暂不支持) |
CRU |
否 |
参数 |
类型 |
说明 |
操作类型 |
是否必选 |
---|---|---|---|---|
id |
String |
编号 |
R |
- |
front_api_id |
String |
对应的API编号 |
R |
- |
req_param_id |
String |
对应的请求参数的编号 |
R |
- |
name |
String |
参数名称 |
CRU |
是 |
location |
String |
参数位置:
|
CRU |
是 |
origin |
String |
参数类型:
|
CRU |
是 |
value |
String |
参数值:
|
CRU |
否 |
remark |
String |
描述 |
CRU |
否 |
policy_id |
String |
关联的策略条件编号 |
CRU |
否 |
参数 |
类型 |
说明 |
操作类型 |
是否必选 |
---|---|---|---|---|
id |
String |
编号 |
R |
- |
front_api_id |
String |
对应的API编号 |
R |
- |
name |
String |
策略后端名称 |
CRU |
是 |
url_domain |
String |
后端endpoint |
CRU |
是 |
req_protocol |
String |
访问协议
|
CRU |
是 |
req_method |
String |
请求方式
|
CRU |
是 |
req_uri |
String |
访问地址,是URI |
CRU |
是 |
timeout |
Integer |
超时时间,单位:毫秒(1-60000) |
CRU |
否 |
vpc_status |
Integer |
是否使用VPC通道
|
CRU |
否,默认不使用 |
vpc_info |
String |
VPC通道信息 |
CRU |
否 如果vpc_status=1,即:使用VPC通道,则该字段必填 |
effect_mode |
String |
关联的策略组合模式
|
CRU |
是 |
参数 |
类型 |
说明 |
操作类型 |
是否必选 |
---|---|---|---|---|
id |
String |
编号 |
R |
- |
front_api_id |
String |
对应的API编号 |
R |
- |
name |
String |
策略后端名称 |
CRU |
是 |
result_content |
String |
返回结果 |
CRU |
否 |
effect_mode |
String |
关联的策略组合模式
|
CRU |
是 |
参数 |
类型 |
说明 |
操作类型 |
是否必选 |
---|---|---|---|---|
id |
String |
编号 |
R |
- |
front_api_id |
String |
对应的API编号 |
R |
- |
name |
String |
策略后端名称 |
CRU |
是 |
version |
String |
函数版本号 |
CRU |
否 |
function_urn |
String |
函数的URN |
CRU |
是 |
invocation_type |
String |
函数类型:async|sync(异步|同步) |
CRU |
是 |
timeout |
Integer |
超时时间(1-60000),单位:毫秒 |
CRU |
是 |
effect_mode |
String |
关联的策略组合模式
|
CRU |
是 |
参数 |
类型 |
说明 |
操作类型 |
是否必选 |
---|---|---|---|---|
id |
String |
策略后端条件对象的编号 |
R |
- |
condition_type |
String |
策略条件:
|
CRU |
否 |
condition_value |
String |
策略值 |
CRU |
是 |
condition_origin |
String |
策略类型:
|
CRU |
是 |
req_param_id |
String |
关联的请求参数对象编号 |
R |
- |
policy_backend_id |
String |
关联的策略后端对象编号 |
CRU |
是 |
参数 |
类型 |
说明 |
操作类型 |
是否必选 |
---|---|---|---|---|
app_code_auth_type |
String |
AppCode简易认证类型,仅在auth_type为APP时生效,默认为DISABLE:
|
CRU |
- |