检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
可用性 API需要配置并发请求及流量控制 本条规则是Should类型的扩展规则,可提升API的可用性。 在API发布之前,需要根据设计的服务等级标准进行流量控制设置。API流量控制包括三个部分:并发请求控制,吞吐量控制和传输流量控制。
是否必须使用API中心的网关代理功能? 更多 智能客服 您好!我是有问必答知识渊博的智能问答机器人,有问题欢迎随时求助哦! 社区求助 华为云社区是华为云用户的聚集地。这里有来自容器服务的技术牛人,为您解决技术难题。
与其他服务的关系 API Arts API中心将API Arts作为API生产工具提供给API开发者,并支持API开发者将工具中的API文档一键发布到API中心进行分享和开放。
安全性 API使用合适的认证模式 本条规则是Should类型的扩展规则,可提升API的安全性。 根据具体业务场景,选择API调用的认证模式,具体说明如表1所示。
易用性 API名称必须易于理解、见名知义 本条规则是Should类型的扩展规则,可提升API调用者的使用体验。 API名称要简洁、易于理解、见名知义,建议按照“动词+名词”格式。
API是服务端和客户端的契约,不能单方面破坏契约。通过如下的方式来保证向后的兼容性: 遵循兼容扩展标准。 忽略请求/响应中的未知字段。 只添加可选字段,不能添加必选字段。 不能更改字段的含义。 当资源URL发生变化的时候,支持重定向。
创建策略 通过策略的方式,为API提供灵活的控制策略和扩展能力。 前提条件 一个API只能绑定一个相同类型的策略。 策略和API本身相互独立,只有为API绑定策略后,策略才对API生效。为API绑定策略时需指定发布环境,策略只对指定环境上的API生效。
扩展覆盖 勾选后,当导入API的扩展定义项名称(流控,访问控制,插件等)与已有的策略(流控,访问控制,插件等)名称相同时,会覆盖已有的策略(流控,访问控制,插件等)。 是否覆盖 勾选后,当导入API的名称与已有API的名称相同时,导入的API会覆盖已有的API。
生命周期管理:对API变更和下线等提出规范要求或建议,保障已订阅API租户的业务连续性。 包含Must类型的基本规则以及Should类型的扩展规则。
新版本API为兼容旧版本,增加的字段不建议作为强制填写的字段,字段取值范围不建议小于原有的取值范围。 API文档记录API接口变更 本条规则是Should类型的扩展规则,可方便管理API的生命周期。
如果API提供正常业务时涉及个人数据(包含收集、使用、转移、存储等),必须在API发布过程中提供产品隐私声明,描述收集的所有个人数据类型、目的、处理方式、时限等。 建议使用POST/PUT方式提交个人数据 本条规则是Should类型的扩展规则,给API开发者提供灵活的弹性空间。
获取API的调用凭据 根据API使用的安全认证方式不同,还要获取相关的请求认证信息,具体参考表1。 表1 认证信息 认证方式 认证信息 APP认证(签名认证) 向API提供方获取该API所授权凭据的Key和Secret,以及认证签名所使用的SDK。
是否必须使用API中心的网关代理功能? 不是。如果您的API已经注册在自有网关或者其他第三方网关,API中心仍然支持您创建API资产,将API展示在API中心门户网站。 父主题: API网关代理
父主题: 调用已发布的API
调用已发布的API 调用API 响应消息头 错误码 父主题: API网关代理
其中API前端定义除了Swagger规范定义项外,还包括API网关代理的一些Swagger扩展字段。 全量定义:导出API前端定义和后端定义。 扩展定义:导出API前端定义、后端定义、API关联的流量控制、访问控制等策略及绑定关系。 导出格式 选择JSON或YAML。
调用请求包的大小 API每次最大可以调用12M的请求包。 TLS协议 支持TLS1.1和TLS1.2,推荐使用TLS1.2。 本章描述的“用户”指的都是华为云账号。 如果API网关代理当前的配额限制无法满足您的需求,您可以向系统提交工单申请更多配额。
前提条件 仅允许华为云账号取消入驻服务商,不允许该账号下的IAM用户取消入驻服务商。 已删除该华为云账号及其下的IAM用户注册在API网关代理的所有API。 已删除该华为云账号及其下的IAM用户分享在API中心门户网站的所有API资产。 操作步骤 进入API中心服务页面。
响应消息头 描述 说明 X-Request-Id 请求ID 所有合法请求,都会返回此参数 X-Apig-Latency 从API网关代理接收请求到后端返回消息头的用时 仅在请求消息头包含X-Apig-Mode: debug时,返回此参数 X-Apig-Upstream-Latency
安全性是华为云与您的共同责任,如图1所示。 华为云:负责云服务自身的安全,提供安全的云。华为云的安全责任在于保障其所提供的IaaS、PaaS和SaaS各类各项云服务自身的安全,涵盖华为云数据中心的物理环境设施和运行其上的基础服务、平台服务、应用服务等。