检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
当使用APP认证,且开启了简易认证模式,API请求既可以选择使用Appkey和AppSecret做签名和校验,也可以选择使用AppCode进行简易认证。 为了确保安全,简易认证仅支持HTTPS方式调用API,不支持HTTP。 每个应用最多可创建5个AppCode。 前提条件 已创建应用。 生成AppCode
当使用APP认证,且开启了简易认证模式,API请求既可以选择使用Key和Secret做签名和校验,也可以选择使用AppCode进行简易认证。 约束与限制 为了确保安全,简易认证仅支持HTTPS或GRPCS方式调用API,不支持HTTP。 每个凭据最多可创建5个AppCode。 生成AppCode 进入API网关控制台页面。
发布的环境编号 remark String 发布描述 publish_time String 发布时间 version_id String 在线的版本号 状态码: 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String
security_group_id String 指定实例所属的安全组。 获取方法如下: 方法1:登录虚拟私有云服务的控制台界面,在安全组的详情页面查找安全组ID。 方法2:通过虚拟私有云服务的API接口查询,具体方法请参见《虚拟私有云服务API参考》的“查询安全组列表”章节。 maintain_begin
如果需要修改API参数,请在右上角单击“编辑”,进入API编辑页面。 后续操作 API调试成功后,您可以将API发布到环境,以便API调用者调用。或者出于API的安全性考虑,为API创建流控策略、创建访问控制策略和创建并使用签名密钥。 父主题: API管理
发布的环境编号 remark String 发布描述 publish_time String 发布时间 version_id String 在线的版本号 状态码: 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String
私有:选择“私有”类型时,当该API所在分组上架时,该API不会上架。 安全认证 API认证方式: APP认证:表示由API网关服务负责接口请求的安全认证。 华为IAM认证:表示借助IAM服务进行安全认证。 自定义认证:用户有自己的认证系统或服务(如使用OAuth认证),可选择“自定义认证”。
表1 API网关的错误响应类型 错误说明 默认的响应状态码 详细说明 拒绝访问 403 拒绝访问,如触发配置的访问控制策略、或异常攻击检测拦截 自定义认证配置错误 500 自定义认证方异常,通信失败、返回异常响应等错误 自定义认证失败 500 自定义认证方返回认证失败 自定义认证身份来源错误
单个用户调用API次数上限,仅在API的安全认证方式为APP认证或IAM认证时适用。 不超过“API流量限制”。 与“时长”配合使用,表示单位时间内的单个用户请求次数上限。 如果主账号下有多个子用户访问API,按主账号累计的调用次数进行限制。 凭据流量限制 单个凭据调用API次数上限,仅在API的安全认证方式为APP认证时适用。
发布的环境编号 remark String 发布描述 publish_time String 发布时间 version_id String 在线的版本号 表7 BatchFailure 参数 参数类型 描述 api_id String 发布或下线失败的API ID api_name
API网关未能成功处理API请求,从而产生的错误响应。默认网关响应为“default”。 匹配模式 此处选择“前缀匹配”。 安全认证 选择API认证方式,此处选择“无认证”。(无认证模式,安全级别低,所有用户均可访问,不推荐在实际业务中使用) 配置后端信息后,单击“下一步”。 表6 HTTP/HTTPS类型定义后端服务
API调用次数超出所配置的流量策略阈值 UNAUTHORIZED: 使用的凭据未被授权访问该API ACCESS_DENIED: 拒绝访问,如触发配置的访问控制策略、或异常攻击检测拦截 NOT_FOUND: 未匹配到API错误 REQUEST_PARAMETERS_FAILURE: 请求参数校验失败、不支持的HTTP方法
勾选后,当导入API扩展定义项名称(ACL,流控等)与已有的策略(ACL,流控等)名称相同时,会覆盖已有的策略(ACL,流控等)。 (可选)单击“全局配置(可选)”。 安全配置。请参考5.b。 后端请求配置。请参考1。 单击“下一步”,支持通过“表单”、“JSON”、“YAML”样式查看配置详情。 确认无误后,单击“提交”,完成配置。
up_id、page_size、page_no。 请求消息 表2 参数说明 名称 是否必选 类型 说明 sign_id 是 String 安全密钥编号 env_id 否 String 环境编号 api_id 否 String API编号 api_name 否 String API名称
单击“添加云服务器”,弹出“添加云服务器”对话框。 勾选需要添加的云服务器,单击“添加”。 使用共享版API网关时,待添加的云服务器的安全组必须允许100.125.0.0/16网段访问,否则将导致健康检查失败及业务不通。 单击“完成”,完成快速通道的创建。 后续操作 创建AP
询。 instance_id 是 String 实例ID,可从API网关控制台的专享版实例信息中获取。 sign_id 是 String 安全密钥编号 env_id 否 String 环境编号 api_id 否 String API编号 api_name 否 String API名称
路径:接口请求路径。此处填写“/1234”。 网关响应 API网关未能成功处理API请求,从而产生的错误响应。 默认的网关响应为“default”。 安全认证 选择API认证方式,此处选择“自定义认证”。 自定义认证 选择前提条件中已创建的自定义认证。 配置API后端 前端设置完成后,单击“下一步”,进入后端设置页面。
API调用次数超出所配置的流量策略阈值 UNAUTHORIZED: 使用的凭据未被授权访问该API ACCESS_DENIED: 拒绝访问,如触发配置的访问控制策略、或异常攻击检测拦截 NOT_FOUND: 未匹配到API错误 REQUEST_PARAMETERS_FAILURE: 请求参数校验失败、不支持的HTTP方法
0.0/12-24、192.168.0.0/16-24。 验证网络连通。 再创建一台按需的ECS,选择与专享版API网关相同的VPC、子网与安全组。只要本地数据中心能连通ECS,则与专享版API网关也能连通。 连通云专线与API网关后,然后使用专享版API网关开放API。 使用专享版API网关开放API
检查实例是否存在,使用正确的实例ID 404 APIC.7307 The security group does not exist in the VPC. 安全组在VPC不存在 使用存在的安全组 404 APIC.7310 The region does not have any AZs. 该region中不存在可用区