云服务器内容精选
-
目的 主要用于指导伙伴、开发者在华为云API中心生产和开放API。通过统一的API治理框架和规范,帮助伙伴、开发者构建并提供有质量保障的 API服务 ,为平台营造良好能力开放与交互的环境,支撑华为云和伙伴及开发者共建API生态。 API治理规范主要从安全、可用性、易用性、可维护性,生命周期管理六个维度针对API生产(API设计/开发/测试)和API开放提供规则建议。 安全:对API的安全认证、涉及敏感信息或个人隐私数据使用和处理提出规范要求或建议,保障API的安全合规。 可用性:对API调用成功率、响应时长、并发及流量控制、吞吐量等提出规范要求或建议,保障API的高可用性。 易用性:对API参考文档描述、入参和出参、消息头定义等提出规范要求或建议,提升API调用者使用体验。 可维护性:对于API兼容性、日志实时性和完整性、版本管理等提出规范要求或建议,提升API可维护性。 生命周期管理:对API变更和下线等提出规范要求或建议,保障已订阅API租户的业务连续性。 包含Must类型的基本规则以及Should类型的扩展规则。Must规则牵引API开发者提供符合企业级标准、安全合规的API,Should规则在提供更全面指导的基础上,给予开发者灵活的弹性空间,方便开发者更快的加入API生态圈。
-
为什么要申请入驻服务商? API中心管理控制台的以下功能只允许API中心服务商使用,如果您想要使用以下功能,需要先申请入驻成为API中心服务商: API资产管理:通过创建API资产,将您开发好的API分享至API中心门户网站,供其他开发者搜索和调用。 API网关代理:API网关代理包括API的创建、发布、下线和删除所经历的完整生命周期过程,为您提供高性能、高可用、高安全的API托管服务。 API数据分析:查看API网关代理中已发布的API被调用的情况,如被请求调用的次数,调用失败的次数等。 只允许华为云企业账号申请成为API中心服务商。 父主题: 服务商入驻
-
调用API 构造API请求,示例如下: POST https://{Address}/{Path}?{Query} {Header} { {Body} } POST:请求方法,需替换为获取API的请求信息中获取的请求方法。 {Address}:请求地址,需替换为获取API的请求信息中获取的 域名 地址。 API网关代理使用分组分配的子域名或分组绑定的域名调用API,无需另外配置。 {Path}:请求路径,需替换为获取API的请求信息中获取的URL。 {Query}:查询参数,可选,格式为“参数名=参数取值”,例如limit=10,多个查询参数之间使用“&”隔开。需根据获取API的请求信息中获取的请求参数进行设置。 {Header}:请求头参数,格式为“参数名: 参数取值”,例如Content-Type: application/json。需根据获取API的请求信息中获取的Headers进行设置。 {Body}:请求消息体,JSON格式。需根据获取API的请求信息中获取的请求参数进行设置。 为API请求添加认证信息。 API认证方式 API请求参数配置 APP认证(签名认证) 使用获取的SDK对API请求进行签名。 APP认证(简易认证) 在API请求中添加Header参数“X-Apig-AppCode”,参数值为获取API的认证信息中获取到的AppCode。 APP认证(app_secret认证) 在API请求中添加Header参数“X-HW-ID”,参数值为获取API的认证信息中获取到的Key。 在API请求中添加Header参数“X-HW-AppKey”,参数值为获取API的认证信息中获取到的Secret。 APP认证(app_basic认证) 在API请求中添加Header参数“Authorization”,参数值为"Basic "+base64(appkey+":"+appsecret),其中appkey和appsecret分别为获取API的认证信息中获取到的Key和Secret。 IAM 认证(AK/SK认证) 使用获取的SDK对API请求进行签名。 无认证 无需认证,可直接调用API。
-
获取API的调用信息 在调用API前,您需要向API提供方获取API的调用信息。 获取API的请求信息 向API提供方获取API的“域名”、“请求方法”、“API URL”、“请求参数”和“Headers”。 获取API的调用凭据 根据API使用的安全认证方式不同,还要获取相关的请求认证信息,具体参考表1。 表1 认证信息 认证方式 认证信息 APP认证(签名认证) 向API提供方获取该API所授权凭据的Key和Secret,以及认证签名所使用的SDK。 APP认证(简易认证) 向API提供方获取该API所授权凭据的AppCode。 APP认证(app_secret认证) 向API提供方获取该API所授权凭据的Key和Secret。 APP认证(app_basic认证) 向API提供方获取该API所授权凭据的Key和Secret。 IAM认证(AK/SK认证) 获取云服务平台的用户账号的AK/SK,以及认证签名所使用的SDK。 无认证 无需认证信息。
-
后续操作 创建完API资产后,您还可以执行表3的操作。 表3 后续操作 操作 说明 查看API资产详情 在API资产列表页,单击API资产名称,查看API资产详情。 修改API资产信息 在API资产列表页,单击API资产所在行“操作”列的“编辑”,修改API资产信息。 删除API资产 在API资产列表页,单击API资产所在行“操作”列的“删除”。 查看API资产包含的接口信息 在API资产列表页,单击API资产所在行“状态”列的“查看”。
-
配置参数说明 表1 配置参数说明 信息项 描述 策略名称 访问控制策略的名称。 类型 控制访问API的类型。 IP地址:允许/禁止访问API的IP地址。 账号名:允许/禁止访问API的账号名。 动作 包括“允许”和“禁止”。 和“类型”配合使用,允许/禁止访问API的IP地址/账号名。 IP地址 输入需要允许或者禁止访问API的IP地址,或IP地址范围。 仅在“类型”为“IP地址”时,需要设置。 说明: 允许或禁止访问的IP地址条数,分别最多可以配置100条。 账号名 输入需要允许或者禁止访问API的账号名,仅在API的安全认证方式为“华为IAM认证”时适用。 仅在“类型”为“账号名”时,需要设置。支持输入多个账号名,以英文“,”隔开,如aaa,bbb。 说明: 仅支持账号维度的访问控制,不能对单个IAM用户进行访问控制。
-
获取服务商联系方式 对于不需要付费购买的API,您可以通过以下方法获取API资产服务商的联系方式。 在API中心门户网站,单击API资产。 单击页面右上角的“订阅”。 只支持已登录用户订阅服务商的联系方式。 勾选“我已阅读并同意《华为云API中心用户协议》”。 单击“确定”,完成订阅。 订阅成功后,鼠标放在“联系咨询”上面,就会显示服务商的电话和邮箱。单击“已订阅”,可以取消订阅API。 如果您想要查看当前订阅的所有API,或者对已经订阅的API单个或批量取消订阅,可以参考API订阅管理章节操作。
-
在线调测API 对于不需要付费购买的API(技术开放型API),可以通过以下步骤在线调测API,快速试用API。 单击API资产,查看API资产的开发文档。 在需要调试的接口详情页面,单击“在线调试”。 部分API未提供调试功能,具体以详情页面展示的信息为准。 对于需要付费购买的API(来源于华为云市场的API),单击API资产,在API资产详情页面,单击“API接口”页签下的“调试API”,在线调试API。
-
搜索API 搜索栏搜索 您可以在搜索栏输入您想要查找的API的一些关键信息,如API资产的名称,描述等,系统会显示相关的搜索结果。 按照不同维度搜索 API中心门户网站,按以下两种维度展示API资产: 按API维度展示:展示所有API资产。可以在左侧勾选“分类”、“可见范围”或“API来源”,按照API资产所属行业、公开性或来源路径筛选API资产。 按服务商维度展示:展示所有API资产的服务商。可以在左侧勾选分类,按行业筛选API资产服务商。单击服务商,可以看到该服务商拥有的所有API资产。
-
购买API API中心支持您在线购买来自华为云市场的API,购买流程如下。 访问API中心门户网站。 选择来自华为云市场的API。 按API维度:在左侧“API来源”中勾选“华为云市场”。同时在左侧勾选“分类”、“可见范围”,筛选API资产所属行业、公开性。 按服务商维度:单击服务商名称,然后在左侧“API来源”中勾选“华为云市场”。同时在左侧勾选“分类”、“可见范围”,筛选API资产所属行业、公开性。 单击想要购买的API,进入API详情页面。 参考商品购买流程页面步骤4~6,完成 API购买 。
-
添加特殊租户 在流控策略详情页面,单击“特殊租户”,进入特殊租户页面。 单击“添加特殊租户”,弹出“添加特殊租户”对话框。 输入租户信息。 图1 添加特殊租户 表2 特殊租户信息 信息项 描述 租户ID 绑定华为IAM认证的API时,租户ID填写API调用者的账号ID。 绑定APP认证的API时,租户ID填写APP所属者的项目ID。 您可以单击控制台右上角的用户名,选择“我的凭证”,在我的凭证页面获取用户的项目ID和账号ID。 阈值 “时长”时间内,此租户访问单个API次数的最大值。 不能大于“API流量限制”值。 单击“确定”,完成特殊租户的添加。
-
配置参数说明 表1 配置参数说明 信息项 描述 策略名称 API流控策略名称。 类型 分“基础流控”和“共享流控”两类。 基础流控:针对单个API进行流量统计和控制。 共享流控:针对绑定了该策略的所有API进行总流量统计和控制。 时长 流量限制的时长。时长单位支持秒,分钟,小时,天。 与“API流量限制”配合使用,表示“时长”时间内的单个API请求次数上限。 与“用户流量限制”配合使用,表示“时长”时间内的单个用户请求次数上限。 与“凭据流量限制”配合使用,表示“时长”时间内的单个凭据请求次数上限。 与“源IP流量限制”配合使用,表示“时长”时间内的单个IP地址请求次数上限。 API流量限制 单个API被调用次数上限。 与“时长”配合使用,表示“时长”时间内的单个API请求次数上限。 用户流量限制 单个用户调用API次数上限,仅在API的安全认证方式为“华为IAM认证”时适用。 不能大于“API流量限制”的值。 与“时长”配合使用,表示“时长”时间内的单个用户请求次数上限。 如果主账号下有多个子用户访问API,按主账号累计的调用次数进行限制。 说明: 如果希望单独为某个用户添加流量控制策略,可以通过对该策略增加特殊租户实现,具体参考添加特殊租户。增加特殊租户后,此用户调用API次数的上限受增加特殊租户时设置的“阈值”限制,其他用户调用API次数的上限,仍然受本参数值限制。 凭据流量限制 单个凭据调用API次数上限,仅在API的安全认证方式为“APP认证”时适用。 不能大于“API流量限制”的值。 与“时长”配合使用,表示“时长”时间内的凭据请求次数上限。 说明: 如果希望单独为某个凭据添加流量控制策略,可以通过对该策略增加特殊应用实现,具体参考添加特殊应用。增加特殊应用后,此凭据调用API次数的上限受增加特殊应用时设置的“阈值”限制,其他凭据调用API次数的上限,仍然受本参数值限制。 源IP流量限制 单个IP地址调用API次数上限。 不能大于“API流量限制”的值。 与“时长”配合使用,表示“时长”时间内的IP地址请求次数上限。 描述 关于控制策略的描述。
-
操作步骤 进入API中心服务页面。 在左侧导航栏选择“服务商入驻”。 单击页面中间的“立即入驻”。 图1 入驻API中心服务商 也可以在API中心门户网站,单击页面右上角的“服务商入驻”,进入服务商入驻页面。 填写服务商信息。 图2 申请入驻API中心 如果您已入驻成为华为云云商店服务商,则系统会自动填充服务商信息,您不需要再次填写服务商信息,直接执行5即可。 最多支持输入2个电话和2个邮箱。 勾选“我已阅读并同意《华为云API中心服务商合作协议》和《华为云隐私政策声明》”,单击“立即提交”。 根据您是否需要使用API网关代理功能,选择对应的操作。 是:通过向系统提交工单,说明您的业务场景和诉求。 否:直接执行7。 如果入驻服务商时没有开通API网关代理功能,后续如果想要使用API网关代理,可以变更服务商信息,然后向系统提交工单,联系API中心运营人员开通此功能。 等待审核。5个工作日内完成审核。您可以登录API中心,查看审核进展。 审核通过后,您登录API中心管理控制台,就可以看到API资产管理等菜单了。
-
入驻API中心服务商 进入API中心服务页面。 在左侧导航栏选择“服务商入驻”。 单击页面中间的“立即入驻”。 图2 入驻API中心服务商 也可以在API中心门户网站,单击页面右上角的“服务商入驻”,进入服务商入驻页面。 填写服务商信息。 图3 申请入驻API中心 如果您已入驻成为华为云云商店服务商,则系统会自动填充服务商信息,您不需要再次填写服务商信息,直接执行5即可。 最多支持输入2个电话和2个邮箱。 勾选“我已阅读并同意《华为云API中心服务商合作协议》和《华为云隐私政策声明》”,单击“立即提交”。 根据您是否需要使用API网关代理功能,选择对应的操作。 是:联系API中心运营人员,并告知其您需要使用API网关代理功能。 否:直接执行7。 如果入驻服务商时没有开通API网关代理功能,后续如果想要使用API网关代理,可以变更服务商信息,然后联系API中心运营人员开通此功能。 等待审核。5个工作日内完成审核。您可以登录API中心管理控制台,查看审核进展。 审核通过后,您登录API中心管理控制台,就可以看到API资产管理等菜单了。
-
2023年3月 序号 功能名称 功能描述 阶段 相关文档 1 优化服务商入驻 已经入驻华为云云商店的服务商,入驻API中心服务商时,系统会自动填充服务商信息。 公测 服务商入驻 2 优化API资产上架 支持将用户在华为云云商店上架的API资产,周期性地自动上架至API中心门户网站,并展示在管理控制台的API资产列表页。 公测 API资产管理 3 新增API数据分析 支持查看API网关代理中已发布的API被调用的情况,如被请求调用的次数,调用失败的次数等。 公测 API数据分析 4 优化创建API资产 创建API资产时,同一个华为云账号下的API资产名称不能重复。 公测 API资产管理
更多精彩内容
CDN加速
GaussDB
文字转换成语音
免费的服务器
如何创建网站
域名网站购买
私有云桌面
云主机哪个好
域名怎么备案
手机云电脑
SSL证书申请
云点播服务器
免费OCR是什么
电脑云桌面
域名备案怎么弄
语音转文字
文字图片识别
云桌面是什么
网址安全检测
网站建设搭建
国外CDN加速
SSL免费证书申请
短信批量发送
图片OCR识别
云数据库MySQL
个人域名购买
录音转文字
扫描图片识别文字
OCR图片识别
行驶证识别
虚拟电话号码
电话呼叫中心软件
怎么制作一个网站
Email注册网站
华为VNC
图像文字识别
企业网站制作
个人网站搭建
华为云计算
免费租用云托管
云桌面云服务器
ocr文字识别免费版
HTTPS证书申请
图片文字识别转换
国外域名注册商
使用免费虚拟主机
云电脑主机多少钱
鲲鹏云手机
短信验证码平台
OCR图片文字识别
SSL证书是什么
申请企业邮箱步骤
免费的企业用邮箱
云免流搭建教程
域名价格