- 最新动态
- 功能总览
- 服务公告
- 产品介绍
- 计费说明
- 快速入门
-
用户指南
- 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(仅存量用户使用)
- 专享版API(V1)(待下线)
- 权限策略和授权项
- 附录
- 修订记录
- 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网关专享版接口的分类与说明如表1所示,API网关共享版接口的分类与说明如表2所示。
类型 |
说明 |
---|---|
包括API分组的创建、修改、删除、查询详情和列表等接口。 |
|
包括环境的创建、修改、删除和查询列表等接口。 |
|
包括环境变量的新建、修改、删除、查询详情和列表等接口。 |
|
包括流控策略的创建、修改、删除、查看详情和列表等接口。 |
|
包括API的创建、修改、删除、发布或下线、查询、调试、切换版本、校验API定义等接口。 |
|
包括签名密钥的创建、修改、删除和查询等接口。 |
|
包括签名密钥的绑定、解绑、查询API绑定的密钥列表、查看密钥绑定/未绑定的API列表。 |
|
包括绑定、解绑、批量解绑API与流控策略的关系,查看流程策略绑定/未绑定的API列表,查看API绑定的流控策略列表。 |
|
包括创建、修改、删除特殊流控策略,查看特殊设置列表。 |
|
包括APP授权、解除授权,查看APP已绑定/未绑定的API列表,查看API已绑定的APP列表。 |
|
包括查询API概况、API分组概况、APP概况。 |
|
包括域名的绑定、修改、解绑。域名证书的绑定、删除、查看。 |
|
包括ACL策略的创建、修改、删除、批量删除,查看ACL策略详情、查询ACL策略列表。 |
|
包括将API与ACL策略绑定、解绑、批量解绑,查看ACL策略绑定/未绑定的API列表,查看API绑定的ACL策略列表。 |
|
包括自定义认证的创建、修改、删除,查看自定义认证详情,查询自定义认证列表。 |
|
包括API的导出、导入。 |
|
包括:
|
|
包括查询最近一段时间的API统计信息,查询最近一小时内的分组统计信息。 |
|
包括分组自定义响应的创建、查询、修改、删除,查询分组自定义响应列表,查看、修改分组下指定错误类型的自定义响应,删除分组指定错误类型的自定义响应配置。 |
|
包括标签列表的查询。 |
|
包括实例特性的配置,查看实例特性列表。 |
|
包括查看某实例的租户配置列表,查询租户实例配置列表。 |
|
包括:
|
|
包括:
|
|
包括实例标签的添加、删除和查询。 |
|
包括导入微服务。 |
|
包括:
|
|
包括:
|
|
包括:
|
|
包括:
|
|
包括:
|
|
包括:
|
|
包括:
|
类型 |
说明 |
---|---|
包括API分组的创建、修改、删除和查询等接口。 |
|
包括API的创建、修改、删除、发布、下线和查询等接口。 |
|
包括APP的创建、修改、删除、重置密钥和查询等接口。 |
|
包括授权、解除授权、查询授权关系等接口。 |
|
包括环境的创建、修改、删除和查询接口。 |
|
包括环境变量的创建、删除和查询等接口。 |
|
包括流控策略的创建、修改、删除和查询等接口。 |
|
包括流控策略的查询、绑定和解除绑定等接口。 |
|
包括特殊流控的创建、修改、删除和查询接口。 |
|
包括黑白名单的创建、修改、删除和查看等接口。 |
|
包括查询API绑定ACL策略列表、查看ACL策略绑定/未绑定API列表和解除已绑定的API接口。 |
|
包括查询已购买的API分组列表、查询分组详情和API列表接口。 |
|
包括配置对象模型和查询租户配置详情接口。 |
|
包括概要信息的查询接口。 |
|
包括签名密钥的创建、修改、删除和查询接口。 |
|
包括签名密钥的绑定和解除绑定接口,查询签名密钥绑定/未绑定API列表接口。 |
|
包括域名的绑定、解绑和证书的绑定、删除接口。 |
|
包括创建VPC通道、更新VPC通道、删除VPC通道、查看VPC通道详情和列表、添加和删除云服务器、查看云服务器列表。 |
|
包括API/API分组的统计信息查询接口。 |
|
导出租户发布分组到指定环境的Swagger API。 |
|
包括自定义认证的创建、修改、删除,查看自定义认证详情,查询自定义认证列表。 |