检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
查看监控指标与配置告警 APIG支持的监控指标 配置APIG的监控告警 查看APIG的监控指标 查看APIG的带宽监控 查看APIG的API调用日志
参数描述信息 name 否 String 参数名称 in 否 String 参数位置,支持path、header、query、formData、body required 否 Boolean 参数是否必需,参数位置为path时必需 表9 responses参数说明 名称 是否必选 参数类型
Time 创建时间 表4 identities参数说明 名称 类型 说明 name String 参数名称 location String 参数位置: HEADER:头 QUERY:query 响应消息样例: { "name":"Authorizer_9dlh", "type":"FRONTEND"
参数描述信息 name 否 String 参数名称 in 否 String 参数位置,支持path、header、query、formData、body required 否 Boolean 参数是否必需,参数位置为path时必需 表9 responses参数说明 名称 是否必选 参数类型
String 参数名称 CRU 是 type String 参数类型: string number CRU 是 location String 参数位置: PATH QUERY HEADER FORMDATA CRU 是 default_value String 参数默认值 CRU 否 sample_value
修改。 表1 API网关的错误响应类型 错误说明 默认的响应状态码 详细说明 拒绝访问 403 拒绝访问,如触发配置的访问控制策略、或异常攻击检测拦截 自定义认证配置错误 500 自定义认证方异常,通信失败、返回异常响应等错误 自定义认证失败 500 自定义认证方返回认证失败 自定义认证身份来源错误
如果修改完默认网关响应后,需要恢复默认配置,单击“恢复默认配置”即可。 网关错误响应类型说明 API网关提供的错误响应类型见下表,其中响应状态码可以按实际需要做自定义修改。 表1 API网关的错误响应类型 错误说明 默认的响应状态码 详细说明 拒绝访问 403 拒绝访问,如触发配置的访问控制策略、或异常攻击检测拦截
String 参数名称 CRU 是 type String 参数类型: string number CRU 是 location String 参数位置: PATH QUERY HEADER FORMDATA CRU 是 default_value String 参数默认值 CRU 否 sample_value
方式的配置。 配置APIG的API认证凭据 在API网关中创建一个凭据,生成密钥对(Key、Secret),在调用API时,API网关服务根据密钥对进行身份核对,完成鉴权。Key唯一且不可重置,支持重置Secret。 配置APIG的API简易认证AppCode API配置简易认证
配置APIG实例标签 通过标签功能对实例资源进行标记,批量分类实例资源,实现对实例资源进行分组查询、分析及管理。 用户可在标签管理服务(Tag Management Service,简称TMS)中过滤查询资源、分析资源及管理资源。 配置实例标签 进入API网关控制台页面。 在左侧导航栏选择“实例管理”。
当API的请求协议为GRPC类型时不支持配置。 result_failure_sample String 失败返回示例,描述API的异常返回信息。字符长度不超过20480 说明: 中文字符必须为UTF-8或者unicode编码。 当API的请求协议为GRPC类型时不支持配置。 authorizer_id
配置API的自定义认证 配置API的前端自定义认证 配置API的后端自定义认证 父主题: 管理API
编辑健康检查配置 操作场景 VPC通道创建完成后,可通过编辑健康检查配置修改健康检查项。 前提条件 已创建VPC通道。 操作步骤 进入共享版控制台。 单击“开放API > VPC通道”,进入到VPC通道列表页面。 单击“VPC通道名称”,进入VPC通道详情页面。 单击“健康检查”,进入“健康检查”页签。
Time 创建时间 表5 identities参数说明 名称 类型 说明 name String 参数名称 location String 参数位置: HEADER:头 QUERY:query 响应消息样例: { "total":1, "size":1, "authorizer_list":[
说明 id String 参数编号 name String 参数名称 type String 参数类型 location String 参数位置 default_value String 参数默认值 sample_value String 参数示例值 required Integer
mapped_param_location String 编排后的参数位置,支持query和header。 表5 OrchestrationMap 参数 参数类型 描述 map_param_list Array of strings 用于映射编排后参数的列表配置,当orchestration_strate
配置API的发布环境和环境变量(可选) 环境是指API的受限使用范围,API只有在发布到环境后,才能被调用。API可以被发布到不同的自定义环境中,如开发环境、测试环境等。RELEASE是系统默认的发布环境,也是正式发布环境。 环境变量是指在环境上创建的一种变量,该变量固定在环境上
专享版API网关 instance_id,node_ip 专享版API网关节点 instance_id,api_id API 父主题: 查看监控指标与配置告警
说明 id String 参数编号 name String 参数名称 type String 参数类型 location String 参数位置 default_value String 参数默认值 sample_value String 参数示例值 required Integer
mapped_param_location 是 String 编排后的参数位置,支持query和header。 表5 OrchestrationMap 参数 是否必选 参数类型 描述 map_param_list 否 Array of strings 用于映射编排后参数的列表配置,当orchestration_str