检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
下线API 功能介绍 将API从某个已发布的环境上下线,下线后,API将无法再被调用。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI DELETE /v1.0/apigw/apis/publish/{api_id}[
修改APP 功能介绍 修改指定APP的信息。其中可修改的属性为:name、remark,当支持用户自定义key和secret的开关开启时,app_key和app_secret也支持修改,其它属性不可修改。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI
删除APP 功能介绍 删除指定的APP。 APP删除后,将无法再调用任何API;其中,云商店自动创建的APP无法被删除。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI DELETE /v1.0/apigw/apps/{id}
String APP的key app_secret String 密钥 creator String APP的创建者,取值如下: USER:用户自行创建 MARKET:云商店分配 register_time Timestamp 创建时间 remark String 描述 update_time
对象模型 本节介绍APP与API之间的授权关系的对象模型,如下表所示。 “操作类型”用于描述字段的属性,表示对应字段的值可进行的操作: C:创建;U:更新;R:读取。 “是否必选”列表示对于“操作类型”为“C”的创建操作,对应字段是否为必选字段。 表1 APP授权关系对象模型 参数
解除授权 功能介绍 解除API对APP的授权关系。解除授权后,APP将不再能够调用该API。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI DELETE /v1.0/apigw/app-auths/{id}
修改环境 功能介绍 修改指定环境的信息。其中可修改的属性为:name、remark,其它属性不可修改。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI PUT /v1.0/apigw/envs/{id} URI中的参数说明如下表所示。
对象模型 管理系统的默认配置,管理租户可以根据系统的实际运行情况对这些配置的值进行修改。 “操作类型”用于描述字段的属性,表示对应字段的值可进行的操作: C:创建;U:更新;R:读取。 “是否必选”列表示对于“操作类型”为“C”的创建操作,对应字段是否为必选字段。 表1 系统配置对象模型
offline:下线 请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 表4 请求Body参数 参数 是否必选 参数类型
证书的编号 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 表3 请求Body参数 参数 是否必选 参数类型
删除变量 功能介绍 删除指定的环境变量。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI DELETE /v1.0/apigw/env-variables/{id} URI中的参数说明如下表所示。 表2 参数说明
删除ACL策略 功能介绍 删除指定的ACL策略, 如果存在api与该ACL策略的绑定关系,则无法删除 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI DELETE /v1.0/apigw/acls/{id}
绑定域名证书 功能介绍 如果创建API时,“定义API请求”使用HTTPS请求协议,那么在独立域名中需要添加SSL证书。 本章节主要介绍为特定域名绑定证书。 URI HTTP/HTTPS请求方法以及URI如下表所示 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI POST
删除VPC通道 功能介绍 删除指定的VPC通道。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI DELETE /v1.0/apigw/vpc-channels/{id} URI中的参数说明如下表所示。 表2
项目ID。可从控制台“我的凭证”中获取region下项目ID,管理员权限可查询。 instance_id 是 String 实例ID,可从API网关控制台的专享版实例信息中获取。 id 是 String APP的编号 请求消息 无 响应消息 表3 参数说明 参数 类型 说明 id String
Integer 状态 app_key 否 String APP的KEY creator 否 String APP的创建者,取值如下: USER:用户自行创建 MARKET:云商店分配 page_size 否 Integer 每页显示的条数,默认值:20 page_no 否 Integer
对象模型 本节介绍流控策略与API的绑定关系的对象模型,如下表所示。 “操作类型”用于描述字段的属性,表示对应字段的值可进行的操作: C:创建;U:更新;R:读取。 “是否必选”列表示对于“操作类型”为“C”的创建操作,对应字段是否为必选字段。 表1 流控策略限定关系对象模型 参数
删除特殊设置 功能介绍 删除某个流控策略的某个特殊配置。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI DELETE /v1.0/apigw/throttle-specials/{id} URI中的参数说明如下表所示。
查询租户配置详情 功能介绍 查询某个租户的配置项及其配置值。 URI 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI GET /v1.0/apigw/config/project[?page_size, page_no, config_id, config_name]
批量删除ACL策略 功能介绍 批量删除指定的多个ACL策略。 删除ACL策略时,如果存在ACL策略与API绑定关系,则无法删除。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI PUT /v1.0/apigw/acls[