检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
后端服务部署在本地数据中心，且不能通过公网地址直接访问。 如果您使用专享版API网关，可为本地数据中心搭建一条与API网关（所绑定的华为云VPC）之间的专线。 本节针对后端服务部署在本地数据中心的场景，介绍使用API网关开放API的注意事项。 图1 使用云专线连通客户本地数据中心与华为云专享版API网关
查看分组详情 功能介绍 查询指定分组的详细信息。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI GET /v1.0/apigw/api-groups/{id} URI中的参数说明如下表所示。 表2 参数说明
查询APP列表 功能介绍 查询APP列表。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI GET /v1.0/apigw/apps[?page_size, page_no, id, name, app_key
对象模型 本节介绍流控策略与API的绑定关系的对象模型，如下表所示。 “操作类型”用于描述字段的属性，表示对应字段的值可进行的操作： C：创建；U：更新；R：读取。 “是否必选”列表示对于“操作类型”为“C”的创建操作，对应字段是否为必选字段。 表1 流控策略限定关系对象模型 参数
修改特殊设置 功能介绍 修改某个流控策略下的某个特殊设置。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI PUT /v1.0/apigw/throttle-specials/{id} URI中的参数说明如下表所示。
删除特殊设置 功能介绍 删除某个流控策略的某个特殊配置。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI DELETE /v1.0/apigw/throttle-specials/{id} URI中的参数说明如下表所示。
查询租户配置详情 功能介绍 查询某个租户的配置项及其配置值。 URI 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI GET /v1.0/apigw/config/project[?page_size, page_no, config_id, config_name]
批量删除ACL策略 功能介绍 批量删除指定的多个ACL策略。 删除ACL策略时，如果存在ACL策略与API绑定关系，则无法删除。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI PUT /v1.0/apigw/acls[
自定义认证 创建自定义认证 删除自定义认证 父主题： 共享版操作指导（仅存量用户使用）
云审计服务支持的关键操作 云审计服务支持的APIG操作列表 在CTS事件列表查看云审计事件 父主题： 共享版操作指导（仅存量用户使用）
健康检查详情 名称 类型 说明 id String 健康检查的编号。 vpc_id String VPC通道的编号。 protocol String 使用以下协议，对VPC中主机执行健康检查。 TCP HTTP HTTPS path String 健康检查时的目标路径。 说明： 需要服从URI规范。
功能介绍 对某个生效中的API版本进行下线操作，下线后，API在该版本生效的环境中将不再能够被调用。 该接口供FunctionGraph服务使用。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI DELETE
对于不同的环境，API的版本、请求地址甚至于包括请求消息等均有可能不同。如：某个API，v1.0的版本为稳定版本，发布到了生产环境供生产使用，同时，该API正处于迭代中，v1.1的版本是开发人员交付测试人员进行测试的版本，发布在测试环境上，而v1.2的版本目前开发团队正处于开发过程中，可以发布到开发环境进行自测等。
输入的值不超过2147483647。正整数。 time_interval 是 Integer 流量控制的时长单位。与“流量限制次数”配合使用，表示单位时间内的API请求次数上限。输入的值不超过2147483647。正整数。 time_unit 是 String 流控的时间单位：
授权 功能介绍 APP创建成功后，还不能访问API，如果想要访问某个环境上的API，需要将该API在该环境上授权给APP。授权成功后，APP即可访问该环境上的这个API。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法
说明 title 否 String API分组名称，导入到已有分组时不生效 version 否 String 版本号，用户输入自定义版本号或者使用默认的当前时间 description 否 String 分组描述信息 表5 paths参数说明 名称 是否必选 参数类型 说明 uri 是
其中，签名密钥就是API安全保护机制的一种。 租户创建一个签名密钥，并将签名密钥与API进行绑定，则API网关在请求这个API时，就会使用绑定的签名密钥对请求参数进行数据加密，生成签名。当租户的后端服务收到请求时，可以校验这个签名，如果签名校验不通过，则该请求不是API网关发
默认值：45000，请求参数值不在合法范围内时将使用默认值 remark 否 String 描述 字符长度不超过255 说明： 中文字符必须为UTF-8或者unicode编码。 vpc_status 否 Integer 是否使用VPC通道： 1 : 使用VPC通道 2 : 不使用VPC通道 vpc_info
CONSUMER模式，接口调用者必须有API在指定环境上的授权信息或是API拥有者。 app_key 否 String 调试请求使用的APP的key app_secret 否 String 调试请求使用的APP的密钥 stage 否 String 调试请求指定的运行环境，仅在mode为CONSUMER时有效，未提供时有如下默认值:
查询API分组概况 功能介绍 查询租户名下的API分组概况：上架的API分组个数，未上架的API分组个数。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI GET /v1.0/apigw/resources/outline/groups
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
