检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
以及响应内容。 响应内容的错误信息以及其他信息,可通过变量的方式获取,支持的变量见表2。 网关错误响应类型说明 API网关提供的错误响应类型见表1,其中响应状态码可以按实际需要做自定义修改。 表1 API网关的错误响应类型 错误说明 默认的响应状态码 详细说明 拒绝访问 403
弹出“授权应用”对话框。最多同时授权1000个API。 选择API授权环境,查询并勾选应用后,单击“授权”。 授权成功后,可以在“授权信息”/“授权API”中查看已授权的应用。 如果已授权的应用列表中包含无需授权的应用,在此应用所在行单击“解除授权”,将无需授权的应用删除。 后续操作
String API的编号 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 表3 请求Body参数 参数 是否必选
管理操作。权限策略以API接口为粒度进行权限拆分,API网关服务支持的API授权项请参见权限策略支持的授权项。 如表1所示,包括了API网关的所有系统角色和策略。 表1 API网关的系统角色或策略 系统角色/策略名称 描述 类别 依赖关系 APIG Administrator A
创建快速通道 进入共享版控制台。 单击“开放API > VPC通道”,进入到VPC通道列表页面。 单击“创建快速通道”,进入“新建VPC通道”页面,填写如表1所示信息。 图2 创建快速通道 表1 VPC通道配置 信息项 描述 通道名称 自定义VPC通道名称,用于识别不同的VPC通道。
"header" origin: "CONSTANT" description: "调用者" 表1 参数说明 参数 是否必选 类型 说明 name 是 String 参数名称,长度不能超过32个字节,由字母、数字、下划线、连线或点组成,且必须以字母开头。
String VPC通道的编号 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 表3 请求Body参数 参数 是否必选
对象模型 本节介绍VPC通道的对象模型。 “操作类型”用于描述字段的属性,表示对应字段的值可进行的操作: C:创建;U:更新;R:读取。 “是否必选”列表示对于“操作类型”为“C”的创建操作,对应字段是否为必选字段。 表1 VPC通道对象模型 参数 类型 说明 操作类型 是否必选 id String
对象模型 本节介绍VPC通道的对象模型。 “操作类型”用于描述字段的属性,表示对应字段的值可进行的操作: C:创建;U:更新;R:读取。 “是否必选”列表示对于“操作类型”为“C”的创建操作,对应字段是否为必选字段。 表1 VPC通道对象模型 参数 类型 说明 操作类型 是否必选 id String
API的请求参数列表 backend_params 字典数据类型 API的后端参数列表 policy_https 字典数据类型 web策略后端列表 policy_mocks 字典数据类型 mock策略后端列表 policy_functions 字典数据类型 函数工作流策略后端列表 表16 backend_api参数说明
响应参数 状态码: 200 表5 响应Body参数 参数 参数类型 描述 size Integer 本次返回的列表长度 total Long 满足条件的记录数 members Array of VpcMemberInfo objects 本次查询到的云服务器列表 表6 VpcMemberInfo
API的请求参数列表 backend_params 字典数据类型 API的后端参数列表 policy_https 字典数据类型 web策略后端列表 policy_mocks 字典数据类型 mock策略后端列表 policy_functions 字典数据类型 函数工作流策略后端列表 表16 backend_api参数说明
如果修改完默认网关响应后,需要恢复默认配置,单击“恢复默认配置”即可。 网关错误响应类型说明 API网关提供的错误响应类型见下表,其中响应状态码可以按实际需要做自定义修改。 表1 API网关的错误响应类型 错误说明 默认的响应状态码 详细说明 拒绝访问 403 拒绝访问,如触发配置的访问控制策略、或异常攻击检测拦截
请求参数匹配编排规则的生效优先级与列表顺序保持一致,列表中靠前的配置匹配优先级较高; 如果编排规则列表中包含none_value类型的规则,则none_value类型的规则优先级最高,至多绑定一个none_value类型的规则; 如果编排规则列表中包含default类型的规则,则d
专享版-插件管理 创建插件 修改插件 删除插件 查询插件列表 查询插件详情 插件绑定API API绑定插件 解除绑定插件的API 解除绑定API的插件 查询插件下绑定的API 查询API下绑定的插件 查询可绑定当前插件的API 查询可绑定当前API的插件 父主题: 专享版API(V2)
专享版-实例标签管理 查询项目下所有实例标签 查询单个实例标签 批量添加或删除单个实例的标签 查询包含指定标签的实例数量 通过标签查询实例列表 父主题: 专享版API(V2)
获取凭据配额列表 功能介绍 获取凭据配额列表。支持根据名称模糊查询 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/apigw/instances/{instance_id}/app-quotas 表1 路径参数 参数 是否必选 参数类型 描述
每个用户最多创建30个VPC通道。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI POST /v1.0/apigw/vpc-channels 请求消息 表2 参数说明 参数 是否必选 类型 说明 name 是 String
编写自定义认证函数 在函数工作流的控制台编写函数,自定义认证的代码编写指南参见创建用于前端自定义认证的函数。 根据下表参数说明,在函数工作流页面创建一个函数。 表1 函数信息配置 参数 配置说明 选择创建方式 默认“创建空白函数”。 函数类型 默认“事件函数”。 区域 与API网关相同区域。
更新指定VPC通道的参数。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI PUT /v1.0/apigw/vpc-channels/{id} URI中的参数说明如下表所示。 表2 参数说明 名称 是否必选 类型 说明 id 是 String