检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
SDK概述 本文介绍了API网关提供的开放API的SDK语言版本,列举了最新版本SDK的获取地址。 SDK列表 提供了API网关支持的SDK列表,您可以在GitHub仓库查看SDK更新历史、获取安装包以及查看指导文档。查看接口请参考“ApigClient”/“apig_client”文件。
user-limit 否 Number 用户访问次数限制。 app-limit 否 Number 应用访问次数限制。 ip-limit 否 Number 源IP访问次数限制。 interval 是 Number 流控策略时间周期。 unit 是 String 流控策略时间周期单位
现;如果您需要控制访问API的IP地址(API调用者的IP地址),可以通过配置API认证的凭据访问控制来实现。 调用API 通过获取API及API访问地址,调用API。根据API使用认证方式的不同,调用API时需要进行不同的认证鉴权操作。
x-apigateway-any-method 含义:API网关定义的API请求方法,用以匹配未指定定义的HTTP方法。 作用域:Path Item Object(2.0)/Path Item Object(3.0) 示例: paths: '/path': get:
限。 源IP流量限制 单个IP地址调用API次数上限。 不超过“API流量限制”。 与“时长”配合使用,表示单位时间内的单个IP地址请求次数上限。 描述 关于控制策略的描述。 单击“确定”,完成流量控制策略的创建。 创建成功后,流量控制页面增加显示新创建的策略。您可以将相关API绑定到该策略,以实现流量控制。
description: "认证token" type: "string" in: "header" required: true - name: "userId" description:
x-apigateway-backend.mockEndpoints 含义:API网关定义的MOCK类型API后端服务定义。 作用域:x-apigateway-backend 示例: paths: '/users/{userId}': get: produces:
查看APP详情 功能介绍 查看指定APP的详细信息。 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/apigw/instances/{instance_id}/apps/{app_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id
实例ID,在API网关控制台的“实例信息”中获取。 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 表3 请求Body参数
有效 app_type String APP的类型: apig:存量apig应用,不推荐使用 roma:roma集成应用 默认apig,暂不支持其他类型 roma_app_type String ROMA_APP的类型: subscription:订阅应用 integration:集成应用
创建插件 功能介绍 创建插件信息。 插件不允许重名 插件创建后未绑定API前是无意义的,绑定API后,对绑定的API即时生效 调用方法 请参见如何调用API。 URI POST /v2/{project_id}/apigw/instances/{instance_id}/plugins
用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 表3 请求Body参数 参数 是否必选 参数类型 描述 name 是 String 自定义认证的名称。 长度为3 ~ 64位的字符串,字符串由中文、英文字母、数字、“_”组成,且只能以英文或中文开头。
x-apigateway-backend.httpVpcEndpoints 含义:API网关定义的HTTP VPC类型API后端服务定义。 作用域:x-apigateway-backend 示例: paths: '/users/{userId}': get:
env_id 是 String 需要授权的环境编号 app_ids 是 Array of strings APP的编号列表 api_ids 是 Array of strings API的编号列表,可以选择租户自己的API,也可以选择从云商店上购买的API。 响应参数 状态码: 201
ENTERPRISE:企业版实例 PLATINUM:铂金版实例 BASIC_IPV6:基础版IPV6实例 PROFESSIONAL_IPV6:专业版IPV6实例 ENTERPRISE_IPV6:企业版IPV6实例 PLATINUM_IPV6:铂金版IPV6实例 PLATINUM_X2:铂金版 x2实例 PLATINUM_X3:铂金版
访问控制 访问控制策略是API网关提供的API安全防护组件之一,主要用来控制访问API的IP地址和账户,您可以通过设置IP地址或账户的黑白名单来允许/拒绝某个IP地址或账户访问API。 应用(凭据) 应用(APP)定义了一个API调用者的身份。可以将一个API授权给多个应用,也可以将多个API授权给同一个应用。
创建APP Code 功能介绍 App Code为APP应用下的子模块,创建App Code之后,可以实现简易的APP认证。 调用方法 请参见如何调用API。 URI POST /v2/{project_id}/apigw/instances/{instance_id}/apps/{app_id}/app-codes
查询单个实例标签 功能介绍 查询单个实例的标签。 接口约束 使用策略授权用户时,需要包含apig:instanceTags:list、apig:instances:get的授权项才允许调用此接口 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/
查看APP Code详情 功能介绍 App Code为APP应用下的子模块,创建App Code之后,可以实现简易的APP认证。 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/apigw/instances/{instance_id}/app
x-apigateway-backend 含义:API网关定义的API后端服务定义。 作用域:Operation Object(2.0)/Operation Object(3.0) 示例: paths: '/users/{userId}': get: produces: