检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
修改指定环境的信息。其中可修改的属性为:name、remark,其它属性不可修改。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI PUT /v1.0/apigw/envs/{id} URI中的参数说明如下表所示。
id 是 String 流控策略的ID。 请求消息 无 响应消息 表3 参数说明 参数 类型 说明 id String 流控策略的ID name String 流控策略的名称 api_call_limits Integer 单个API流控时间内能够被访问的次数限制 user_call_limits
对象模型 本节介绍环境变量的对象模型,如下表所示: “操作类型”用于描述字段的属性,表示对应字段的值可进行的操作: C:创建;U:更新;R:读取。 “是否必选”列表示对于“操作类型”为“C”的创建操作,对应字段是否为必选字段。 表1 环境变量对象模型 参数 类型 说明 操作类型 是否必选
对象模型 本节介绍特殊流控的对象模型,如下表所示: “操作类型”用于描述字段的属性,表示对应字段的值可进行的操作: C:创建;U:更新;R:读取。 “是否必选”列表示对于“操作类型”为“C”的创建操作,对应字段是否为必选字段。 表1 特殊流控对象模型 参数 类型 说明 操作类型 是否必选
将流控策略应用于API,则所有对该API的访问将会受到该流控策略的限制。当一定时间内的访问次数超过流控策略设置的API最大访问次数限制后,后续的访问将会被拒绝,从而能够较好的保护后端API免受异常流量的冲击,保障服务的稳定运行。 为指定的API绑定流控策略,绑定时,需要指定在哪个环境上生效。
对象模型 本节介绍签名密钥的对象模型,如下表所示: “操作类型”用于描述字段的属性,表示对应字段的值可进行的操作: C:创建;U:更新;R:读取。 “是否必选”列表示对于“操作类型”为“C”的创建操作,对应字段是否为必选字段。 表1 签名密钥模型 参数 类型 说明 操作类型 是否必选
对象模型 本节介绍自定义域名及证书的对象模型。 “操作类型”用于描述字段的属性,表示对应字段的值可进行的操作: C:创建;U:更新;R:读取。 “是否必选”列表示对于“操作类型”为“C”的创建操作,对应字段是否为必选字段。 表1 域名对象模型 参数 类型 说明 操作类型 是否必选
对象模型 本节介绍流控策略与API的绑定关系的对象模型,如下表所示。 “操作类型”用于描述字段的属性,表示对应字段的值可进行的操作: C:创建;U:更新;R:读取。 “是否必选”列表示对于“操作类型”为“C”的创建操作,对应字段是否为必选字段。 表1 流控策略限定关系对象模型 参数
实例ID,在API网关控制台的“实例信息”中获取。 app_id 是 String 应用编号 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头
对象模型 本节介绍签名密钥与API的绑定关系的对象模型,如下表所示。 “操作类型”用于描述字段的属性,表示对应字段的值可进行的操作: C:创建;U:更新;R:读取。 “是否必选”列表示对于“操作类型”为“C”的创建操作,对应字段是否为必选字段。 表1 签名密钥与API绑定关系对象模型
签名密钥绑定关系管理 对象模型 查看签名密钥未绑定的API列表 绑定签名密钥 查看签名密钥绑定的API列表 查看API绑定的签名密钥列表 解除绑定 父主题: 共享版API(仅存量用户使用)
API网关支持http重定向到https功能。当用户的API采用http协议访问时,由于http没有传输安全与认证安全保障,可以使用API网关的重定向功能将API升级为安全的https协议访问,同时兼容已有的http协议。(2022年11月30日之后创建的实例支持http重定向到https)
环境变量管理 对象模型 新建变量 删除变量 查看变量详情 查询变量列表 父主题: 共享版API(仅存量用户使用)
查询包含指定标签的实例数量 功能介绍 查询包含指定标签的实例数量。 接口约束 使用策略授权用户时,需要包含apig:instance:getNumByTags的授权项才允许调用此接口。 调用方法 请参见如何调用API。 URI POST /v2/{project_id}/apig
实例ID,在API网关控制台的“实例信息”中获取。 acl_bindings_id 是 String 绑定关系编号 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取
解除凭据配额和凭据的绑定 功能介绍 解除凭据配额和凭据的绑定 调用方法 请参见如何调用API。 URI DELETE /v2/{project_id}/apigw/instances/{instance_id}/app-quotas/{app_quota_id}/bound-apps/{app_id}
对象模型 本节介绍APP与API之间的授权关系的对象模型,如下表所示。 “操作类型”用于描述字段的属性,表示对应字段的值可进行的操作: C:创建;U:更新;R:读取。 “是否必选”列表示对于“操作类型”为“C”的创建操作,对应字段是否为必选字段。 表1 APP授权关系对象模型 参数
String 用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 size Integer 本次返回的列表长度 total Long 满足条件的记录数 plugins
用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 size Integer 本次返回的列表长度 total Long 满足条件的记录数 apis Array of
String 用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 size Integer 本次返回的列表长度 total Long 满足条件的记录数 instances