检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
gRPC是RPC（远程过程调用）的一种，只需定义每个API的Request和Response，剩下的gRPC框架就可以完成。它的典型特征就是使用protobuf（protocol buffers）作为其接口定义语言（Interface Definition Language，缩写IDL），同时底层的消息交换格式也是使用protobuf。
对象模型 本节介绍API及后端服务的对象模型。 “操作类型”用于描述字段的属性，表示对应字段的值可进行的操作： C：创建；U：更新；R：读取。 “是否必选”列表示对于“操作类型”为“C”的创建操作，对应字段是否为必选字段。 表1 API对象模型 参数 类型 说明 操作类型 是否必选
$context.stage API调用的部署环境 $context.sourceIp API调用者的源地址 $context.authorizer.frontend.property 前端自定义认证响应的context映射的指定键值对的字符串值 $context.authorizer
创建API 创建gRPC类型的API，前后端协议均为GRPCS。 发布API 将gRPC类型的API发布到环境上。 验证 使用gRPC客户端测试gRPC服务可用性，如果服务端正常返回响应，则表示gRPC服务可用。 父主题： 使用APIG专享版实现gRPC服务的路由转发
Service，CTS），是华为云安全解决方案中专业的日志审计服务，提供对各种云资源操作记录的收集、存储和查询功能，可用于支撑安全分析、合规审计、资源跟踪和问题定位等常见应用场景。 用户开通云审计服务后，系统将开始记录APIG资源的操作事件，并为您保存最近7天的操作记录。CTS支持记录的APIG操作请参见云审计服务支持APIG操作列表。
对象模型 本节介绍API及后端服务的对象模型。 “操作类型”用于描述字段的属性，表示对应字段的值可进行的操作： C：创建；U：更新；R：读取。 “是否必选”列表示对于“操作类型”为“C”的创建操作，对应字段是否为必选字段。 表1 API对象模型 参数 类型 说明 操作类型 是否必选
查看监控指标与配置告警 APIG支持的监控指标 配置APIG的监控告警 查看APIG的监控指标 查看APIG的带宽监控 查看APIG的API调用日志
发到指定的后端服务中。 约束与限制 添加策略后端前，前端的安全认证方式应选“自定义认证”或使用双重认证（APP认证或IAM认证）。 添加策略后端前，必须定义一个默认后端，不满足任何一个策略后端的API请求，都将转发到默认的API后端。 “系统参数-前端认证参数”策略条件的“条件值
操作流程 配置API前端 在API的前端设置页面选择安全认证方式为“自定义认证”或使用双重认证（APP认证或IAM认证），并选择指定的自定义认证对象，如果没有，则需要创建自定义认证。 配置API后端 在API的后端设置页面添加策略后端，策略条件的条件来源选择“系统参数-前端认证参
单击分组名称，进入“分组信息”页面。 在“API运行”页面的“监控视图”区域，单击“查看更多监控”，返回“云服务监控”界面，参考创建告警规则为API网关创建告警规则。 父主题： 查看监控指标与配置告警
URI中的参数说明如下表所示。 表2 参数说明 名称 是否必选 类型 说明 id 是 String App Code的编号 app_id 是 String APP的编号 请求消息 无 响应消息 表3 参数说明 参数 类型 说明 id String 编号 app_code String
您自定义的认证名称，用于区分不同的自定义认证。 类型 前端：对API的访问进行认证鉴权。 后端：对后端服务的访问授权。 函数地址 选择在FunctionGraph中创建的函数。 身份来源 设置用于认证的请求参数，支持添加Header参数和Query参数，其中Header的参数名不区分大小写。
x-apigateway-backend 含义：API网关定义的API后端服务定义。 作用域：Operation Object(2.0)/Operation Object(3.0) 示例： paths: '/users/{userId}': get: produces:
概要查询（待下线） 查询API分组概况 查询API概况 查询APP概况 父主题： 专享版API（V1）（待下线）
ResponseInfoHeader 参数 参数类型 描述 key String 分组自定义响应的响应头的key，支持英文字母、数字和中划线，长度为1到128位 value String 分组自定义响应的响应头的value，为长度为1到1024位的字符串 最小长度：1 最大长度：1024 状态码： 400 表6
String 特殊流控策略类型，支持APP、USER。 limit 是 Number API的访问次数。 instance 是 String 特殊APP或USER的对象标识。 父主题： APIG的API设计文件扩展定义
完成API的创建、发布等工作 此部分操作在API网关服务中完成，您可以参考《API网关用户指南》。 其他相关操作包括“API分组”、“API管理”和“环境管理”等。 （可选）配置API的流量控制策略 流量控制主要用来限制单位时间内API的被调用次数，保护后端服务的稳定。 此部分
String 指定已有的分组，为空时创建新的分组 最小长度：0 最大长度：64 group_name 否 String API分组的名称,group_id为空时必填。 支持汉字、英文、数字、中划线、下划线、点、斜杠、中英文格式下的小括号和冒号、中文格式下的顿号，且只能以英文、汉字和数字开头，3-255个字符。
前端自定义认证响应的context映射的指定键值对的字符串值 $context.authorizer.backend.property 后端自定义认证响应的context映射的指定键值对的字符串值 $context.error.message 当前网关错误响应的错误信息 $context
customRatelimitName 否 x-apigateway-ratelimits.policy 指定名称的流控策略。 要使用该策略，将x-apigateway-ratelimit属性值引用为该策略名称。 父主题： APIG的API设计文件扩展定义
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
