检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
英文逗号隔开。 定义返回结果。 在“返回结果基础定义”区域,填写返回信息。 表10 定义返回结果 信息项 描述 成功响应示例 成功调用API时,返回的响应信息示例。 失败响应示例 调用API失败时,返回的响应信息示例。 单击“完成”,进入“API运行”页面,可查看API详情。 后续操作
API描述信息必须易于理解,表述准确 本条规则是Should类型的扩展规则,可提升API调用者的使用体验。 API描述信息要易于理解,字面表述准确,能说明API的用途,场景及约束。 API描述信息建议使用Markdown格式编写,便于生成对应API文档,API描述信息长度建议不超过2000字符。
成长地图 | 华为云 API中心 API中心(API Hub)是为API开发者和应用开发者构建的,海量API的汇聚运营平台。帮助API开发者高效便捷地分享和开放API,支持应用开发者快速查找所需API并进行应用开发和集成。API中心贯通并粘合API生产、API开放和API消费,促
中心服务商,需要先参考服务商入驻章节,入驻成为API中心服务商,然后才能创建API资产。) 图1 申请发布 填写API资产信息。详细指导参考填写API资产信息。
中心服务商,需要先参考服务商入驻章节,入驻成为API中心服务商,然后才能创建API资产。) 图1 申请发布 填写API资产信息。详细指导参考填写API资产信息。
在左侧导航栏选择“API网关代理 > API分组”。 单击右上角的“创建API分组”,选择下拉框中的“创建API分组”。 在弹框中填写分组信息。 表1 分组信息表 信息项 描述 分组名称 API分组名称,用于将API接口进行分组管理。 描述 对分组的介绍。 单击“确定”,创建完成。 导入Swagger文件
在流控策略详情页面,单击“特殊租户”,进入特殊租户页面。 单击“添加特殊租户”,弹出“添加特殊租户”对话框。 输入租户信息。 图1 添加特殊租户 表2 特殊租户信息 信息项 描述 租户ID 绑定华为IAM认证的API时,租户ID填写API调用者的账号ID。 绑定APP认证的API时,租户ID填写APP所属者的项目ID。
进入API中心服务页面。 在左侧导航栏选择“API网关代理 > API分组”。 单击分组名称。 单击“分组信息”页签。 在“域名管理”区域,单击“绑定独立域名”,并在弹窗中配置域名信息。 表1 独立域名配置 信息项 描述 域名 填写要绑定的域名。 支持最小TLS版本 选择域名访问所使用的最小TLS版本,TLS1
在“AppCodes”区域,单击“添加AppCode”。 在弹窗中配置AppCode,完成后单击“确定”。 表1 配置AppCode 信息项 描述 生成方式 选择AppCode的生成方式。 自动生成:由系统随机生成AppCode。 手动输入:自定义AppCode。 AppCode
进入API中心服务页面。 在左侧导航栏选择“API网关代理 > API列表”。 单击页面右上角的“导出API”,设置导出参数。 表1 导出API 信息项 描述 API分组 选择待导出API所在的API分组。 运行环境 选择待导出API所在的环境。 API 默认导出API分组所在环境的所有
吞吐量(TPS)控制:指API单位时间内可并发处理的能力。 传输流量控制:指API单位时间内传输的数据量。 API发布过程中必须保证API注册信息的准确性 本条规则是MUST类型的基本规则,可保障API的高可用性。 API发布是API生命周期中重要的部分,因此在发布过程中需要保证AP
(HTTP/1.1): Semantics and Content),常用状态码如表1所示。 表1 常用状态码 状态码 状态码表示 状态码详细信息 200 OK 执行成功,如:查询成功响应。 201 Created 创建成功,如:创建记录成功。 400 Bad Request 客户端
同一个环境中,一个API只能被一个限制账号名的访问控制策略绑定。 一个访问控制策略可以绑定多个API。 配置参数说明 表1 配置参数说明 信息项 描述 策略名称 访问控制策略的名称。 类型 控制访问API的类型。 IP地址:允许/禁止访问API的IP地址。 账号名:允许/禁止访问API的账号名。
API数据分析:查看API网关代理中已经发布的API被调用的情况,如被请求调用的次数,调用失败的次数等。 支持区域: 华北-北京四 服务商入驻 变更服务商信息 取消入驻服务商 生产API API中心为开发者引入自动化的API工具(如API Arts),帮助API开发者高效设计/开发/测试API。支持从API
检查APP是否授权访问API。 401 APIC.0305 Incorrect authentication information. 检查认证信息是否正确。 403 APIC.0306 API access denied. 检查是否授权访问API。 401 APIC.0307 The
取消入驻服务商 您如果想要取消在API中心入驻服务商,可以参考本章指导操作。 前提条件 仅允许华为云账号取消入驻服务商,不允许该账号下的IAM用户取消入驻服务商。 已删除该华为云账号及其下的IAM用户注册在API网关代理的所有API。 已删除该华为云账号及其下的IAM用户分享在API中心门户网站的所有API资产。
产品功能 表1 API中心功能概览 功能名称 功能描述 发布区域 API设计和测试 API开发者可使用API中心工具库中的API生产工具(如华为云API Arts),进行API的设计、测试等。 华北-北京四 服务商入驻 API开发者可在线申请入驻成为API中心的服务商。 华北-北京四
概述 简介 术语 父主题: 附录-API治理规范指导
规范要求 API生产 API开放 父主题: 附录-API治理规范指导
API分组 创建API分组 域名管理 环境变量 父主题: API网关代理