检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
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:
项目ID。可从控制台“我的凭证”中获取region下项目ID,管理员权限可查询。 instance_id 是 String 实例ID,可从API网关控制台的专享版实例信息中获取。 id 否 String 编号 name 否 String 名称 status 否 Integer 状态 app_key
instance_id 是 String 实例ID,在API网关控制台的“实例信息”中获取。 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。
查询签名密钥列表 功能介绍 查询所有签名密钥的信息。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI GET /v1.0/apigw/signs[?page_size, page_no, id, name]
String 函数urn identities 否 List 认证来源 ttl 否 Integer 缓存时间 user_data 否 String 用户数据 表3 identities参数说明 名称 是否必选 类型 说明 name 是 String 参数名称 location 是 String
x-apigateway-access-control 含义:引用访问控制策略。 作用域:Operation Object(2.0)/Operation Object(3.0) 示例: paths: '/path': get: x-apigateway-access-control:
项目ID。可从控制台“我的凭证”中获取region下项目ID,管理员权限可查询。 instance_id 是 String 实例ID,可从API网关控制台的专享版实例信息中获取。 id 是 String 特殊配置的编号 请求消息 表3 参数说明 参数 是否必选 类型 说明 call_limits
删除自定义认证 功能介绍 删除自定义认证 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI DELETE /v1.0/apigw/authorizers/{id} URI中的参数说明如下表所示。 表2 参数说明
required: true - name: "userId" description: "用户名" type: "string" in: "path" required: true
查看APP已绑定的API列表 功能介绍 查询APP已经绑定的API列表。 将API发布到相应的授权的环境后,才能查询到结果。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI GET /v1.0/apigw
x-apigateway-is-send-fg-body-base64 含义:是否对与FunctionGraph交互场景的请求体进行Base64编码,boolean类型。 作用域:Operation Object(2.0)/Operation Object(3.0) 示例: paths:
x-apigateway-result-normal-sample 含义:成功响应示例。 作用域: Operation Responses 示例: paths: /: get: responses: default: x
查看API已绑定的APP列表 功能介绍 查询API绑定的APP列表。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI GET /v1.0/apigw/app-auths/binded-apps[?page_size
查看ACL策略列表 功能介绍 查询所有的ACL策略列表。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI GET /v1.0/apigw/acls[?page_size, page_no, id, name
String 函数urn identities 否 List 认证来源 ttl 否 Integer 缓存时间 user_data 否 String 用户数据 表4 identities参数说明 名称 是否必选 类型 说明 name 是 String 参数名称 location 是 String
将API与ACL策略进行绑定 功能介绍 将API与ACL策略进行绑定。 同一个API发布到不同的环境可以绑定不同的ACL策略;一个API在发布到特定环境后只能绑定一个同一种类型的ACL策略。 URI HTTPS请求方法以及URI如下表所示。 表1 HTTPS请求方法以及URI 请求方法
批量解除API与ACL策略的绑定 功能介绍 批量解除API与ACL策略的绑定关系。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI PUT /v1.0/apigw/acl-bindings[?action]
x-apigateway-backend-policies.conditions 含义:API网关定义的API后端策略条件。 作用域:x-apigateway-backend-policies 示例: paths: '/users/{userId}': get: