检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
导入API 操作场景 API网关支持导入Swagger 2.0定义的API到已有的API分组或新的API分组。Swagger是基于OpenAPI规范构建的开源工具，可以帮助您设计、构建、记录以及使用Rest API。 导入API支持单个API导入和批量API导入，主要取决于Swagger文件中包含的API数量。
对象模型 本节介绍APP的对象模型，如下表所示。 “操作类型”用于描述字段的属性，表示对应字段的值可进行的操作： C：创建；U：更新；R：读取。 “是否必选”列表示对于“操作类型”为“C”的创建操作，对应字段是否为必选字段。 表1 APP对象模型 参数 类型 说明 操作类型 是否必选
x-apigateway-backend-policies.conditions 含义：API网关定义的API后端策略条件。 作用域：x-apigateway-backend-policies 示例： paths: '/users/{userId}': get:
x-apigateway-access-controls 含义：访问控制策略名称与关联策略映射。 作用域：Swagger Object 示例： x-apigateway-access-controls: customAccessControlName: acl-type:
对象模型 API需要绑定ACL策略，ACL策略才能够对API起到保护作用。本节介绍ACL策略与API的绑定关系的对象模型，如表1所示。 “操作类型”用于描述字段的属性，表示对应字段的值可进行的操作： C：创建；U：更新；R：读取。 “是否必选”列表示对于“操作类型”为“C”的创建操作，对应字段是否为必选字段。
使用限制 专享版API（V1）的接口，只有上海二，广州，北京四，北京一，墨西哥和圣保罗局点支持注册，且仅用于存量用户使用。 请新用户在使用API时参考专享版API（V2）接口文档。 父主题： 专享版API（V1）（待下线）
进入“绑定API”页面。 在待绑定的流量控制策略所在行，单击“绑定API”，进入已绑定API列表页面。单击“绑定API”。 单击策略名称，进入策略详情页面。在“绑定的API列表”页签中单击“绑定API”。 选择“API分组”、“环境”以及“API名称”，筛选所需的API。 勾选A
删除应用 操作场景 已创建的应用不再提供服务，可以将应用删除。 从云商店购买的API生成的应用，不支持删除。 前提条件 已创建应用。 操作步骤 进入共享版控制台。 单击“调用API > 应用管理”，进入到应用管理信息页面。 通过以下任意一种方式，进入对话框。 在待删除的应用所在行，单击“删除”。
x-apigateway-access-controls.policy 含义：访问控制策略定义。 作用域：x-apigateway-access-controls 示例： x-apigateway-access-controls: customAccessControlName:
对象模型 本节介绍环境的对象模型。 “操作类型”用于描述字段的属性，表示对应字段的值可进行的操作： C：创建；U：更新；R：读取。 “是否必选”列表示对于“操作类型”为“C”的创建操作，对应字段是否为必选字段。 表1 环境管理对象模型 参数 类型 说明 操作类型 是否必选 id String
查询资源列表时（例如，查询API列表），系统支持分页显示查询结果。 在url后面拼接如下参数： page_size：每页查询多少条数据，如果不指定，默认20，最大值500。 page_no：需要查询的页码。 示例： GET /v1.0/apigw/apis?page_size=10&page_no=5
API调用返回错误码如何处理？ 如果您直接调用自己创建的API，点此查询错误信息与解决方案。 如果您使用接口管理您的API，点此查询错误信息与解决方案。 父主题： API调用
删除签名密钥 操作场景 如果某一个密钥不再提供服务，则可以将其删除。 前提条件 已创建密钥。 操作步骤 进入共享版控制台。 单击“开放API > 签名密钥”，进入签名密钥管理信息页面。 通过以下任意一种方法，弹出对话框。 在待删除的密钥所在行，单击“删除”。 单击“密钥名称”，进
对象模型 API发布后，如果不想API被某些IP地址访问到，可以将这些IP地址加入黑名单，或者想API被某些特性的IP地址访问到，也可以将这些IP地址加入白名单。这样可以提高API的访问安全性，保护API免受攻击。本节介绍API的黑白名单（ACL策略）管理的对象模型，如表1 ACL策略对象模型所示。
对象模型 本节介绍VPC通道的对象模型。 “操作类型”用于描述字段的属性，表示对应字段的值可进行的操作： C：创建；U：更新；R：读取。 “是否必选”列表示对于“操作类型”为“C”的创建操作，对应字段是否为必选字段。 表1 VPC通道对象模型 参数 类型 说明 操作类型 是否必选
操作类型 是否必选 id String 环境变量编号 R - env_id String 环境编号 CR 是 group_id String API分组编号 CR 是 variable_name String 变量名 CR 是 variable_value String 变量值 CR 是
String 流控策略创建者的租户编号 - - api_call_limits Integer 单个API流控时间内能够被访问的最大次数 CRU 是 user_call_limits Integer 单个用户流控时间内能够访问的最大次数，遵循api_call_limits>=user_call_limits
对象模型 管理系统的默认配置，管理租户可以根据系统的实际运行情况对这些配置的值进行修改。 “操作类型”用于描述字段的属性，表示对应字段的值可进行的操作： C：创建；U：更新；R：读取。 “是否必选”列表示对于“操作类型”为“C”的创建操作，对应字段是否为必选字段。 表1 系统配置对象模型
操作类型 是否必选 id String 授权关系的ID R - app_id String APP的编号 CR 是 front_api_id String api的编号 CR 是 env_id String 环境编号（发布环境） CR 是 create_time Timestamp 授权时间
对象模型 API发布后，如果不想API被某些IP地址访问到，可以将这些IP地址加入黑名单，或者想API被某些特性的IP地址访问到，也可以将这些IP地址加入白名单。这样可以提高API的访问安全性，保护API免受攻击。本节介绍API的黑白名单（ACL策略）管理的对象模型，如表1 ACL策略对象模型所示。
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
