检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
服务端已定义proto文件，即在proto文件中定义API的Request和Response。proto文件是用于定义数据结构和服务接口的文件，通常在gRPC中使用。它基于Protobuf语言，用于描述数据的结构和交互方式，充当客户端和服务端之间通信的合同。 创建API 登录API网关控制台页面。 根据实际业务在左侧导航栏上方选择实例。
创建API分组 功能介绍 API分组是API的管理单元，一个API分组等同于一个服务入口，创建API分组时，返回一个子域名作为访问入口。建议一个API分组下的API具有一定的相关性。 专享版API网关已经陆续开放V2版本的接口，请优先使用V2版本接口管理您的API。 URI HTTP/HTTPS请求方法以及URI如下表所示。
求协议中的HTTP相当于WebSocket的ws，HTTPS相当于WebSocket的wss。 定义的后端服务协议须与用户的后端业务协议保持一致。 负载通道（可选） 仅在使用负载通道时，需要设置。选择已创建的负载通道名称，或者新建负载通道。 说明： 负载通道中，云服务器的安全组必须允许100
、金融行业的实时数据更新等场景。 约束与限制 WebSocket API不支持APIG控制台页面中的调试功能。 WebSocket API受API超时时间的限制，如果当前WebSocket连接空闲时间超过了配置的超时时间，并且没有ping/pong保活，则连接会被自动断开。 前提条件
PI分组的域名，并添加证书。添加域名后，还需执行放行回源IP、本地验证、修改域名DNS解析设置。详细操作步骤请参考网站接入WAF（云模式）。 客户从公网客户端访问WAF时，使用的是WAF对外访问域名，WAF转发给APIG时同样使用该对外访问域名，APIG收到访问该域名的请求无次数限制。
查看APIG的调用日志 快速获取并分析实例API的调用日志。 前提条件 已调用API。 操作步骤 进入API网关控制台页面。 根据实际业务在左侧导航栏上方选择实例。 在左侧导航栏选择“监控分析 > 日志分析”。 单击“配置访问日志”，将“启动日志记录”修改为，即启用日志记录能力。
单向认证无需配置CA证书。 单击“确定”创建完成。 绑定域名。 在左侧导航栏选择“API管理 > API分组”。 单击API所属分组名称，进入分组详情。 在“分组信息”页签中单击“绑定独立域名”。 表2 配置独立域名 参数 配置说明 域名 填写已备案的域名。 支持最小TLS版本 此处选择“TLS1
凭据管理”，进入凭据详情，获取Key和Secret。 AppKey/Key：APP访问密钥ID。与私有访问密钥关联的唯一标识符；访问密钥ID和私有访问密钥一起使用，对请求进行加密签名。 AppSecret/Secret：与访问密钥ID结合使用的密钥，对请求进行加密签名，可标识发送方，并防止请求被修改。
方案描述 API前端定义中的请求协议支持HTTPS时，API所属分组在绑定独立域名后，还需为独立域名添加SSL证书。SSL证书是进行数据传输加密和身份证明的证书，当SSL证书带有CA证书时，默认开启客户端认证即双向认证；反之，开启单向认证。 单向认证：客户端与服务端连接时，客户端需要校验服务端SSl证书合法性。
String 实例ID，在API网关控制台的“实例信息”中获取。 app_id 是 String 应用编号 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获
√ √ 范围 全部Region。 影响 自定义策略中未包含以上新增的授权项时，用户无权访问以上API。 适配方案 创建或更新自定义策略，添加以上新增的授权项以及依赖授权项，并通过给用户组授予自定义策略来进行精细的访问控制。自定义策略请参考API网关自定义策略。 父主题： 产品公告
请求协议：选择API请求协议，默认“HTTPS”。 子域名：API分组创建后，系统为分组自动分配一个内部测试用的调试域名，此调试域名每天最多可以访问1000次。 路径：接口请求路径。此处填写“/1234”。 网关响应 API网关未能成功处理API请求，从而产生的错误响应。 默认的网关响应为“default”。
录。 进入API网关控制台，在“实例管理”页面单击对应的实例名称。 在“实例信息”页面的“路由”区域查看已添加的路由与容器网段是否一致。如果不一致，请添加。 创建API，将部署在负载中的后端服务开放API。 相关文档 使用API网关开放云容器引擎CCE工作负载 父主题： 开放API
项目 华为云的区域默认对应一个项目，这个项目由系统预置，用来隔离物理区域间的资源（计算资源、存储资源和网络资源），以默认项目为单位进行授权，用户可以访问您账号中该区域的所有资源。此处默认为已选择的区域。 函数名称 根据规划自定义名称。建议您按照一定的命名规则填写名称，方便您快速识别和查找。
置访问策略： 流控控制 流量控制可限制单位时间内API的被调用次数，保护后端服务。 访问控制 访问API的IP地址和账户，您可以通过设置IP地址或账户的黑白名单来拒绝/允许某个IP地址或账户访问API。 签名密钥 签名密钥用于后端服务验证API网关的身份，在API网关请求后端服务时，保障后端服务的安全。
SignatureBinding relieveSignatureBinding 创建访问控制 Acl createAcl 删除访问控制 Acl deleteAcl 批量删除访问控制 Acl batchDeleteAcl 更新访问控制 Acl updateAcl 增加流控黑名单 Acl addAclValue
API发布后，如果不想API被某些IP地址访问到，可以将这些IP地址加入黑名单，或者想API被某些特性的IP地址访问到，也可以将这些IP地址加入白名单。这样可以提高API的访问安全性，保护API免受攻击。本节介绍API的黑白名单（ACL策略）管理的对象模型，如表1 ACL策略对象模型所示。
通过以下任意一种方法，进入API调试页面。 在待调试的API所在行，单击“更多 > 调试”。 单击“API名称”，进入API详情页面。在右上角单击“调试”。 图1 调试界面 左侧为API请求参数配置区域，参数说明如表1所示。右侧为API发送的请求信息和API请求调用后的返回结果回显。 表1 调试API
增加一个ACL策略，策略类型通过字段acl_type来确定（permit或者deny），限制的对象的类型可以为IP或者DOMAIN，这里的DOMAIN对应的acl_value的值为租户名称，而非“www.exampleDomain.com”之类的网络域名。 调用方法 请参见如何调用API。 URI POST /v
是否必选 类型 说明 x-apigateway-cors 是 boolean 是否支持开启跨域请求的标识。 true：支持 false：不支持 开启跨域访问的API请求，响应会增加如下头域： 头域名称 头域值 描述 Access-Control-Max-Age 172800 预检响应最大缓存时间
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
