检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
查询API分组概况 功能介绍 查询租户名下的API分组概况：上架的API分组个数，未上架的API分组个数。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI GET /v1/{project_id}/api
删除API分组 功能介绍 删除指定的API分组。 删除API分组前，要先下线并删除分组下的所有API。 删除时，会一并删除直接或间接关联到该分组下的所有资源，包括独立域名、SSL证书信息等等。并会将外部域名与子域名的绑定关系进行解除（取决于域名cname方式）。 URI HTTP
创建环境和环境变量 操作场景 API可以同时提供给不同的环境调用，如生产、测试或开发。RELEASE是默认存在的环境，无需创建。且API网关提供环境变量功能，通过创建环境变量，实现在不同的环境定义不同的API调用路径。 环境变量是指在环境上创建可管理的一种变量，该变量固定在环境上。通过创建环境
方案概述 应用场景 API网关提供了灵活的安全认证方式，用户可以配置自定义认证实现API的双重认证方式。本文以API前端认证使用APP认证和自定义认证（双重认证）结合场景为例，具体说明如何创建使用双重认证的API。 方案优势 在API网关提供的安全认证模式下，用户可根据业务需求，灵活实现自定义认证，保障API的安全性。
查看变量详情 功能介绍 查看指定的环境变量的详情。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI GET /v1.0/apigw/env-variables/{id} URI中的参数说明如下表所示。 表2 参数说明
查询APP概况 功能介绍 查询租户名下的APP概况：已进行API访问授权的APP个数，未进行API访问授权的APP个数。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI GET /v1/{project_
7为例，函数代码需要满足如下条件： 函数代码只支持您自定义的用户数据，且它的格式为：event["user_data"]。 函数代码获取的请求参数与API网关自定义认证中的参数关系为：函数请求参数中的自定义用户数据对应API网关自定义认证中的用户数据，参数值在您创建API网关自定义认证时输
前端双向认证。在绑定独立域名时，选择带有CA证书的SSL证书，开启客户端认证即双向认证。 后端双向认证。在创建API时，配置双向认证，在API网关和后端服务间启用双向认证。配置请参考创建API中的“TLS双向认证”参数说明。 共享版：不支持，API网关仅做HTTPS的单向认证。 父主题： API认证
查询API概况 功能介绍 查询租户名下的API概况：已发布到RELEASE环境的API个数，未发布到RELEASE环境的API个数。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI GET /v1/{pr
创建签名密钥 功能介绍 为了保护API的安全性，建议租户为API的访问提供一套保护机制，即租户开放的API，需要对请求来源进行认证，不符合认证的请求直接拒绝访问。 其中，签名密钥就是API安全保护机制的一种。 租户创建一个签名密钥，并将签名密钥与API进行绑定，则API网关在请求
下线APIG的API 已发布的API因为其他原因需要暂停对外提供服务，可以暂时将API从相关环境中下线。 该操作将导致此API在指定的环境无法被访问，请确保已经告知使用此API的用户。 前提条件 已创建API分组和分组内的API。 API已发布到该环境。 操作步骤 进入API网关控制台页面。
配置API认证凭据的配额控制 凭据配额可限制单位时间内凭据调用API的总次数，保护后端服务。您可以创建凭据配额策略，对绑定策略的凭据进行调用次数限制。 凭据配额策略和凭据本身是相互独立的，只有将凭据绑定凭据配额策略后，凭据配额策略才对凭据生效。 操作步骤 进入API网关控制台页面。
Integer 正常阈值。判定VPC通道中主机正常的依据为：连续检查x成功，x为您设置的正常阈值。 最小值：1 最大值：10 threshold_abnormal 是 Integer 异常阈值。判定VPC通道中主机异常的依据为：连续检查x失败，x为您设置的异常阈值。 最小值：1 最大值：10 time_interval
修改指定环境的信息。其中可修改的属性为：name、remark，其它属性不可修改。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI PUT /v1.0/apigw/envs/{id} URI中的参数说明如下表所示。
查看APP详情 功能介绍 查看指定APP的详细信息。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI GET /v1.0/apigw/apps/{id} URI中的参数说明如下表所示。 表2 参数说明 名称
0/apigw/apps/{app_id}/app-codes/{id} URI中的参数说明如下表所示。 表2 参数说明 名称 是否必选 类型 说明 id 是 String App Code的编号 app_id 是 String APP的编号 请求消息 无 响应消息 表3 参数说明 参数 类型 说明
PUT /v1.0/apigw/apps/{app_id}/app-codes URI中的参数说明如下表所示。 表2 参数说明 名称 是否必选 类型 说明 app_id 是 String APP的编号 请求消息 无 响应消息 表3 参数说明 参数 类型 说明 id String 编号
查询指定ACL策略的详情。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI GET /v1/{project_id}/apigw/instances/{instance_id}/acls/{id} URI中的参数说明如下表所示。
API调用授权概述 API调用者在调用使用APP认证方式的API时，可以通过用凭据进行API认证或AppCode进行简易的API认证。您可以根据业务需求选择其中一种进行认证，下文介绍具体两种认证方式的配置。 配置APIG的API认证凭据 在API网关中创建一个凭据，生成密钥对（K
ains URI中的参数说明如下表所示。 表2 参数说明 名称 是否必选 类型 说明 group_id 是 String 分组的编号 请求消息 表3 参数说明 参数 是否必选 类型 说明 url_domain 是 String 自定义域名。 长度为0-255位的字符串，需要符合域名规范。
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
