检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
创建ACL策略 功能介绍 增加一个ACL策略,策略类型通过字段acl_type来确定(permit或者deny),限制的对象的类型可以为IP或者DOMAIN,这里的DOMAIN对应的acl_value的值为您的租户名称, 而非“www.exampleDomain.com”之类的网络域名。
创建签名密钥 功能介绍 为了保护API的安全性,建议租户为API的访问提供一套保护机制,即租户开放的API,需要对请求来源进行认证,不符合认证的请求直接拒绝访问。 其中,签名密钥就是API安全保护机制的一种。 租户创建一个签名密钥,并将签名密钥与API进行绑定,则API网关在请求
删除签名密钥 功能介绍 删除指定的签名密钥。 删除签名密钥时,其配置的绑定关系会一并删除,相应的签名密钥会失效。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI DELETE /v1.0/apigw/signs/{id}
查看VPC通道详情 功能介绍 查看指定的VPC通道详情。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI GET /v1.0/apigw/vpc-channels/{id} URI中的参数说明如下表所示。
根据版本编号下线API 功能介绍 对某个生效中的API版本进行下线操作,下线后,API在该版本生效的环境中将不再能够被调用。 该接口供FunctionGraph服务使用。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法
批量发布或下线API 功能介绍 将多个API发布到一个指定的环境,或将多个API从指定的环境下线。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI POST /v1.0/apigw/apis/publish[
如果需要为某个应用/租户设置特定的流控值,则通过添加特殊应用/租户可以实现。 前提条件 已创建应用,或已获取其他应用ID/租户ID。 添加特殊应用 进入共享版控制台。 选择“开放API > 流量控制”,进入到流量控制信息页面。 单击待添加特殊应用的流控策略的名称,进入流控详情页面。 单击“特殊应用”,进入特殊应用页面。
查询变量列表 功能介绍 查询分组下的所有环境变量的列表。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI GET /v1.0/apigw/env-variables[?page_size, page_no
修改ACL策略 功能介绍 修改指定的ACL策略,其中可修改的属性为:acl_name、acl_type、acl_value,其它属性不可修改。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTPS请求方法以及URI 请求方法 URI PUT /v1.0/apigw/acls/{id}
对象模型 本节介绍签名密钥与API的绑定关系的对象模型,如下表所示。 “操作类型”用于描述字段的属性,表示对应字段的值可进行的操作: C:创建;U:更新;R:读取。 “是否必选”列表示对于“操作类型”为“C”的创建操作,对应字段是否为必选字段。 表1 签名密钥与API绑定关系对象模型
在特殊应用/租户没有作用之后,删除为流控策略添加的特殊应用/租户。本节以删除特殊应用为例。 前提条件 已创建流控策略。 已添加特殊应用/租户。 删除特殊应用 进入共享版控制台。 选择“开放API > 流量控制”,进入到流量控制信息页面。 单击待删除特殊应用的流量控制策略的名称,进入流量控制详情页面。 单击“特殊应用”,进入“特殊应用”页面。
ppSecret将失效,绑定此应用的API将无法调用,请更新AppSecret,并重新调用API。 前提条件 已创建应用。 操作步骤 进入共享版控制台。 单击“调用API > 应用管理”,进入到应用管理信息页面。 单击待重置AppSecret的应用名称,进入应用详情页面。 在右上
策略才对绑定的API生效。 同一个环境中一个API只能被一个访问控制策略绑定,一个访问控制策略可以绑定多个API。 创建访问控制策略 进入共享版控制台。 选择“开放API > 访问控制”,进入访问控制策略列表页面。 单击“创建访问控制策略”,弹出“创建访问控制策略”对话框。 输入表1如所示信息。
删除访问控制策略 操作场景 当已创建的访问控制策略不再需要时,可以将此访问控制策略删除。 前提条件 已创建访问控制策略。 操作步骤 进入共享版控制台。 选择“开放API > 访问控制”,进入访问控制策略列表页面。 通过以下任意一种方式,弹出“删除访问控制策略”对话框。 在待删除的访问控制策略所在行,单击“删除”。
查看ACL策略详情 功能介绍 查询指定ACL策略的详情。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI GET /v1.0/apigw/acls/{id} URI中的参数说明如下表所示。 表2 参数说明
为了确保安全,简易认证仅支持HTTPS方式调用API,不支持HTTP。 每个应用最多可创建5个AppCode。 前提条件 已创建应用。 生成AppCode 进入共享版控制台。 选择“调用API > 应用管理”,进入到应用管理信息页面。 单击待查看的应用名称,进入应用详情页面。 单击“AppCode”页签,进入AppCode的管理界面。
获取应用的AppKey和AppSecret: 在API网关共享版控制台选择“调用API > 应用管理”,在应用列表中单击API所授权应用的名称,进入应用详情页面,获取应用的AppKey和AppSecret。 获取认证签名所使用SDK: 在API网关共享版控制台选择“帮助中心”,在“SDK使用指引”页签中下载对应语言所使用SDK。
查看特殊设置列表 功能介绍 查看给流控策略设置的特殊配置。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI GET /v1.0/apigw/throttle-specials/{strategy_id}[
批量删除ACL策略 功能介绍 批量删除指定的多个ACL策略。 删除ACL策略时,如果存在ACL策略与API绑定关系,则无法删除。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI PUT /v1.0/apigw/acls[
tle Integer 是否包含特殊流控配置: 1:包含 2:不包含 type Integer 流控策略的类型,取值如下: 1 独享 2 共享 bind_num Integer 流控绑定的API数量 enable_adaptive_control String 是否开启动态流控: