检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
HTTP/HTTPS请求方法以及URI 请求方法 URI PUT /v1.0/apigw/vpc-channels/{id} URI中的参数说明如下表所示。 表2 参数说明 名称 是否必选 类型 说明 id 是 String VPC通道的编号。 请求消息 表3 参数说明 参数 是否必选 类型 说明 name
在时以env_id为准,建议使用env_id group_id/group 是 String API分组ID,目前支持group_id和group,两个均存在时以group_id为准,建议使用group_id define 否 String 导出API的定义范围: base:基础定义
“是否必选”列表示对于“操作类型”为“C”的创建操作,对应字段是否为必选字段。 表1 ACL策略对象模型 参数 类型 说明 操作类型 是否必选 id String 黑白名单的编号 R - acl_name String 黑白名单的名称 CRU 是 entity_type String 对象类型
应字段是否为必选字段。 表1 流控对象模型 参数 类型 说明 操作类型 是否必选 id String 流控策略的编号 R - name String 流控策略的名称 CRU 是 project_id String 流控策略创建者的租户编号 - - api_call_limits Integer
应字段是否为必选字段。 表1 流控对象模型 参数 类型 说明 操作类型 是否必选 id String 流控策略的编号 R - name String 流控策略的名称 CRU 是 project_id String 流控策略创建者的租户编号 - - api_call_limits Integer
过滤查询结果 查询资源列表时(例如,查询API列表),系统支持按照查询对象的属性过滤查询结果。 示例: GET /v1.0/apigw/apis?id=xxxx 父主题: 附录
sourceIp:API调用者的源地址。 stage:API调用的部署环境。 apiId:API的ID。 appId:API调用者的APP ID。 requestId:当次调用API所生成的请求ID。 serverAddr:网关服务器的地址 。 serverName:网关服务器的名称。
12-192.168.12.19", "entity_type": "IP" } 响应消息 表3 参数说明 名称 类型 说明 id String 编号 acl_name String 名称 acl_type String 类型 PERMIT(白名单类型) DENY(黑名单类型)
info或OpenAPI info的title作为API分组名称,新创建的API分组名称不能与已有的API分组名称重名。 导入的API定义中,如果存在冲突,那么根据系统导入的先后顺序,先导入的API会显示导入成功,后导入的API会显示导入失败。例如导入的API定义中存在2个名称相同或请求路径相同的AP
PI网关服务产生的监控指标和告警信息。 命名空间 共享版:SYS.APIG API网关监控指标 表1 API网关共享版支持的监控指标 指标ID 指标名称 指标含义 取值范围 测量对象 监控周期(原始指标) avg_latency 平均延迟毫秒数 该指标用于统计测量api接口平均响应延时时间
调用API时,API网关增加如下响应消息头。 X-Apig-Mode: debug表示响应消息头增加API网关调试信息。 响应消息头 描述 说明 X-Request-Id 请求ID 所有合法请求,都会返回此参数 X-Apig-Latency 从API网关接收请求到后端返回消息头的用时 仅在请求消息头包含X-Apig-Mode:
{"error_code":"$context.error.code","error_msg":"Access denied","request_id":"$context.requestId"} 父主题: APIG的API设计文件扩展定义
"instance_id": "instance01", "instance_name": "instance_name01", "weight": 10 } ] } 响应消息 表5 参数说明 名称 类型 说明 id String VPC通道的编号。
参数说明 名称 类型 说明 group_id String 分组ID success Array 导入成功信息 failure Array 导入失败信息 表29 success参数说明 名称 类型 说明 id String 导入成功的API ID action String 导入行为:
"app_key_sample", "app_secret": "app_secret_sample" } 响应消息 表3 参数说明 参数 类型 说明 id String 编号 name String 名称 status Integer 状态 app_key String APP的key app_secret
调用API时,API网关增加下表中的响应消息头。 X-Apig-Mode: debug表示响应消息头增加API网关调试信息。 响应消息头 描述 X-Request-Id 请求ID。所有合法请求,都会返回此参数。 X-Apig-Latency 从API网关接收请求到后端返回消息头的用时。仅在请求消息头包含X-Apig-Mode:
否则请提前创建用于后端自定义认证的函数。 进入API网关控制台页面。 根据实际业务在左侧导航栏上方选择实例。 在左侧导航栏选择“API管理 > API策略”。 在“自定义认证”页面,单击“创建自定义认证”。根据下表参数说明,配置自定义认证参数。 表2 自定义认证参数说明 参数 说明
"location":"HEADER" } ] } 响应消息 表4 参数说明 名称 类型 说明 id String 编号 name String 自定义认证的名称 type String 自定义认证类型: FRONTEND:前端 BACKEND:后端
“是否必选”列表示对于“操作类型”为“C”的创建操作,对应字段是否为必选字段。 表1 签名密钥模型 参数 类型 说明 操作类型 是否必选 id String 签名密钥的编号 R - name String 签名密钥的名称 CRU 是 sign_key String 签名密钥的key
创建跨域资源共享策略 进入API网关控制台页面。 根据实际业务在左侧导航栏上方选择实例。 在左侧导航栏选择“API管理 > API策略”。 在“策略管理”页面,单击“创建策略”。 在“选择策略类型”弹窗中,选择“插件策略 > 跨域资源共享”。 在“创建策略”弹窗中,根据下表参数说明,配置策略信息。 表1