检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
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 DELETE /v1.0/apigw/authorizers/{id} URI中的参数说明如下表所示。 表2 参数说明
解除绑定 功能介绍 解除API与签名密钥的绑定关系。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI DELETE /v1/{project_id}/apigw/instances/{instance_i
根据版本编号下线API 功能介绍 对某个生效中的API版本进行下线操作,下线后,API在该版本生效的环境中将不再能够被调用。 该接口供FunctionGraph服务使用。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法
批量发布或下线API 功能介绍 将多个API发布到一个指定的环境,或将多个API从指定的环境下线。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI POST /v1/{project_id}/apigw/
查看编排规则列表 功能介绍 查看编排规则列表 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/apigw/instances/{instance_id}/orchestrations 表1 路径参数 参数 是否必选 参数类型 描述 project_id
x-apigateway-backend.parameters 含义:API网关定义的API后端参数定义。 作用域:x-apigateway-backend 示例: paths: '/users/{userId}': get: produces:
x-apigateway-backend.httpVpcEndpoints 含义:API网关定义的HTTP VPC类型API后端服务定义。 作用域:x-apigateway-backend 示例: paths: '/users/{userId}': get:
x-apigateway-backend.mockEndpoints 含义:API网关定义的MOCK类型API后端服务定义。 作用域:x-apigateway-backend 示例: paths: '/users/{userId}': get: produces:
查看流控策略详情 功能介绍 查看指定流控策略的详细信息。 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/apigw/instances/{instance_id}/throttles/{throttle_id} 表1 路径参数 参数 是否必选
设置APP的访问控制 功能介绍 设置凭据的访问控制。 调用方法 请参见如何调用API。 URI PUT /v2/{project_id}/apigw/instances/{instance_id}/apps/{app_id}/app-acl 表1 路径参数 参数 是否必选 参数类型
更新VPC通道 功能介绍 更新指定VPC通道的参数 使用传入的后端实例列表对VPC通道进行全量覆盖,如果后端实例列表为空,则会全量删除已有的后端实例; 使用传入的后端服务器组列表对VPC通道进行全量覆盖,如果后端服务器组列表为空,则会全量删除已有的服务器组; 调用方法 请参见如何调用API。
发布或下线API 功能介绍 对API进行发布或下线。 发布操作是将一个指定的API发布到一个指定的环境,API只有发布后,才能够被调用,且只能在该环境上才能被调用。未发布的API无法被调用。 下线操作是将API从某个已发布的环境上下线,下线后,API将无法再被调用。 调用方法 请参见如何调用API。
删除API分组 功能介绍 删除指定的API分组。 删除API分组前,要先下线并删除分组下的所有API。 删除时,会一并删除直接或间接关联到该分组下的所有资源,包括独立域名、SSL证书信息等等。并会将外部域名与子域名的绑定关系进行解除(取决于域名cname方式)。 调用方法 请参见如何调用API。
删除APP的访问控制 功能介绍 删除凭据的访问控制信息。 调用方法 请参见如何调用API。 URI DELETE /v2/{project_id}/apigw/instances/{instance_id}/apps/{app_id}/app-acl 表1 路径参数 参数 是否必选
删除VPC通道 功能介绍 删除指定的VPC通道 调用方法 请参见如何调用API。 URI DELETE /v2/{project_id}/apigw/instances/{instance_id}/vpc-channels/{vpc_channel_id} 表1 路径参数 参数 是否必选
异步导入API 功能介绍 导入API。导入文件内容需要符合swagger标准规范,API网关自定义扩展字段请参考《API网关用户指南》的“导入导出API:扩展定义”章节。 调用方法 请参见如何调用API。 URI POST /v2/{project_id}/apigw/insta
查询APP Code列表 功能介绍 查询App Code列表。 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/apigw/instances/{instance_id}/apps/{app_id}/app-codes 表1 路径参数 参数 是否必选
查询环境列表 功能介绍 查询符合条件的环境列表。 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/apigw/instances/{instance_id}/envs 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String