检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
附录:API的Swagger扩展定义 ROMA Connect在Swagger原有定义的基础上,定义了特有的API定义项,即扩展定义,如认证方式、后端服务定义等。本章节主要介绍API使用的扩展定义。 1:x-apigateway-auth-type 含义:基于Swagger的apiKey认证格式,定义ROMA
删除API分组 功能介绍 删除指定的API分组。 分组下存在API时分组无法删除,需要删除所有分组下的API后,再删除分组。 删除分组时,会一并删除直接或间接关联到该分组下的所有资源,包括独立域名、SSL证书等等。并会将外部域名与子域名的绑定关系进行解除(取决于域名cname方式)。
删除APP Code 功能介绍 删除App Code,App Code删除后,将无法再通过简易认证访问对应的API。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI DELETE
删除流控策略 功能介绍 删除指定的流控策略。当该流控策略绑定了API时,需要先解除流控策略与API的所有绑定关系后再删除。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI
解除绑定插件的API 功能介绍 解除绑定在插件上的API 解绑及时生效 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI PUT /v2/{project_id}/ap
解除绑定 功能介绍 解除API与签名密钥的绑定关系。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI DELETE /v2/{project_id}/apic/ins
查询环境列表 功能介绍 查询符合条件的环境列表。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI GET /v2/{project_id}/apic/instance
Kafka日志推送插件说明 概述 ROMA Connect支持收集服务集成下已开放API的调用日志信息。Kafka日志推送插件提供了把API的详细调用日志推送到Kafka的能力,方便用户获取API的调用日志信息。 使用限制 同一个API在同一个环境中只能绑定一个相同类型的插件策略,已被API绑定的插件策略无法删除。
绑定域名 概述 在开放API前,您需要为API分组绑定独立域名,用户通过独立域名访问分组内的API。 独立域名可分为内网域名和公网域名两种: 内网域名:部署在云服务平台内的业务系统,可以使用内网域名访问API。 公网域名:部署在云服务平台外的业务系统,可以使用公网域名访问API。
批量发布或下线API 功能介绍 将多个API发布到一个指定的环境,或将多个API从指定的环境下线。 注意:当action = online时,接口返回的响应中publish_id,version_id, publish_time字段才有含义。 调试 您可以在API Explore
根据版本编号下线API 功能介绍 对某个生效中的API版本进行下线操作,下线后,API在该版本生效的环境中将不再能够被调用。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI
删除签名密钥 功能介绍 删除指定的签名密钥。签名密钥绑定了API时无法删除,需要先解除与API的绑定关系后删除。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI DELETE
修改签名密钥 功能介绍 修改指定签名密钥的详细信息。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI PUT /v2/{project_id}/apic/instan
查询API下绑定的插件 功能介绍 查询指定API下绑定的插件信息 用于查询指定API下已经绑定的插件列表信息 支持分页返回 支持插件名称模糊查询 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
修改API分组 功能介绍 修改API分组属性。其中name和remark可修改,其他属性不可修改。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI PUT /v2/{
附录:API错误码 用户调用API失败时,系统返回的错误码如下所示。 表1 错误码 HTTP状态码 错误码 错误描述 解决方案 404 APIC.0101 The API does not exist or has not been published in the environment
绑定域名 概述 在开放API前,您需要为API分组绑定独立域名,用户通过独立域名访问分组内的API。 独立域名可分为内网域名和公网域名两种: 内网域名:部署在云服务平台内的业务系统,可以使用内网域名访问API。 公网域名:部署在云服务平台外的业务系统,可以使用公网域名访问API。
查询API历史版本列表 功能介绍 查询某个API的历史版本。每个API在一个环境上最多存在10个历史版本。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI GET /
查询APP列表 功能介绍 查询APP列表。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI GET /v2/{project_id}/apic/instances/{instance_id}/apps
查看流控策略详情 功能介绍 查看指定流控策略的详细信息。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI GET /v2/{project_id}/apic/inst