检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
是否必选 类型 说明 project_id path 是 String 项目ID。可从控制台“我的凭证”中获取region下项目ID,管理员权限可查询。 instance_id path 是 String 实例ID,可从API网关控制台的专享版实例信息中获取。 extend_mode query
API分组管理 创建API分组 绑定域名 删除分组 新增网关响应 父主题: 共享版操作指导(仅存量用户使用)
设置特殊流控(待下线) 对象模型 创建特殊设置 修改特殊设置 删除特殊设置 查看特殊设置列表 父主题: 专享版API(V1)(待下线)
云审计服务支持的关键操作 云审计服务支持的APIG操作列表 在CTS事件列表查看云审计事件 父主题: 共享版操作指导(仅存量用户使用)
应用管理 创建应用并获取授权 删除应用 重置AppSecret 为简易认证添加AppCode 查看应用绑定的API详情 父主题: 共享版操作指导(仅存量用户使用)
参数 是否必选 类型 说明 project_id 是 String 项目ID。可从控制台“我的凭证”中获取region下项目ID,管理员权限可查询。 instance_id 是 String 实例ID,可从API网关控制台的专享版实例信息中获取。 group_id 是 String 分组
资源规划 表1 资源规划 资源 数量(个) DDoS高防实例 1 已备案域名 1 API分组 1 API 1 父主题: API网关共享版对接DDOS高防
对象模型 本节介绍API分组的对象模型,如下表所示。 “操作类型”用于描述字段的属性,表示对应字段的值可进行的操作: C:创建;U:更新;R:读取。 “是否必选”列表示对于“操作类型”为“C”的创建操作,对应字段是否为必选字段。 表1 分组对象模型 参数名称 数据类型 参数说明 操作类型
操作步骤 进入共享版控制台。 单击“开放API > API管理”,进入到API管理信息页面。 单击“API名称”,进入“总览”页面。 单击“查看更多监控”,进入云监控界面,参考创建告警规则为API网关创建告警规则。 父主题: 监控
根据实际业务在左侧导航栏上方选择实例。 在左侧导航栏选择“API管理 > API分组”。 单击分组名称。 在“API运行”页面的“监控视图”区域,单击“查看更多监控”,返回“云服务监控”界面,参考创建告警规则为API网关创建告警规则。 父主题: API监控
HTTP状态码 常用状态码表如表1所示。 表1 HTTP请求状态返回码 返回值 说明 200 OK 处理正常。 204 No Content 无返回内容。 400 Bad Request 服务器未能处理请求。可能原因: 语义有误,当前请求无法被服务器解析; 请求参数有误。 401
2次,应用B在1分钟内最多可以访问绑定了该流控策略的API 4次。 添加特殊租户 鼠标移动到已登录用户名,在下拉列表中单击“我的凭证”。 在“API凭证”页面查看账号ID和项目ID。 图2 查看账号ID和项目ID 选择“开放API > 流量控制”,进入到流量控制信息页面。 单击待添加特殊租户的流控策略的名称,进入流控详情页面。
x-apigateway-backend.httpEndpoints 含义:API网关定义的HTTP类型API后端服务定义。 作用域:x-apigateway-backend 示例: paths: '/users/{userId}': get: produces:
x-apigateway-cors 含义:API网关定义的API请求是否支持跨域,boolean类型。 作用域:Operation Object(2.0)/Operation Object(3.0) 示例: paths: '/path': get: x-apigateway-cors:
对象模型 API发布后,如果不想API被某些IP地址访问到,可以将这些IP地址加入黑名单,或者想API被某些特性的IP地址访问到,也可以将这些IP地址加入白名单。这样可以提高API的访问安全性,保护API免受攻击。本节介绍API的黑白名单(ACL策略)管理的对象模型,如表1 ACL策略对象模型所示。
对象模型 本节介绍API分组的对象模型,如下表所示。 “操作类型”用于描述字段的属性,表示对应字段的值可进行的操作: C:创建;U:更新;R:读取。 “是否必选”列表示对于“操作类型”为“C”的创建操作,对应字段是否为必选字段。 表1 分组对象模型 参数名称 数据类型 参数说明 操作类型
配置凭据配额策略 参数 说明 策略名称 填写客户端配额策略的名称,根据业务规划自定义。建议您按照一定的命名规则填写配额策略名称,方便您快速识别和查找。 首次生效时间点 设置配额策略的生效起始时间点。例如,时长为1小时,首次生效时间点为2020/08/08 05:05:00,则表示客户端配额策略从2020/08/08
创建SSL证书 功能介绍 创建SSL证书。 调用方法 请参见如何调用API。 URI POST /v2/{project_id}/apigw/certificates 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID,获取方式请参见获取项目ID。
修改SSL证书 功能介绍 修改SSL证书。 调用方法 请参见如何调用API。 URI PUT /v2/{project_id}/apigw/certificates/{certificate_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String
每个应用最多可创建5个AppCode。 前提条件 已创建应用。 生成AppCode 进入共享版控制台。 选择“调用API > 应用管理”,进入到应用管理信息页面。 单击待查看的应用名称,进入应用详情页面。 单击“AppCode”页签,进入AppCode的管理界面。 单击“添加AppCode”,生成AppCode。可自动生成,也可手动输入。