检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
开放API流程 企业或开发者通过API网关开放自身的服务与数据，实现业务能力变现。 创建API分组 每个API都归属到某一个API分组下，在创建API前应提前创建API分组。 添加API的SSL证书 如果API分组中的API支持HTTPS请求协议，需要为独立域名添加SSL证书。反之，跳过此步骤。
查询租户名下的APP概况：已进行API访问授权的APP个数，未进行API访问授权的APP个数。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI GET /v1.0/apigw/resources/outline/apps
apig:apis:import apig:instances:get apig:apis:create apig:apis:bindAcls apig:apis:bindThrottles apig:groups:get apig:acls:create apig:throttles:create
怎样给指定的用户开放API？ 可以采用以下两种方式： 创建API时可选取APP认证方式，AppKey和AppSecret分享给指定的用户。 使用访问控制策略，按照IP地址或者账号名，只允许符合允许策略的用户调用API。 父主题： API策略
'customAccessControlName' 表1 参数说明 参数 是否必选 类型 说明 x-apigateway-access-control 否 String 访问控制策略。 父主题： APIG的API设计文件扩展定义
功能介绍 为了保护API的安全性，建议租户为API的访问提供一套保护机制，即租户开放的API，需要对请求来源进行认证，不符合认证的请求直接拒绝访问。 其中，签名密钥就是API安全保护机制的一种。 租户创建一个签名密钥，并将签名密钥与API进行绑定，则API网关在请求这个API时，就会使用
策略创建后，您还需要为策略绑定API，才能使策略对API生效。 为策略绑定API 单击策略名称，进入策略详情。 在API列表区域选择环境后，单击“绑定API”。 筛选API分组以及发布环境，勾选所需的API。 支持通过API名称或标签筛选API，标签为创建API时定义的标签。 单击“确定”，绑定完成。
创建API分组 创建API前，需要先创建API分组。API分组相当于API的集合，API提供者以API分组为单位，管理分组内的所有API。 目前支持以下创建分组方式： 直接创建 创建一个简单的分组，不包含API，用户可自行创建API。具体步骤请参见创建API分组。 导入API设计文件
customAccessControlName 否 x-apigateway-access-controls.policy 指定名称的访问控制策略。 如果使用该策略，需要将x-apigateway-access-control属性值引用为该策略名称。 父主题： APIG的API设计文件扩展定义
是否已上架云商店： 1：已上架 2：未上架 3：审核中 call_limits Integer 流控时长内分组下的API的总访问次数限制，默认不限，请根据服务的负载能力自行设置 time_interval Integer 流控时长 time_unit String 流控的时间单位 url_domains
ID）：访问密钥ID。与私有访问密钥关联的唯一标识符；访问密钥ID和私有访问密钥一起使用，对请求进行加密签名。 SK（Secret Access Key）：与访问密钥ID结合使用的密钥，对请求进行加密签名，可标识发送方，并防止请求被修改。 约束与限制： AK/SK签名认证方式仅支持
功能介绍 为了保护API的安全性，建议租户为API的访问提供一套保护机制，即租户开放的API，需要对请求来源进行认证，不符合认证的请求直接拒绝访问。 其中，签名密钥就是API安全保护机制的一种。 租户创建一个签名密钥，并将签名密钥与API进行绑定，则API网关在请求这个API时，就会使用
授权 功能介绍 APP创建成功后，还不能访问API，如果想要访问某个环境上的API，需要将该API在该环境上授权给APP。授权成功后，APP即可访问该环境上的这个API。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法
错误 THROTTLED: API调用次数超出所配置的流量策略阈值 UNAUTHORIZED: 使用的凭据未被授权访问该API ACCESS_DENIED: 拒绝访问，如触发配置的访问控制策略、或异常攻击检测拦截 NOT_FOUND: 未匹配到API错误 REQUEST_PARAMETERS_FAILURE:
管理APIG实例 查看或编辑APIG实例信息 配置APIG实例参数 配置APIG实例标签 配置APIG的终端节点信息 自定义APIG的客户端访问端口 变更APIG的实例规格
已购买API 操作场景 API网关共享版支持查看已购买的API，明确已购买服务的详情。并通过调试API，验证服务是否正常。 已购买的API，需要通过APP认证方式调用。 前提条件 已从云商店购买了API。 操作步骤 进入共享版控制台。 单击“调用API > 已购买API”，进入到已购买API分组信息页面。
S支持记录的APIG操作请参见云审计服务支持APIG操作列表。 图1 云审计服务 CTS的详细介绍和开通配置方法，请参见CTS快速入门。 APIG用户查看云审计日志方法，请参见云审计日志。 日志 APIG支持日志自定义分析模板，便于日志的统一收集和管理，也可通过API异常调用分析进行追查和溯源。
过滤查询结果 查询资源列表时（例如，查询API列表），系统支持按照查询对象的属性过滤查询结果。 示例： GET /v1.0/apigw/apis?id=xxxx 父主题： 附录
operation.security API认证方式 API认证方式 结合x-apigateway-auth-type 填充为API认证方式 结合x-apigateway-auth-type 表2 请求参数类型和API网关参数类型差异 OAS类型Swagger类型 API网关类型 支持的参数属性字段
type: apiKey name: Authorization in: header x-apigateway-auth-type: AppSigv1 apig-auth-app-header: type: apiKey name:
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
