正在生成
详细信息:
检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
查询API列表 功能介绍 查看API列表,返回API详细信息、发布信息等,但不能查看到后端服务信息和API请求参数信息 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/apigw/instances/{instance_id}/apis 表1 路径参数
查看API绑定的签名密钥列表 功能介绍 查询某个API绑定的签名密钥列表。每个API在每个环境上应该最多只会绑定一个签名密钥。 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/apigw/instances/{instance_id}/sign
查询签名密钥列表 功能介绍 查询所有签名密钥的信息。 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/apigw/instances/{instance_id}/signs 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是
查询某个实例的租户配置列表 功能介绍 查询某个实例的租户配置列表,用户可以通过此接口查看各类型资源配置及使用情况。 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/apigw/instances/{instance_id}/project/configs
查询分组列表 功能介绍 查询API分组列表。 如果是租户操作,则查询该租户下所有的分组;如果是管理员权限账号操作,则查询的是所有租户的分组。 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/apigw/instances/{instance_id}/api-groups
绑定域名 操作场景 开放API前,您需要为API分组绑定一个或多个独立域名,API网关通过独立域名定位到此分组。 共享版中,不同分组下不能绑定相同的独立域名。 在绑定域名前,您需要理解以下2个概念: 子域名:API分组创建后,系统为分组自动分配一个内部测试用的子域名,此子域名唯一
创建用于后端自定义认证的函数 操作场景 如果您需要使用一种认证机制对接多个不同的外部认证系统,实现对于后端服务的保护,您可以通过API网关中的后端自定义认证实现此功能。在使用后端自定义认证对后端请求进行认证授权前,您需要先在FunctionGraph创建一个函数,通过函数定义您所
返回结果 请求发送以后,您会收到响应,包含状态码、响应消息头和消息体。 状态码 状态码是一组从1xx到5xx的数字代码,状态码表示了请求响应的状态,完整的状态码列表请参见HTTP状态码。 对于创建API分组(专享版API)接口,如果调用后返回状态码为“201”,则表示请求成功。 响应消息头
curl 操作场景 使用curl命令调用APP认证的API时,您需要先下载JavaScript SDK生成curl命令,然后将curl命令复制到命令行调用API。 前提条件 已获取API的调用信息,具体参见认证前准备。 调用API示例 使用JavaScript SDK生成curl命令。
新建变量 功能介绍 将API发布到不同的环境后,对于不同的环境,可能会有不同的环境变量,比如,API的服务部署地址,请求的版本号等。 用户可以定义不同的环境变量,用户在定义API时,在API的定义中使用这些变量,当调用API时,API网关会将这些变量替换成真实的变量值,以达到不同环境的区分效果。
查询项目下所有实例标签 功能介绍 查询项目下所有实例标签。 接口约束 使用策略授权用户时,需要包含apig:instanceTags:list的授权项才允许调用此接口 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/apigw/instance-tags
查询包含指定标签的实例数量 功能介绍 查询包含指定标签的实例数量。 接口约束 使用策略授权用户时,需要包含apig:instance:getNumByTags的授权项才允许调用此接口。 调用方法 请参见如何调用API。 URI POST /v2/{project_id}/apig
访问控制策略说明 访问控制策略是API网关提供的API安全防护组件之一,主要用来控制访问API的IP地址和账户,您可以通过设置IP地址或账户的黑白名单来禁止/允许某个IP地址/账号名/账号ID访问API。实例级访问控制策略请参考表1。 访问控制策略和API本身是相互独立的,只有将
修改变量 功能介绍 修改环境变量。环境变量引用位置为api的后端服务地址时,修改对应环境变量会将使用该变量的所有api重新发布。 调用方法 请参见如何调用API。 URI PUT /v2/{project_id}/apigw/instances/{instance_id}/env
查询单个实例标签 功能介绍 查询单个实例的标签。 接口约束 使用策略授权用户时,需要包含apig:instanceTags:list、apig:instances:get的授权项才允许调用此接口 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/
批量添加或删除单个实例的标签 功能介绍 批量添加或删除单个实例的标签。 接口约束 使用策略授权用户时,需要包含apig:instances:get、apig:instanceTags:create、apig:instanceTags:delete的授权项才允许调用此接口 调用方法
分组统计信息查询-最近一小时 功能介绍 根据API分组的id和最近的一段时间查询API被调用的次数,统计周期为1分钟。查询范围一小时以内,一分钟一个样本,其样本值为一分钟内的累计值。 为了安全起见,在服务器上使用curl命令调用接口查询信息后,需要清理历史操作记录,包括但不限于“~/
x-apigateway-backend.httpEndpoints 含义:API网关定义的HTTP类型API后端服务定义。 作用域:x-apigateway-backend 示例: paths: '/users/{userId}': get: produces:
查看变量详情 功能介绍 查看指定的环境变量的详情。 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/apigw/instances/{instance_id}/env-variables/{env_variable_id} 表1 路径参数 参数
查看专享版实例创建进度 功能介绍 查看专享版实例创建进度 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/apigw/instances/{instance_id}/progress 表1 路径参数 参数 是否必选 参数类型 描述 project_id