检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
务时,保障后端服务的安全。 签名密钥由一对Key和Secret组成,签名密钥需要绑定到API才能生效。当签名密钥绑定API后,API网关代理向后端服务发送此API的请求时,会增加相应的签名信息,此时需要后端服务依照同样方式进行签名,通过比对签名结果和API网关代理传过来的Auth
景,一站式体验。 服务商入驻 服务商入驻 API订阅管理 API订阅管理 API资产管理 创建API资产 API网关代理 创建API分组 域名管理 创建API 调试API 发布API 授权API 下线API 创建凭据 创建策略 创建负载通道 创建环境 调用API API数据分析 API数据分析
选择API需要发布到的环境,并填写发布说明。 如果API在选择的环境中已发布,再次发布即为覆盖该环境的API。 如果在选择环境时,没有自己需要的环境,单击“创建环境”链接,创建一个自己需要的环境。 单击“确定”,完成API发布。 已发布的API因为其他原因需要暂停对外提供服务
创建环境成功后,在“环境管理”页面的列表中显示新创建的环境。 访问环境 通过RESTful API可以访问API默认的RELEASE环境,如果访问其他环境,需要在请求头中添加X-Stage头,内容为环境名。例如访问名为“DEVELOP”的环境,则添加“X-Stage:DEVELOP”。 管理控制台
API请求URI中如果存在特殊字符,需要进行转义编码 本条规则是MUST类型的基本规则,可保障API的高可用性。 某些字符,由于有特殊含义或者系统保留,容易被Web应用防火墙或者安全访问控制产品所阻断,导致URI调用不生效,因此不建议在URI中使用,如果必须要用需要用转义编码替换。 转义说明可参考:RFC
调试API API创建后需要验证服务是否正常,管理控制台提供调试功能,您可以添加HTTP头部参数与body体参数,调试API接口。 后端路径中含有环境变量的API,不支持调试。 如果API已绑定流控策略,在调试API时,流控策略无效。 前提条件 已搭建完成后端服务。 操作步骤 进入API中心服务页面。
下线API 已发布的API因为其他原因需要暂停对外提供服务,可以暂时将API从相关环境中下线。 该操作将导致此API在指定的环境无法被访问,请确保已经告知使用此API的用户。 前提条件 已创建API分组和分组内的API。 API已发布到该环境。 操作步骤 进入API中心服务页面。
创建凭据并绑定API 使用APP认证的API,需要在API网关代理中创建一个凭据,以生成凭据ID和密钥对(Key、Secret)。将创建的凭据绑定API后,才可以使用APP认证调用API。 安全认证方式为“无认证”或“华为IAM认证”的API,无需创建凭据。 创建凭据 进入API中心服务页面。
API策略”。 在“策略管理”页面,单击“创建策略”。 单击需要创建的策略类型。 传统策略 不同的策略类型,策略内容的配置不同: 流量控制策略说明 访问控制策略说明 签名密钥策略说明 单击“确定”。 策略创建后,您还需要为API绑定策略,才能使策略对API生效。 为API绑定策略
授权”。 单击“添加授权”。 选择API授权环境,查询并勾选凭据后,单击“确定”。在“授权历史”弹窗中展示已授权的凭据。 如果已授权的凭据需要解除授权,在“授权历史”弹窗中,选择需解除授权的凭据,单击“操作”列“解除授权”。 父主题: API列表
API下线前必须提前通知订阅服务的用户 本条规则是MUST类型的基本规则,可保障API租户的业务连续性。 对于需要下线的API,需要梳理订阅该API的用户,并通过公告等方式向订阅API的用户进行提醒。通知需要在服务下线前至少6个月启动,并在公告服务下线时间后1个月内对API调用进行监控,当没有API
手动输入:自定义AppCode。 AppCode 仅手动输入方式需要填写AppCode的值。 使用AppCode进行API请求的简易认证 在创建API时,选择“APP认证”并且开启“支持简易认证”。 如果您修改已有API为简易认证,需要在修改完成后,将API重新发布,使简易认证模式生效。
Arts界面单击项目名称,进入目标项目详情页面。 在左侧选择“API发布”,然后单击“申请发布”,跳转至API中心“创建API资产”页面。(如果您不是API中心服务商,需要先参考服务商入驻章节,入驻成为API中心服务商,然后才能创建API资产。) 图1 申请发布 填写API资产信息。详细指导参考填写API资产信息。
为什么要申请入驻服务商? API中心管理控制台的以下功能只允许API中心服务商使用,如果您想要使用以下功能,需要先申请入驻成为API中心服务商: API资产管理:通过创建API资产,将您开发好的API分享至API中心门户网站,供其他开发者搜索和调用。 API网关代理:API网关代
环境变量是指在环境上创建可管理的一种变量,该变量固定在环境上。通过创建环境变量,实现同一个API,在不同环境中调用不同的后端服务。 当创建API时定义了变量标识,则需要在环境中添加变量。例如创建API时定义了变量名为“Path”,在环境1中创建了变量名“Path”,变量值“/Stage/test”,则AP
如果您已入驻成为华为云云商店服务商,则系统会自动填充服务商信息,您不需要再次填写服务商信息,直接执行5即可。 最多支持输入2个电话和2个邮箱。 勾选“我已阅读并同意《华为云API中心服务商合作协议》和《华为云隐私政策声明》”,单击“立即提交”。 根据您是否需要使用API网关代理功能,选择对应的操作。 是
和“类型”配合使用,允许/禁止访问API的IP地址/账号名。 IP地址 输入需要允许或者禁止访问API的IP地址,或IP地址范围。 仅在“类型”为“IP地址”时,需要设置。 说明: 允许或禁止访问的IP地址条数,分别最多可以配置100条。 账号名 输入需要允许或者禁止访问API的账号名,仅在API的安全认证方式为“华为IAM认证”时适用。
API请求参数说明,包括Header、Query参数,需要明确字段内容和取值范围。 API请求Body内容,Body内容需要明确请求结构体内容及各个字段的取值范围。 API响应状态码,状态码及对应的说明。 API响应参数说明包括Header参数,需要明确字段内容和取值范围。 API正常响应B
在线调测API 对于不需要付费购买的API(技术开放型API),可以通过以下步骤在线调测API,快速试用API。 单击API资产,查看API资产的开发文档。 在需要调试的接口详情页面,单击“在线调试”。 部分API未提供调试功能,具体以详情页面展示的信息为准。 对于需要付费购买的API
认证描述 AppKey 在API请求Header或者Query中携带AppId和AppKey用于进行身份认证,该认证方法直接传递密钥,在使用过程中需要使用HTTPS协议保证传输安全。 签名认证 请求Header或者Query中携带请求签名、请求时间和应用身份进行身份认证,该认证方法对请求