检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
x-apigateway-pass-through 含义:API的请求参数是否透传。always为是,never为否。 作用域: Operation Object(2.0)/Operation Object(3.0) 示例: paths: /: get: parameters:
project_id 是 String 项目ID,获取方式请参见获取项目ID。 instance_id 是 String 实例ID,在API网关控制台的“实例信息”中获取。 表2 Query参数 参数 是否必选 参数类型 描述 offset 否 Long 偏移量,表示从此偏移量开始查询,偏移量小于0时,自动转换为0
project_id 是 String 项目ID,获取方式请参见获取项目ID。 instance_id 是 String 实例ID,在API网关控制台的“实例信息”中获取。 app_quota_id 是 String 凭据配额编号 表2 Query参数 参数 是否必选 参数类型 描述
project_id 是 String 项目ID,获取方式请参见获取项目ID。 instance_id 是 String 实例ID,在API网关控制台的“实例信息”中获取。 app_quota_id 是 String 凭据配额编号 表2 Query参数 参数 是否必选 参数类型 描述
删除自定义认证 功能介绍 删除自定义认证 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI DELETE /v1.0/apigw/authorizers/{id} URI中的参数说明如下表所示。 表2 参数说明
x-apigateway-request-type 含义:API网关定义的API请求类型,支持public和private。 作用域:Operation Object(2.0)/Operation Object(3.0) 示例: paths: '/path': get:
x-apigateway-response 含义:API的网关响应名称。 作用域: Operation Object(2.0)/Operation Object(3.0) 示例: paths: /: get: x-apigateway-response: test
x-apigateway-content-type 含义: API的请求内容类型。 作用域: Operation Object(2.0) 示例: paths: /: get: x-apigateway-content-type: application/json
project_id 是 String 项目ID,获取方式请参见获取项目ID。 instance_id 是 String 实例ID,在API网关控制台的“实例信息”中获取。 表2 Query参数 参数 是否必选 参数类型 描述 offset 否 Long 偏移量,表示从此偏移量开始查询,偏移量小于0时,自动转换为0
x-apigateway-ratelimits 含义:流控策略名称与关联策略映射。 作用域:Swagger Object 示例: x-apigateway-ratelimits: customRatelimitName: api-limit: 200 app-limit:
API调用是否存在带宽限制 共享版API网关按照流控策略以及单个请求的最大Body体(12M)进行管控,没有直接限制带宽。 专享版API网关存在带宽限制,在创建实例时可以选择公网入口以及出口带宽。 父主题: API策略
查询签名密钥列表 功能介绍 查询所有签名密钥的信息。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI GET /v1.0/apigw/signs[?page_size, page_no, id, name]
project_id 是 String 项目ID,获取方式请参见获取项目ID。 instance_id 是 String 实例ID,在API网关控制台的“实例信息”中获取。 app_id 是 String 应用编号 表2 Query参数 参数 是否必选 参数类型 描述 offset
String 函数urn identities 否 List 认证来源 ttl 否 Integer 缓存时间 user_data 否 String 用户数据 表4 identities参数说明 名称 是否必选 类型 说明 name 是 String 参数名称 location 是 String
x-apigateway-auth-type 含义:基于Swagger的apiKey认证格式,定义API网关支持的特有认证方式。 作用域:Security Scheme Object(2.0)/Security Scheme Object(3.0) Swagger: securityDefinitions:
x-apigateway-authorizer 含义:自定义认证对象。 作用域: Security Scheme Object 示例: x-apigateway-authorizer: auth_downgrade_enabled: false authorizer_alias_uri:
x-apigateway-responses 含义:自定义网关响应类型。 作用域: Operation Object(2.0)/Operation Object(3.0) 示例: x-apigateway-responses: default: ACCESS_DENIED:
project_id 是 String 项目ID,获取方式请参见获取项目ID。 instance_id 是 String 实例ID,在API网关控制台的“实例信息”中获取。 表2 Query参数 参数 是否必选 参数类型 描述 action 是 String online:发布 offline:下线
查看APP已绑定的API列表 功能介绍 查询APP已经绑定的API列表。 将API发布到相应的授权的环境后,才能查询到结果。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI GET /v1.0/apigw
将API与ACL策略进行绑定 功能介绍 将API与ACL策略进行绑定。 同一个API发布到不同的环境可以绑定不同的ACL策略;一个API在发布到特定环境后只能绑定一个同一种类型的ACL策略。 URI HTTPS请求方法以及URI如下表所示。 表1 HTTPS请求方法以及URI 请求方法