检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
授权API 操作场景 API在创建后，通过指定授权给某些应用，让指定应用能够调用API。 仅在API发布到环境后，才支持被授权。 仅在API为APP认证时，才支持授权给应用。 前提条件 已创建API分组和分组内的API。 （可选）已创建环境。 已创建应用。 操作步骤 进入共享版控制台。
查询API概况 功能介绍 查询租户名下的API概况：已发布到RELEASE环境的API个数，未发布到RELEASE环境的API个数。 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/apigw/instances/{instance_id}/r
异步导出API 功能介绍 导出分组下API的定义信息。导出文件内容符合swagger标准规范，API网关自定义扩展字段请参考《API网关用户指南》的“导入导出API：扩展定义”章节。 调用方法 请参见如何调用API。 URI POST /v2/{project_id}/apigw/
如何调用API 构造请求 认证鉴权 返回结果
导入导出API 限制与兼容性说明 导入API 导出API 扩展定义 父主题： API管理
实例ID，在API网关控制台的“实例信息”中获取。 api_id 是 String API编号 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。
插件可见范围。global：全局可见。 env_id String 绑定API的环境编码。 env_name String api授权绑定的环境名称 api_id String 绑定的API编码。 api_name String API的名称 attached_time String 绑定时间。
在APIG中创建自定义的函数认证，APIG通过此函数对接后端认证系统，获取后端服务的访问授权。 自定义认证依赖函数工作流服务。如果当前Region没有上线函数工作流服务，则不支持使用自定义认证。 自定义认证的具体使用指导，可参考《API网关开发指南》。 使用自定义认证调用API的流程如下图所示：
请求方法 URI DELETE /v1.0/apigw/api-groups/{id} URI中的参数说明如下表所示。 表2 参数说明 名称 是否必选 类型 说明 id 是 String 分组的编号 请求消息 无 响应消息 无 状态码 表3 返回消息说明 状态码 说明 204 No Content
说明 api_id String 下线成功的API ID api_name String 下线成功的API名称 表7 failure参数说明 名称 类型 说明 api_id String 发布或下线失败的API ID api_name String 发布或下线失败的API名称 error_code
Object API的认证类型对象数组定义，参考表 security参数说明 x-apigateway-access-control 否 Object API绑定的访问控制对象数组定义 x-apigateway-backend 否 Object API的后端信息，参考表 x-apigateway-backend参数说明
API的响应码如何定义？ API响应码分两种。 一种是网关响应码。当请求到达网关时，由于API的流量控制、访问控制策略以及认证失败，网关直接返回的响应信息。有关网关响应的详细指导，请参考网关响应。 一种是后端服务响应。响应信息由后端API服务（即API的提供者）定义，API网关只做透传。
删除API分组 功能介绍 删除指定的API分组。 删除API分组前，要先下线并删除分组下的所有API。 删除时，会一并删除直接或间接关联到该分组下的所有资源，包括独立域名、SSL证书信息等等。并会将外部域名与子域名的绑定关系进行解除（取决于域名cname方式）。 URI HTTP
API控制策略 API流量控制 API访问控制
security参数说明 x-apigateway-access-control 否 Object API绑定的访问控制对象数组定义 x-apigateway-backend 否 Object API的后端信息，参考表 x-apigateway-backend参数说明 x-apigateway-backend-policies
已购买API 操作场景 API网关共享版支持查看已购买的API，明确已购买服务的详情。并通过调试API，验证服务是否正常。 已购买的API，需要通过APP认证方式调用。 前提条件 已从云商店购买了API。 操作步骤 进入共享版控制台。 单击“调用API > 已购买API”，进入到已购买API分组信息页面。
使用APP认证调用API 认证前准备 APP认证工作原理 Java Go Python C# JavaScript PHP C++ C Android curl
API调用是否支持长连接 支持。 注意适当使用长连接，避免占用太多资源。 父主题： API调用
DELETE /v1.0/apigw/apis/versions/{version_id} URI中的参数说明如下表所示。 表2 参数说明 名称 是否必选 类型 说明 version_id 是 String API版本的编号 请求消息 无。 响应消息 无 状态码 表3 返回消息说明 状态码 说明
删除API分组 功能介绍 删除指定的API分组。 删除API分组前，要先下线并删除分组下的所有API。 删除时，会一并删除直接或间接关联到该分组下的所有资源，包括独立域名、SSL证书信息等等。并会将外部域名与子域名的绑定关系进行解除（取决于域名cname方式）。 调用方法 请参见如何调用API。
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
