检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
时填写https_port;如果要http_port和https_port同时使用默认端口,则两个参数都不填。 当修改域名时,该参数未填表示不修改该端口。 最小值:-1 最大值:49151 ingress_https_port 否 Integer 访问该域名绑定的https协议入
根据下表参数信息,配置安全配置。 表4 定义API请求 参数 配置说明 安全认证 选择API认证方式,此处选择“APP认证”。 支持简易认证 简易认证不需要对请求内容签名,API网关也仅校验AppCode,不校验请求签名,从而实现快速响应。此处勾选简易认证。 单击“下一步”,配置默认后端信息。 表5 Mock类型定义后端服务
objects 搜索字段,key为要匹配的字段,当前限定为resource_name。value为匹配的值。 根据key的值确认是否需要模糊匹配,如resource_name需要实现前缀搜索。 表4 TmsKeyValues 参数 是否必选 参数类型 描述 key 否 String 键。
name String 响应名称 responses Map<String,ResponseInfoResp> 错误类型的响应定义,其中key为错误类型。key的枚举值为: AUTH_FAILURE:认证失败 AUTH_HEADER_MISSING:认证身份来源缺失 AUTHORIZER_FAILURE:自定义认证失败
用此API的用户。 导入导出API:您可以通过API设计文件、CSE微服务、CCE工作负载、导入API到APIG。 APIG的API设计文件扩展定义:导入API设计文件时,您可以参考apig支持的扩展定义,配置API设计文件。 父主题: 管理API
objects 搜索字段,key为要匹配的字段,当前限定为resource_name。value为匹配的值。 根据key的值确认是否需要模糊匹配,如resource_name需要实现前缀搜索。 表5 TmsKeyValues 参数 是否必选 参数类型 描述 key 否 String 键。
{ "key" : "test-key", "value" : "test-value" } ] } 批量删除实例的标签 { "action" : "delete", "tags" : [ { "key" : "test-key1", "value"
支持GET、POST、PUT、HEAD请求方法。 请求协议 HTTP或HTTPS,传输重要或敏感数据时推荐使用HTTPS。 负载通道(可选) 仅在“使用”负载通道时,需要设置。选择已创建的负载通道名称,如果没有可选的负载通道,您也可以单击“新建负载通道”创建。 后端服务地址(可选)
egion没有上线函数工作流服务,则不支持自定义认证。 支持简易认证 仅当“安全认证”选择“APP认证”时可配置。 简易认证指APP认证方式下调用API时,在HTTP请求头部消息增加一个参数X-Apig-AppCode,而不需要对请求内容签名,API网关也仅校验AppCode,不校验请求签名,从而实现快速响应。
授权 功能介绍 APP创建成功后,还不能访问API,如果想要访问某个环境上的API,需要将该API在该环境上授权给APP。授权成功后,APP即可访问该环境上的这个API。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法
AppSecret is invalid 400 AppKey或AppSecret不合法 检查请求的AppKey或AppSecret是否正确 父主题: 调用已发布的API
删除APP 功能介绍 删除指定的APP。 APP删除后,将无法再调用任何API;其中,云商店自动创建的APP无法被删除。 调用方法 请参见如何调用API。 URI DELETE /v2/{project_id}/apigw/instances/{instance_id}/apps/{app_id}
APP管理 对象模型 创建APP 修改APP 重置密钥 删除APP 校验APP 查看APP详情 查询APP列表 创建App Code 自动生成App Code 查看App Code详情 查询App Code列表 删除App Code 父主题: 共享版API(仅存量用户使用)
删除签名密钥 操作场景 如果某一个密钥不再提供服务,则可以将其删除。 前提条件 已创建密钥。 操作步骤 进入共享版控制台。 单击“开放API > 签名密钥”,进入签名密钥管理信息页面。 通过以下任意一种方法,弹出对话框。 在待删除的密钥所在行,单击“删除”。 单击“密钥名称”,进
校验APP 功能介绍 校验app是否存在,非APP所有者可以调用该接口校验APP是否真实存在。这个接口只展示app的基本信息id 、name、 remark,其他信息不显示。 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/apigw/inst
APP授权 功能介绍 APP创建成功后,还不能访问API,如果想要访问某个环境上的API,需要将该API在该环境上授权给APP。授权成功后,APP即可访问该环境上的这个API。 调用方法 请参见如何调用API。 URI POST /v2/{project_id}/apigw/in
时填写https_port;如果要http_port和https_port同时使用默认端口,则两个参数都不填。 当修改域名时,该参数未填表示不修改该端口。 最小值:-1 最大值:49151 ingress_https_port 否 Integer 访问该域名绑定的https协议入
组元素包括API请求方法method、API请求路径path。 当task_type为export_api时,字段包括导出文件类型file_type、导出文件内容content。 状态码: 400 表4 响应Body参数 参数 参数类型 描述 error_code String 错误码
认证方式 APP_JWT_SWITCH:是否启用APP_JWT认证方式 APP_ROUTE_SWITCH:是否启用APP路由 PUBLIC_KEY_SWITCH:是否启用PUBLIK_KEY后端认证方式 APP_SECRET_SWITCH:是否启用APP_SECRET认证方式 C
error_code String 错误码 error_msg String 错误描述 请求示例 配置实例参数,开启app_api_key开关 { "name" : "app_api_key", "config" : "on", "enable" : true } 响应示例 状态码: