检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
开启公网出口后,您可以单击“查看带宽监控”查看数据,也可编辑出公网带宽。 路由 配置私有网段。实例创建完成后,默认能够与创建时指定的VPC子网网段进行互通。如果有额外的私有网段需要与实例互通,可通过该配置项进行路由配置。 如果本地数据中心的子网不在以下三个大子网段内,暂时不支持配置本地路由:10
后端服务已定义proto文件,即在proto文件中定义API的Request和Response。proto文件是用于定义数据结构和服务接口的文件,通常在gRPC中使用。它基于Protobuf语言,用于描述数据的结构和交互方式,充当客户端和后端服务之间通信的合同。 操作步骤 进入API网关控制台页面。 根据实际业务在左侧导航栏上方选择实例。
新增网关响应 操作场景 网关响应,指API网关未能成功处理API请求,从而产生的错误响应。API网关提供默认的网关响应(default),如果您需要自定义响应状态码或网关响应内容,可在API分组管理中新增网关响应,其中响应内容符合JSON格式即可。 例如,“default”网关的响应内容为:
如果编排规则列表中包含default类型的规则,则default类型的规则优先级最低,至多绑定一个default类型的规则; 当编排规则为预处理策略时,该规则不能作为除default以外的最后一个编排规则; 每个API仅允许选择一个参数绑定编排规则,且编排规则不能重复,支持绑定的编
自定义API的错误响应信息 网关响应指API网关未能成功处理API请求,从而产生的错误响应。API网关提供默认的网关响应(default),如果您需要自定义响应状态码或网关响应内容,可在API分组管理中新增网关响应,其中响应内容符合JSON格式即可。 例如,“default”网关的响应内容为:
错误码 当调用API时,可能遇到如表1所示的错误码。如果遇到“APIGW”开头的错误码,请参见API网关错误码进行处理。 通过APIG接口管理API,发生错误时,产生的错误码请参考错误码。 使用APIG错误码时,请以错误码(如APIG.0101)为准,错误信息并非固定不变,有时会对错误信息进行优化修改。
APIG的API错误码说明 当调用API时,可能遇到下表中的错误码。如果遇到“APIGW”开头的错误码,请参见API网关错误码进行处理。 通过APIG接口管理API,发生错误时,产生的错误码请参考错误码。 使用APIG错误码时,请以错误码(如APIG.0101)为准,错误信息并非
C:创建;U:更新;R:读取。 “是否必选”列表示对于“操作类型”为“C”的创建操作,对应字段是否为必选字段。 表1 分组对象模型 参数名称 数据类型 参数说明 操作类型 是否必选 ID String API分组编号 R - NAME String API分组名称 CRU 是 STATUS
类型 说明 total Integer 满足条件的分组总数 size Integer 本次返回的列表长度 groups 字典数据类型 分组列表 表4 字典数据类型:分组字段说明 名称 类型 说明 id String 编号 name String 名称 status Integer 状态
String API的请求路径,需以"/"开头,最大长度1024 说明: 须符合路径规范,百分号编码格式可被正确解码 query 否 字典数据类型 查询参数,每个参数值为字符串数组,每个参数名称有如下约束: 英文字母、数字、点、下划线、中连线组成 必须以英文字母开头,最长32字节
C:创建;U:更新;R:读取。 “是否必选”列表示对于“操作类型”为“C”的创建操作,对应字段是否为必选字段。 表1 分组对象模型 参数名称 数据类型 参数说明 操作类型 是否必选 ID String API分组编号 R - NAME String API分组名称 CRU 是 STATUS
表3 参数说明 名称 类型 说明 total Integer 符合条件的环境总数 size Integer 本次返回的列表长度 envs 字典数据类型 本次返回的环境列表 表4 envs参数说明 参数 类型 说明 id String 环境ID name String 环境名称 create_time
String 函数urn identities Array 认证来源 ttl Integer 缓存时间 user_data String 用户数据 create_time Time 创建时间 表4 identities参数说明 名称 类型 说明 name String 参数名称 location
String 函数urn identities Array 认证来源 ttl Integer 缓存时间 user_data String 用户数据 create_time Time 创建时间 表4 identities参数说明 名称 类型 说明 name String 参数名称 location
create_time Timestamp VPC通道的创建时间。 vpc_health_config 字典数据类型 健康检查详情。 vpc_instances 字典数据类型 后端实例列表。 表4 健康检查详情 名称 类型 说明 id String 健康检查的编号。 vpc_id
系统默认分配的一个子域名。 请求协议 分为三种类型: HTTP HTTPS HTTP&HTTPS 传输重要或敏感数据时推荐使用HTTPS API网关支持WebSocket数据传输,请求协议中的HTTP相当于WebSocket的ws,HTTPS相当于WebSocket的wss。 请求Path
String API的请求路径,需以"/"开头,最大长度1024 说明: 须符合路径规范,百分号编码格式可被正确解码 query 否 字典数据类型 查询参数,每个参数值为字符串数组,每个参数名称有如下约束: 英文字母、数字、点、下划线、中连线组成 必须以英文字母开头,最长32字节
如果编排规则列表中包含default类型的规则,则default类型的规则优先级最低,至多绑定一个default类型的规则; 当编排规则为预处理策略时,该规则不能作为除default以外的最后一个编排规则; 每个API仅允许选择一个参数绑定编排规则,且编排规则不能重复,支持绑定的编
表3 参数说明 名称 类型 说明 total Integer 符合条件的环境总数 size Integer 本次返回的列表长度 envs 字典数据类型 本次返回的环境列表 表4 envs参数说明 参数 类型 说明 id String 环境ID name String 环境名称 create_time
仅VPC通道类型为2时有效,缺省为1。 vpc_health_config type = 2时必选 字典数据类型 健康检查详情,仅VPC通道类型为2时有效。 vpc_instances 是 字典数据类型 后端实例列表,VPC通道类型为1时,有且仅有1个后端实例。 表4 健康检查详情 参数 是否必选