检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
0.5%。 在对API日志处理过程中,仅能对API日志进行增维操作,禁止对API日志中重要部分,如请求时间、请求者身份、请求IP地址、请求域名、请求URL地址、响应时间、响应状态码进行篡改。 父主题: API开放
API策略 创建策略 流量控制策略说明 访问控制策略说明 签名密钥策略说明 负载通道 环境管理 父主题: API网关代理
在“API监控”区域,展开API右侧的下拉框,选择您想要查看调用情况的API。 选择要查看的时间范围。支持查看近1个小时、近6个小时、近24个小时或近7天的调用情况。 查看API监控指标。包括“请求次数”、“调用延时”、“数据流量”和“出错统计”。 统计数据每10分钟刷新一次。 新发
安全:对API的安全认证、涉及敏感信息或个人隐私数据使用和处理提出规范要求或建议,保障API的安全合规。 可用性:对API调用成功率、响应时长、并发及流量控制、吞吐量等提出规范要求或建议,保障API的高可用性。 易用性:对API参考文档描述、入参和出参、消息头定义等提出规范要求或建议,提升API调用者使用体验。
API名称,根据规划自定义。建议您按照一定的命名规则填写API名称,方便您快速识别和查找。 所属分组 API所属的分组。可以选择已有分组,或者单击右侧的“新建分组”链接,新建一个分组。 URL 前端地址由请求方法、请求协议、子域名和路径组成。 请求方法:GET、POST、DELETE、PUT、PA
附录-API治理规范指导 概述 规范要求 工具平台
PI网关代理的一些Swagger扩展字段。 全量定义:导出API前端定义和后端定义。 扩展定义:导出API前端定义、后端定义、API关联的流量控制、访问控制等策略及绑定关系。 导出格式 选择JSON或YAML。 自定义版本 为导出的API自定义版本号,如果没有指定版本号,默认使用当前时间。
在左侧导航栏选择“API网关代理 > API策略”。 在“策略管理”页面,单击“创建策略”。 单击需要创建的策略类型。 传统策略 不同的策略类型,策略内容的配置不同: 流量控制策略说明 访问控制策略说明 签名密钥策略说明 单击“确定”。 策略创建后,您还需要为API绑定策略,才能使策略对API生效。 为API绑定策略
获取资源集合的API建议支持分页。当资源数量较多时服务的查询API需要支持分页,避免一次查询获取的资源数量过多。 不支持分页查询,则服务应该要设置一个显示条数的默认值,避免一次返回过多资源。默认返回数量需要在接口参考中对外说明,避免调用者以为查询出了全量信息。查询条件中可以设定查询数量(limit),位移量(
等方式向订阅API的用户进行提醒。通知需要在服务下线前至少6个月启动,并在公告服务下线时间后1个月内对API调用进行监控,当没有API调用流量之后,才启动正式下线。待该API到了正式下线后,API中心不再展示下线的API。 父主题: API开放
协议+域名+端口)。服务器根据这个值,决定是否同意这次请求。服务器响应消息中包含“Access-Control-Allow-Origin”时,表示同意请求。 非简单请求 不满足简单请求两个条件的都为非简单请求。 对于非简单请求,在正式通信之前,浏览器会增加一次HTTP查询请求,称
服务端提供新版本API的同时,需要对老版本API提供支持。 例如:应用A更新API查询虚拟机列表,增加多个新的查询条件。在API发布之后,之前订阅该API的应用不能因为增加了新的查询条件而造成查询虚拟机列表失败。 API请求HTTP动词使用标准化且满足幂等性 本条规则是Shoul
在左侧导航栏选择“API网关代理 > API列表”。 在API所在行,单击“操作”列的“更多 > 授权”。 单击“添加授权”。 选择API授权环境,查询并勾选凭据后,单击“确定”。在“授权历史”弹窗中展示已授权的凭据。 如果已授权的凭据需要解除授权,在“授权历史”弹窗中,选择需解除授权的凭据,单击“操作”列“解除授权”。
Semantics and Content),常用状态码如表1所示。 表1 常用状态码 状态码 状态码表示 状态码详细信息 200 OK 执行成功,如:查询成功响应。 201 Created 创建成功,如:创建记录成功。 400 Bad Request 客户端请求语义有误,当前请求无法被服务器理解或请求参数有误。
Gateway(Application Programming Interface gateway,API网关)是当前API的一个公共服务,是所有API注册和发布的入口。 JSON JSON(JavaScript Object Notation) 是一个轻量级的数据交换格式,它易于人类读写及其解析生成。
服务商入驻审核多久通过? 提交服务商入驻申请后,运营人员将在5个工作日内完成审核。您可以登录API中心管理控制台,查看审核进展。 父主题: 服务商入驻
合规证书下载 资源中心 华为云还提供以下资源来帮助用户满足合规性要求,具体请查看资源中心。 图2 资源中心 销售许可证&软件著作权证书 另外,华为云还提供了以下销售许可证及软件著作权证书,供用户下载和参考。具体请查看合规资质证书。 图3 销售许可证&软件著作权证书 父主题: 安全
使用前必读 API中心是为API开发者和应用开发者构建的海量API的汇聚运营平台。帮助API开发者高效便捷的分享和开放API,支持应用开发者快速查找所需API并进行应用开发和集成。本文将详细介绍API中心服务的基本功能以及操作步骤。
待下线的API,单击“下线”即可。 查看发布历史 进入API中心服务页面。 在左侧导航栏选择“API网关代理 > API列表”。 单击待查看发布历史的API名称,进入“API运行”页面。 单击“更多 > 发布历史”。 在版本所在行,单击“查看版本”,弹出此版本详细信息对话框。 如
如果没有特殊需求,不建议使用“自定义配置”,系统会默认生成全局标识,可在凭据详情中查看。 单击“确定”,创建凭据。 创建凭据成功后,在凭据管理页面显示新建凭据和凭据ID。 单击凭据名称,进入详情页面,查看Key和Secret。 绑定API 在“凭据管理”页面,单击凭据名称,进入详情页面。