检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
英文格式下的小括号和冒号、中文格式下的顿号,且只能以英文、中文和数字开头,长度为3~255个字符。 所属分组 API所属的分组。选择已有的分组,如果需要新建分组,单击“新建分组”即可创建。 URL 前端地址由请求方法、请求协议、子域名和路径组成。 请求方法:GET、POST、DE
查询分组自定义响应列表 功能介绍 查询分组自定义响应列表 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/apigw/instances/{instance_id}/api-groups/{group_id}/gateway-responses
查看分组下指定错误类型的自定义响应 功能介绍 查看分组下指定错误类型的自定义响应 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/apigw/instances/{instance_id}/api-groups/{group_id}/gatew
删除分组指定错误类型的自定义响应配置 功能介绍 删除分组指定错误类型的自定义响应配置,还原为使用默认值的配置。 调用方法 请参见如何调用API。 URI DELETE /v2/{project_id}/apigw/instances/{instance_id}/api-group
创建API分组 创建API前,需要先创建API分组。API分组相当于API的集合,API提供者以API分组为单位,管理分组内的所有API。 目前支持以下创建分组方式: 直接创建 创建一个简单的分组,不包含API,用户可自行创建API。具体步骤请参见创建API分组。 导入API设计文件
API分组管理 创建API分组 绑定域名 删除分组 新增网关响应 父主题: 共享版操作指导(仅存量用户使用)
修改分组下指定错误类型的自定义响应 功能介绍 修改分组下指定错误类型的自定义响应。 调用方法 请参见如何调用API。 URI PUT /v2/{project_id}/apigw/instances/{instance_id}/api-groups/{group_id}/gate
API分组管理 对象模型 创建API分组 修改API分组 删除API分组 查看分组详情 查询分组列表 父主题: 共享版API(仅存量用户使用)
长度为3~255个字符。 所属分组 API所属的分组。选择已有的分组,如果需要新建分组,单击“新建分组”即可创建。 URL 前端地址由请求方法、请求协议、子域名和路径组成。 请求方法:默认为POST。 请求协议:默认为GRPCS.。 子域名:所在分组的调试域名。 路径:需要根据实际业务从以下三种配置方式中选择配置。
配置API的调用域名 API分组创建后,系统为分组自动分配一个内部测试用的调试域名,此调试域名每天最多可以访问1000次。因此,在开放API前,您需要为API分组绑定独立域名,用户通过独立域名访问分组内的API。最多可以添加5个独立域名,不限访问次数。 独立域名可分为内网域名和公网域名两种:
查询API分组概况 功能介绍 查询租户名下的API分组概况:上架的API分组个数,未上架的API分组个数。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI GET /v1/{project_id}/api
导出分组下所有API 功能介绍 提供用户导出API定义的接口。 导出指定分组指定环境中发布的API的基础/全量/扩展Swagger定义。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI GET /v1/{
导入API到新分组 功能介绍 通过导入的swagger文件创建新分组和新API。swagger文件支持json以及yaml格式。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 请求方法 URI POST /v1/{project_id}/apigw/insta
导出分组下所有API 功能介绍 提供用户导出API定义的接口。 导出指定分组指定环境中发布的API的基础/全量/扩展Swagger定义。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI GET /v1.0/apigw/openapi
导入API到新分组 功能介绍 通过导入的swagger文件创建新分组和新API。swagger文件支持json以及yaml格式。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 请求方法 URI POST /v1.0/apigw/openapi URI中的参数说明如下表所示。
域名解析不正确。如果API的域名、请求方法、路径正确,且已发布到环境,有可能是没有准确解析到您的API所在分组。请检查API所在的分组域名,例如您有多个API分组,每个分组有自己的独立域名,API调用时,使用了其他分组的独立域名。 检查API是否使用OPTIONS跨域请求,如果使用OPTIONS跨域请
查询API分组概况 功能介绍 查询租户名下的API分组概况:上架的API分组个数,未上架的API分组个数。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI GET /v1.0/apigw/resources/outline/groups
是否必选 参数类型 说明 title 否 String API分组名称,导入到已有分组时不生效 version 否 String 版本号,用户输入自定义版本号或者使用默认的当前时间 description 否 String 分组描述信息 表5 paths参数说明 名称 是否必选 参数类型
查询API分组概况 功能介绍 查询租户名下的API分组概况。 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/apigw/instances/{instance_id}/resources/outline/groups 表1 路径参数 参数 是否必选
是否必选 参数类型 说明 title 否 String API分组名称,导入到已有分组时不生效 version 否 String 版本号,用户输入自定义版本号或者使用默认的当前时间 description 否 String 分组描述信息 表5 paths参数说明 名称 是否必选 参数类型