检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
实施步骤 前提条件 客户端与服务端均为gRPC类型。 服务端已定义proto文件,即在proto文件中定义API的Request和Response。proto文件是用于定义数据结构和服务接口的文件,通常在gRPC中使用。它基于Protobuf语言,用于描述数据的结构和交互方式,充当客户端和服务端之间通信的合同。
是否必选 类型 说明 x-apigateway-access-control 否 String 访问控制策略 父主题: APIG的API设计文件扩展定义
用于认证的参数名称 in 是 String 仅支持header description 否 String 描述信息 父主题: APIG的API设计文件扩展定义
mockEndpoints 否 x-apigateway-backend.mockEndpoints MOCK类型后端服务定义 父主题: APIG的API设计文件扩展定义
是否对与FunctionGraph交互场景的请求体进行Base64编码。 true:编码 false:不编码 父主题: APIG的API设计文件扩展定义
表1 参数说明 参数 是否必选 类型 说明 result-content 是 String MOCK返回结果 父主题: APIG的API设计文件扩展定义
timeout 否 Number 后端请求超时时间,单位毫秒,缺省值为5000,取值范围为1 ~ 60000 父主题: APIG的API设计文件扩展定义
参数映射来源,支持REQUEST、CONSTANT description 否 String 参数含义描述 父主题: APIG的API设计文件扩展定义
策略条件输入来源,支持source、request parameter 否 String 策略条件输入来源为request时,请求入参的名称 父主题: APIG的API设计文件扩展定义
指定名称的访问控制策略。 要使用该策略,将x-apigateway-access-control属性值引用为该策略名称。 父主题: APIG的API设计文件扩展定义
如果待更新证书已绑定独立域名,那么所有访问这个域名的客户端都会看到更新后的证书。 如果更新的SSL证书已绑定独立域名且更新的内容新增CA证书,那么独立域名侧默认关闭“支持客户端认证”即关闭HTTPS双向认证;如果更新的SSL证书已绑定独立域名且更新的内容无CA证书,那么独立域名侧默认关闭“
删除API分组前,要先下线并删除分组下的所有API。 删除时,会一并删除直接或间接关联到该分组下的所有资源,包括独立域名、SSL证书信息等等。并会将外部域名与子域名的绑定关系进行解除(取决于域名cname方式)。 调用方法 请参见如何调用API。 URI DELETE /v2/{project
是 String 访问控制对象,仅支持IP value 是 String 访问控制策略值,多个值以“,”间隔 父主题: APIG的API设计文件扩展定义
conditions 是 x-apigateway-backend-policies.conditions 策略条件数组 父主题: APIG的API设计文件扩展定义
删除API分组前,要先下线并删除分组下的所有API。 删除时,会一并删除直接或间接关联到该分组下的所有资源,包括独立域名、SSL证书信息等等。并会将外部域名与子域名的绑定关系进行解除(取决于域名cname方式)。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI
删除API分组前,要先下线并删除分组下的所有API。 删除时,会一并删除直接或间接关联到该分组下的所有资源,包括独立域名、SSL证书、上架信息等等。并会将外部域名与子域名的绑定关系进行解除(取决于域名cname方式)。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI
仅在不使用负载通道时,需要设置。 填写后端服务的访问地址,格式:“主机:端口”。主机为后端服务的访问IP地址/域名;端口为后端服务的端口。未指定端口时,HTTP协议默认使用80端口,HTTPS协议默认使用443端口。 如果后端服务地址中需要携带环境变量,则使用“#变量名#”的形式将环
以下原因可能导致后端服务调用失败或者超时,请逐一排查。 原因 解决方案 后端服务地址错误。 在编辑API中修改后端服务地址。 如果是域名,请确认域名能正确解析到后端服务IP地址。 后端超时时间设置不合理。 当后端服务没有在设置的后端超时时间内返回时,API网关提示后端服务调用失败。
双向认证具体操作请参考双向认证。 创建SSL证书 SSL证书是进行数据传输加密和身份证明的证书。 绑定域名 将API所属的分组与已备案且解析的独立域名绑定。 绑定证书 将独立域名与已创建的SSL证书绑定。 调用API 验证API是否调用成功。 父主题: 配置APIG专享版与客户端间的单向认证或双向认证
ingress_http_port Integer 访问该域名绑定的http协议入方向端口,-1表示无端口且协议不支持,可使用80默认端口,其他有效端口允许的取值范围为1024~49151,需为实例已开放的HTTP协议的自定义入方向端口。 当创建域名时,该参数未填表示用默认80端口;如果填写该