检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
调用API API提供者在API网关开放自己的API后,API调用者从API网关中调用API。 调用限制 如果您使用调试域名(创建API分组时系统分配的调试域名)访问API,该调试域名每天最多可以访问1000次。 获取API的调用信息 在调用API前,您需要向API提供者获取API的调用信息。
您需要使用独立域名/调试域名访问,使用调试域名访问时存在单日访问次数限制。可在创建API分组后,为分组绑定独立域名,独立域名需要解析到实例的弹性IP地址。 例如您有一个API,请求协议为HTTPS,Path为/apidemo,开启了公网访问,并为分组绑定了独立域名后,可使用https://{domain}/a
OpenAPI接口 导出分组下所有API 批量导出API 导入API到新分组 导入API到已有分组 父主题: 共享版API(仅存量用户使用)
API导入导出(待下线) 导出分组下所有API 批量导出API 导入API到新分组 导入API到已有分组 父主题: 专享版API(V1)(待下线)
购买API分组 Market purchase 上架API分组 Market onsell 下架API分组 Market offsell 修改配额状态 Market changeStatus 锁定/解除锁定API分组 Market lockOrUnlock 冻结/解冻API分组 Market
域名解析不正确。如果API的域名、请求方法、路径正确,且已发布到环境,有可能是没有准确解析到您的API所在分组。请检查API所在的分组域名,例如您有多个API分组,每个分组有自己的独立域名,API调用时,使用了其他分组的独立域名。 检查API是否使用OPTIONS跨域请求,如果使用OPTIONS跨域请
方案描述 API前端定义中的请求协议支持HTTPS时,API所属分组在绑定独立域名后,还需为独立域名添加SSL证书。SSL证书是进行数据传输加密和身份证明的证书,当SSL证书带有CA证书时,默认开启客户端认证即双向认证;反之,开启单向认证。 单向认证:客户端与服务端连接时,客户端需要校验服务端SSl证书合法性。
在左侧导航栏选择“API管理 > API分组”。 单击“创建API分组 > 导入CSE微服务”。根据下表参数说明,配置信息。微服务引擎详细介绍请参考微服务引擎CSE。 表1 配置信息 参数 说明 所属分组 CSE微服务导入成功后,生成的API所在的API分组。支持同步创建新的分组或选择已有分组。 类型 支持
查看是否存在DataArts服务创建的资源。 在左侧导航栏中选择“开放API > API分组”,查看分组名称。如果分组名称由“dlm_default_”开头且描述中有“default api group created by dlm”字样,则表示该分组资源由DataArts服务创建。这部分资源需要联系Data
境变量调试。 创建环境变量 选择“开放API > API分组”,进入到API分组信息页面。 通过以下任意一种方式,进入“变量管理”页签。 单击待操作的分组名称,进入分组详细信息页面。单击“变量管理”。 在待创建环境变量的分组所在行,单击“更多 > 变量管理”。 在“环境”中选择待
在左侧导航栏选择“API管理 > API分组”。单击分组名称然后单击“导出”。 或在左侧导航栏选择“API管理 > API列表”,单击“导出API”。 设置导出参数。 表1 导出API 参数 说明 API分组 选择待导出API所在的API分组。 运行环境 选择待导出API所在的环境。
CA 单向认证无需配置CA证书。 单击“确定”创建完成。 绑定域名。 在左侧导航栏选择“API管理 > API分组”。 单击API所属分组名称,进入分组详情。 在“分组信息”页签中单击“绑定独立域名”。 表2 配置独立域名 参数 配置说明 域名 填写已备案的域名。 支持最小TLS版本
支持配置传统策略和插件策略。 API网关基于REST的API架构,API的开放和调用需要遵循RESTful相关规范。 前提条件 已创建API分组。如果未创建API分组,请创建API分组。 如果后端服务需要使用负载通道,请创建负载通道。 如果需要使用自定义认证方式进行API的安全认证,请创建自定义认证。
能否修改 实例数量 每个用户最多创建5个实例。 √ API分组数量 每个实例最多创建1500个API分组。 √ API数量 每个实例: 基础版:250 专业版:800 企业版:2000 铂金版:8000 √ API数量 每个分组最多创建1000个API。 x 后端策略数量 每个实例最多创建5个后端策略。
id String API编号 name String API名称 group_id String API所属分组的编号 group_name String API所属分组的名称 remark String API描述 run_env_name String 发布的环境名 run_env_id
id String API编号 name String API名称 group_id String API所属分组的编号 group_name String API所属分组的名称 remark String API描述 run_env_name String 发布的环境名 run_env_id
id String API编号 name String API名称 group_id String API所属分组的编号 group_name String API所属分组的名称 type Integer API类型 remark String API描述 run_env_name
Gateway操作列表 操作名称 资源类型 事件名称 创建API分组 ApiGroup createApiGroup 修改API分组 ApiGroup updateApiGroup 删除API分组 ApiGroup deleteApiGroup 校验API分组名称是否存在 Swagger CheckApiGroups
String API编号 api_name 否 String API名称 group_id 否 String API分组编号 group_name 否 String API分组名称 page_size 否 Integer 每页显示的条数,默认值:20 page_no 否 Integer
API网关服务开放API基本流程 创建实例 共享版无需购买实例,可直接进入共享版。 创建API分组 每个API都归属到某一个API分组下,在创建API前应提前创建API分组。 绑定域名 在开放API前,您需要为API分组绑定一个独立域名,供API调用者访问API使用。 在绑定独立域名前,您可以使用