检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
服务地址。创建API的详细步骤请参见创建API。 如果部署在华为云上的服务无公网IP地址，则将此服务的访问方式设置为VPC内网访问，在API网关中创建API时，通过VPC通道访问部署在VPC内的此服务。创建VPC通道和API的详细步骤请参见创建负载通道和创建API。 父主题： 开放API
API网关提供的错误响应类型见表1，其中响应状态码可以按实际需要做自定义修改。 表1 API网关的错误响应类型 错误说明 默认的响应状态码 详细说明 拒绝访问 403 拒绝访问，如触发配置的访问控制策略、或异常攻击检测拦截 自定义认证配置错误 500 自定义认证方异常，通信失败、返回异常响应等错误 自定义认证失败
功能介绍 流控策略可以限制一段时间内可以访问API的最大次数，也可以限制一段时间内单个租户和单个APP可以访问API的最大次数。 如果想要对某个特定的APP进行特殊设置，例如设置所有APP每分钟的访问次数为500次，但想设置APP1每分钟的访问次数为800次，可以通过在流控策略中设置特殊APP来实现该功能。
instance_id 是 String 实例ID，在API网关控制台的“实例信息”中获取。 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。
Request 服务器未能处理请求。可能原因： 语义有误，当前请求无法被服务器解析； 请求参数有误。 401 Unauthorized 当前请求需要用户验证。如需要用户名和密码。 403 Forbidden 对被请求页面的访问被禁止。 404 Not Found 请求失败，在服务器上未找到请求所希望得到的资源。
API网关提供的错误响应类型见下表，其中响应状态码可以按实际需要做自定义修改。 表1 API网关的错误响应类型 错误说明 默认的响应状态码 详细说明 拒绝访问 403 拒绝访问，如触发配置的访问控制策略、或异常攻击检测拦截 自定义认证配置错误 500 自定义认证方异常，通信失败、返回异常响应等错误 自定义认证失败
project_id 是 String 项目ID，获取方式请参见获取项目ID。 instance_id 是 String 实例ID，在API网关控制台的“实例信息”中获取。 表2 Query参数 参数 是否必选 参数类型 描述 group_id 是 String API分组的编号
专享版-实例终端节点管理 查询实例终端节点连接列表 接受或拒绝终端节点连接 查询实例的终端节点服务的白名单列表 批量添加实例终端节点连接白名单 批量删除实例终端节点连接白名单 父主题： 专享版API（V2）
project_id 是 String 项目ID，获取方式请参见获取项目ID。 instance_id 是 String 实例ID，在API网关控制台的“实例信息”中获取。 表2 Query参数 参数 是否必选 参数类型 描述 api_id 是 String API的编号 duration
调试域名不能用于生产业务，且仅限应用程序调试使用。 调试域名默认只能在与实例相同VPC内的服务器上解析和访问，如果调试域名要支持公网解析与访问，请在实例上绑定公网入口弹性IP。 创建API分组 进入API网关控制台页面。 根据实际业务在左侧导航栏上方选择实例。 在左侧导航栏选择“API管理 > API分组”。
授权 功能介绍 APP创建成功后，还不能访问API，如果想要访问某个环境上的API，需要将该API在该环境上授权给APP。授权成功后，APP即可访问该环境上的这个API。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法
创建APIG实例 本小节指导您顺利创建实例，实例创建完成后，才能创建API并对外提供服务。 约束与限制 实例配额 同一项目ID下，一个主账号默认只能创建5个实例。如果您需要创建更多实例，可提交工单，申请修改配额。 用户权限 如果您使用系统角色相关权限，需要同时拥有“APIG Administrator”和“VPC
授权 功能介绍 APP创建成功后，还不能访问API，如果想要访问某个环境上的API，需要将该API在该环境上授权给APP。授权成功后，APP即可访问该环境上的这个API。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法
access the API. 403 IP地址不允许访问 检查IP地址是否被API的访问控制限制。 APIG.0403 The IP address cannot be accessed. 403 IP地址不允许访问 检查IP地址是否被实例级访问控制限制。 APIG.0404 Access
Integer 后端服务器端口 最小值：0 最大值：65535 ecs_id String 后端云服务器的编号。 后端实例类型为ecs时必填，支持英文，数字，“-”,“_”，1 ~ 64字符。 最大长度：255 ecs_name String 后端云服务器的名称。 后端实例类型为ecs时必填，支持汉字，英文，数字，“-”
功能介绍 流控策略可以限制一段时间内可以访问API的最大次数，也可以限制一段时间内单个租户和单个APP可以访问API的最大次数。 如果想要对某个特定的APP进行特殊设置，例如设置所有APP每分钟的访问次数为500次，但想设置APP1每分钟的访问次数为800次，可以通过在流控策略中设置特殊APP来实现该功能。
方案概述 应用场景 gRPC是RPC（远程过程调用）的一种，只需定义每个API的Request和Response，剩下的gRPC框架就可以完成。它的典型特征就是使用protobuf（protocol buffers）作为其接口定义语言（Interface Definition L
instance_id 是 String 实例ID，在API网关控制台的“实例信息”中获取。 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。
根据API分组的id和最近的一段时间查询API被调用的次数，统计周期为1分钟。查询范围一小时以内，一分钟一个样本，其样本值为一分钟内的累计值。 为了安全起见，在服务器上使用curl命令调用接口查询信息后，需要清理历史操作记录，包括但不限于“~/.bash_history”、“/var/log/messages”（如有）。
是 String 实例ID，可从API网关控制台的专享版实例信息中获取。 请求消息 无 响应消息 表3 参数说明 名称 类型 说明 authed_nums Integer 已进行API访问授权的APP个数 unauthed_nums Integer 未进行API访问授权的APP个数
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
