检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
求信息中获取的域名地址。 API网关代理使用分组分配的子域名或分组绑定的域名调用API,无需另外配置。 {Path}:请求路径,需替换为获取API的请求信息中获取的URL。 {Query}:查询参数,可选,格式为“参数名=参数取值”,例如limit=10,多个查询参数之间使用“&
0次。 独立域名:您自定义的域名,API调用者通过访问独立域名来调用您开放的API。 独立域名不能重复。 前提条件 已有独立域名。可通过域名注册服务申请新的域名。 已备案独立域名,未备案的独立域名无法被访问。备案时长需几个工作日,建议您提前进行备案。 已将独立域名CNAME解析到
在“API分组”页面,单击分组名称,进入分组详情页面。 单击“分组信息”页签。 在“域名管理”区域,单击“绑定独立域名”,填写要绑定的域名。 图1 绑定独立域名 填写的独立域名必须已备案,并且已解析,详情请参考《用户指南》域名管理章节中的“前提条件”。 步骤3:创建API 在左侧导航栏选择“API网关代理
API网关代理:API网关代理使用限制如表1所示。 表1 API网关代理使用限制 限制项 限制值 API分组数量 每个用户最多可以创建50个API分组。 独立域名数量 每个分组最多可以绑定5个独立域名。 API数量 每个用户最多可以创建200个API。 后端策略数量 每个API最多可以创建5个后端策略(不包含默认后端策略)。
为API资产设置一个图标。如果不设置,则显示默认图标。 资产简介 简单介绍下API资产的行业,用途等。 使用指南 描述API的调用方法。 资产域名 API服务的主机域名或IP,用于API在线调试。 分类 选择API资产所属行业,方便API资产在API中心门户网站按行业类别被搜索。 可见范围 公开
APIC.0303 Incorrect App authentication information. 检查请求的方法、路径、查询参数、请求体和签名使用的方法、路径、查询参数、请求体是否一致。 检查客户端机器时间是否正确。 403 APIC.0304 The app is not authorized
API名称,根据规划自定义。建议您按照一定的命名规则填写API名称,方便您快速识别和查找。 所属分组 API所属的分组。可以选择已有分组,或者单击右侧的“新建分组”链接,新建一个分组。 URL 前端地址由请求方法、请求协议、子域名和路径组成。 请求方法:GET、POST、DELETE、PUT、PA
API中心服务商在上架API资产时,如果提供了符合Swagger 2.0/OpenAPI 3.0规范的API文件,且提供了API资产的访问域名,则该API可以在线调测。 父主题: API网关代理
获取资源集合的API建议支持分页。当资源数量较多时服务的查询API需要支持分页,避免一次查询获取的资源数量过多。 不支持分页查询,则服务应该要设置一个显示条数的默认值,避免一次返回过多资源。默认返回数量需要在接口参考中对外说明,避免调用者以为查询出了全量信息。查询条件中可以设定查询数量(limit),位移量(
单击“确定”,跳转到“API运行”页面,可查看分组下的API。 后续操作 创建API分组成功后,您还可以执行如表3的操作。 表3 后续操作 操作 说明 为API分组绑定独立域名 在开放API前,您需要为API分组绑定独立域名,API调用者通过独立域名访问分组内的API。 添加环境变量
为API资产设置一个图标。如果不设置,则显示默认图标。 资产简介 简单介绍下API资产的行业,用途等。 使用指南 描述API的调用方法。 资产域名 API服务的主机域名或IP,用于API在线调试。 分类 选择API资产所属行业,方便API资产在API中心门户网站按行业类别被搜索。 可见范围 公开
API分组 API分组是同一种业务API的集合,API开发者以API分组为单位,管理分组内的所有API。 域名管理 在开放API前,您需要为API分组绑定独立域名,API调用者通过独立域名访问分组内的API。 环境 为了方便管理API的生命周期,API网关代理定义了API受限使用范围,这
服务端提供新版本API的同时,需要对老版本API提供支持。 例如:应用A更新API查询虚拟机列表,增加多个新的查询条件。在API发布之后,之前订阅该API的应用不能因为增加了新的查询条件而造成查询虚拟机列表失败。 API请求HTTP动词使用标准化且满足幂等性 本条规则是Shoul
0.5%。 在对API日志处理过程中,仅能对API日志进行增维操作,禁止对API日志中重要部分,如请求时间、请求者身份、请求IP地址、请求域名、请求URL地址、响应时间、响应状态码进行篡改。 父主题: API开放
API分组 创建API分组 域名管理 环境变量 父主题: API网关代理
为API资产设置一个图标。如果不设置,则显示默认图标。 资产简介 简单介绍下API资产的行业,用途等。 使用指南 描述API的调用方法。 资产域名 API服务的主机域名或IP,用于API在线调试。 分类 选择API资产所属行业,方便API资产在API中心门户网站按行业类别被搜索。 可见范围 公开
API网关代理当前的配额限制无法满足您的需求时,支持您向系统提交工单申请更多配额。 支持区域: 华北-北京四 约束与限制 API搜索和查找 API中心门户网站汇聚展示千行百业API,为应用开发者提供统一的API搜索查找入口。 支持面向API资产的名称、描述字段的关键词匹配(精确/模糊搜索)。 支持搜索热搜词。 支持搜索词联想。
在左侧导航栏选择“API网关代理 > API列表”。 在API所在行,单击“操作”列的“更多 > 授权”。 单击“添加授权”。 选择API授权环境,查询并勾选凭据后,单击“确定”。在“授权历史”弹窗中展示已授权的凭据。 如果已授权的凭据需要解除授权,在“授权历史”弹窗中,选择需解除授权的凭据,单击“操作”列“解除授权”。
Semantics and Content),常用状态码如表1所示。 表1 常用状态码 状态码 状态码表示 状态码详细信息 200 OK 执行成功,如:查询成功响应。 201 Created 创建成功,如:创建记录成功。 400 Bad Request 客户端请求语义有误,当前请求无法被服务器理解或请求参数有误。
协议+域名+端口)。服务器根据这个值,决定是否同意这次请求。服务器响应消息中包含“Access-Control-Allow-Origin”时,表示同意请求。 非简单请求 不满足简单请求两个条件的都为非简单请求。 对于非简单请求,在正式通信之前,浏览器会增加一次HTTP查询请求,称