检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
配置API请求参数后,单击“调试”。 在页面下方返回结果回显区域打印API调用的Response信息。 调用成功时,返回HTTP状态码为“200”和Response信息。 调试失败时,返回HTTP状态码为4xx或5xx,具体错误信息请参见错误码。 您可以通过调整请求参数与参数值,发送不同的请求,验证API服务。
(可选)根据实际需要定义API的请求参数,请求参数定义见下表。 表3 请求参数 信息项 描述 参数名 参数的名称,如果参数在“Path”位置,参数名称会同步“路径”中的名称。 说明: 参数名不能是x-apig- 、x-sdk-开头,不区分大小写。 参数名不能是x-stage,不区分大小写。 参数位置为HE
将支持简易认证的API绑定到已创建的凭据。 发送请求时,增加请求头部参数“X-Apig-AppCode”,省略请求签名相关信息。 以Curl方式为例,增加头部参数名称:X-Apig-AppCode,参数值填已生成的AppCode。 curl -X GET "https://api
果导入全部接口,则忽略此参数。 OpenAPI API网关 Postman Collection API Arts API URL 当“导入方式”为“URL”时,需要填写API资产的URL地址。 根据表2参数信息配置资产基本信息。 表2 资产基本信息 参数名称 说明 资产名称 自定义API资产的名称。
环境定义了API生命周期管理过程中的不同状态,API可以被发布到不同的自定义环境中。 调用不同环境的API,一般通过在API调用的请求头增加指定的头部参数,头部参数名固定为x-stage,它的取值为环境名,用以区分不同的环境。 环境变量 在环境上创建可管理的一种变量,该变量固定在环境上。通过创建环
在域名所在行单击“添加SSL证书”。 根据下表参数信息,配置SSL证书。 仅支持添加pem编码格式的SSL证书。 添加的SSL证书仅支持RSA、ECDSA和DSA加密算法。RSA为不安全的加密算法,推荐您使用ECDSA和DSA加密算法。 表2 SSL证书配置 参数 配置说明 证书名称 填写SSL
线调测时,用户登录华为云账号后,API中心会为您自动获取Token或者自动生成临时AK/SK,帮助您直接进行在线调测;调用API时,可根据参数填写项的提示链接和指导文档,获取用户Token和AK/SK。 如果是来源于华为云市场的API商品,可按照页面提示完成购买,然后在“买家中心
涉及敏感信息或个人隐私数据的API,应提供数据传输和存储过程中的安全机制 本条规则是MUST类型的基本规则,可保障API的安全合规。 API接口参数传输和存储过程中,敏感信息和个人隐私数据禁止明文传输和存储,避免造成敏感信息或个人隐私数据泄露。敏感信息和个人隐私数据包括: 密码、AK/SK、Token等身份凭据。
导入全部接口,则忽略此参数。 OpenAPI API网关 Postman Collection API Arts API URL 当“导入方式”为“URL”时,需要填写API资产的URL地址。 根据表2参数信息,配置资产基本信息。 表2 资产基本信息 参数名称 说明 资产名称 自定义API资产的名称。
已成功申请入驻成为API中心服务商。具体操作指导参见服务商入驻。 查看步骤 进入API中心服务页面。 在左侧导航栏选择“API数据分析”。 资源概览区域参数的含义如表1所示。 表1 资源概览参数说明 参数名称 含义 API总数 API网关代理中,已创建的API的总个数。数据1个小时刷新一次。 API分组总数 API网
息中获取的URL。 {Query}:查询参数,可选,格式为“参数名=参数取值”,例如limit=10,多个查询参数之间使用“&”隔开。需根据获取API的请求信息中获取的请求参数进行设置。 {Header}:请求头参数,格式为“参数名: 参数取值”,例如Content-Type:
说明 X-Request-Id 请求ID 所有合法请求,都会返回此参数 X-Apig-Latency 从API网关代理接收请求到后端返回消息头的用时 仅在请求消息头包含X-Apig-Mode: debug时,返回此参数 X-Apig-Upstream-Latency 从API网关代理请求后端到后端返回消息头的用时
API请求方法和URI。 API请求参数说明,包括Header、Query参数,需要明确字段内容和取值范围。 API请求Body内容,Body内容需要明确请求结构体内容及各个字段的取值范围。 API响应状态码,状态码及对应的说明。 API响应参数说明包括Header参数,需要明确字段内容和取值范围。
请求协议:选择协议类型,此处选择“HTTPS”。 子域名:创建API分组时,系统默认分配的一个子域名。 路径:接口请求的路径。请求路径可以包含请求参数,请求参数使用{}标识,例如/a/{b},也可以通过配置'+'号做前缀匹配,例如:/a/{b+}。 匹配模式 分为两种模式: 绝对匹配:调用的请
针对部分API进行流量控制。 使用限制 同一个环境中,一个API只能被一个流控策略绑定,但一个流控策略可以绑定多个API。 配置参数说明 表1 配置参数说明 信息项 描述 策略名称 API流控策略名称。 类型 分“基础流控”和“共享流控”两类。 基础流控:针对单个API进行流量统计和控制。
导入全部接口,则忽略此参数。 OpenAPI API网关 Postman Collection API Arts API URL 当“导入方式”为“URL”时,需要填写API资产的URL地址。 根据表2参数信息,配置资产基本信息。 表2 资产基本信息 参数名称 说明 资产名称 自定义API资产的名称。
访问控制策略绑定。 同一个环境中,一个API只能被一个限制账号名的访问控制策略绑定。 一个访问控制策略可以绑定多个API。 配置参数说明 表1 配置参数说明 信息项 描述 策略名称 访问控制策略的名称。 类型 控制访问API的类型。 IP地址:允许/禁止访问API的IP地址。 账号名:允许/禁止访问API的账号名。
0303 Incorrect App authentication information. 检查请求的方法、路径、查询参数、请求体和签名使用的方法、路径、查询参数、请求体是否一致。 检查客户端机器时间是否正确。 403 APIC.0304 The app is not authorized
对话框。 单击“确定”,完成版本的切换。此时版本号旁边括号里显示“当前版本”,说明设置成功。API调用者调用此API时,API参数以“当前版本”设置的参数值为准。 查看已发布API被调用情况 如果您想要查看已发布的API被调用的情况,如API被请求调用的次数,调用失败的次数等,可以参考API数据分析章节指导操作。
每个分组在任意一个环境中,最多可以创建50个环境变量。 负载通道数量 每个用户最多可以创建10个VPC通道,每个负载通道最多可以添加10个服务器。 参数数量 每个API最多可以创建50个参数。 发布历史数量 同一个API在每个环境中最多记录10条最新的发布历史。 每个API的访问频率 不大于200次/秒。 特殊应用