检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
查询实例终端节点连接列表 功能介绍 查询实例终端节点连接列表。 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/apigw/instances/{instance_id}/vpc-endpoint/connections 表1 路径参数 参数 是否必选
项目ID。可从控制台“我的凭证”中获取region下项目ID,管理员权限可查询。 instance_id path 是 String 实例ID,可从API网关控制台的专享版实例信息中获取。 extend_mode query 否 String 扩展信息导入模式,取值可选merge和override。
项目ID。可从控制台“我的凭证”中获取region下项目ID,管理员权限可查询。 instance_id 是 String 实例ID,可从API网关控制台的专享版实例信息中获取。 api_id 是 String API的编号 env_id 否 String 环境的编号 env_name
专享版-实例自定义入方向端口管理 查询实例指定的自定义入方向端口绑定的域名信息 查询实例的自定义入方向端口列表 新增实例的自定义入方向端口 删除实例指定的自定义入方向端口 父主题: 专享版API(V2)
x-apigateway-ratelimits.policy 含义:流控策略定义。 作用域:x-apigateway-ratelimits 示例: x-apigateway-ratelimits: customRatelimitName: api-limit: 200
x-apigateway-auth-opt 含义:APP简易认证方式参数。 作用域:Security Scheme Object(2.0)/Security Scheme Object(3.0) Swagger示例: securityDefinitions: apig-auth-app:
x-apigateway-pass-through 含义:API的请求参数是否透传。always为是,never为否。 作用域: Operation Object(2.0)/Operation Object(3.0) 示例: paths: /: get: parameters:
查看特殊设置列表 功能介绍 查看给流控策略设置的特殊配置。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI GET /v1.0/apigw/throttle-specials/{strategy_id}[
查询API运行时定义 功能介绍 查看指定的API在指定的环境上的运行时定义,默认查询RELEASE环境上的运行时定义。 API的定义分为临时定义和运行时定义,分别代表如下含义: 临时定义:API在编辑中的定义,表示用户最后一次编辑后的API的状态 运行时定义:API在发布到某个环
创建自定义认证 功能介绍 创建自定义认证 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI POST /v1.0/apigw/authorizers 请求消息 表2 参数说明 名称 是否必选 类型 说明 name
项目ID。可从控制台“我的凭证”中获取region下项目ID,管理员权限可查询。 instance_id 是 String 实例ID,可从API网关控制台的专享版实例信息中获取。 env_id 否 String 环境编号 group_id 是 String API分组编号 variable_name
项目ID。可从控制台“我的凭证”中获取region下项目ID,管理员权限可查询。 instance_id 是 String 实例ID,可从API网关控制台的专享版实例信息中获取。 id 是 String 流控策略的ID。 请求消息 无 响应消息 表3 参数说明 参数 类型 说明 id String
项目ID。可从控制台“我的凭证”中获取region下项目ID,管理员权限可查询。 instance_id 是 String 实例ID,可从API网关控制台的专享版实例信息中获取。 id 否 String 编号 name 否 String 名称 acl_type 否 String 类型:PERMIT或DENY
查询流控策略列表 功能介绍 查询所有流控策略的信息。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI GET /v1.0/apigw/throttles[?page_size, page_no, id, name]
解除API与ACL策略的绑定 功能介绍 解除某条API与ACL策略的绑定关系 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI DELETE /v1.0/apigw/acl-bindings/{id} URI中的参数说明如下表所示。
添加后端实例(云服务器) 功能介绍 为指定的VPC通道添加云服务器。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI POST /v1.0/apigw/vpc-channels/{id}/members URI中的参数说明如下表所示。
查看自定义认证详情 功能介绍 查看自定义认证详情 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI GET /v1.0/apigw/authorizers/{id} URI中的参数说明如下表所示。 表2 参数说明
x-apigateway-content-type 含义: API的请求内容类型。 作用域: Operation Object(2.0) 示例: paths: /: get: x-apigateway-content-type: application/json
删除自定义认证 功能介绍 删除自定义认证 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI DELETE /v1.0/apigw/authorizers/{id} URI中的参数说明如下表所示。 表2 参数说明
对象模型 本节介绍流控策略与API的绑定关系的对象模型,如下表所示。 “操作类型”用于描述字段的属性,表示对应字段的值可进行的操作: C:创建;U:更新;R:读取。 “是否必选”列表示对于“操作类型”为“C”的创建操作,对应字段是否为必选字段。 表1 流控策略限定关系对象模型 参数