检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
Integer 符合条件的API的总数 size Integer 本次返回的列表长度 apis 字典数据类型 本次返回的API列表 表4 apis参数说明 参数 类型 说明 id String API编号 name String API名称 group_id String API所属分组的编号
String API的编号 R - name String API的名称 CRU 是 group_id String API所属分组的编号 CR 是 type Integer API的类型: 1:公有API 2:私有API CRU 是 status Integer API的状态: 1:启用
group_name String API绑定的分组 api_remark String API的描述信息 api_type Integer API类型 envname String API授权绑定的环境名称 env_id String API授权绑定的环境编号 auth_role
设置特殊流控(待下线) 对象模型 创建特殊设置 修改特殊设置 删除特殊设置 查看特殊设置列表 父主题: 专享版API(V1)(待下线)
对象模型 API发布后,如果不想API被某些IP地址访问到,可以将这些IP地址加入黑名单,或者想API被某些特性的IP地址访问到,也可以将这些IP地址加入白名单。这样可以提高API的访问安全性,保护API免受攻击。本节介绍API的黑白名单(ACL策略)管理的对象模型,如表1 ACL策略对象模型所示。
String 授权关系编号 api_id String API的编号 api_name String API的名称 group_name String API绑定的分组 api_remark String API的描述信息 api_type Integer API类型 envname String
String API分组编号 R - NAME String API分组名称 CRU 是 STATUS Integer API分组状态 1 正常状态 2 禁用状态 3 已删除 默认值1 该字段暂时废弃 R - SL_DOMAIN String API分组的子域名,由API网关分配,用户不可填写和修改
APP授权管理(待下线) 对象模型 查看APP未绑定的API列表 授权 查看APP已绑定的API列表 查看API已绑定的APP列表 解除授权 父主题: 专享版API(V1)(待下线)
解除授权 功能介绍 解除API对APP的授权关系。解除授权后,APP将不再能够调用该API。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI DELETE /v1/{project_id}/apigw/insta
环境管理(待下线) 对象模型 创建环境 修改环境 删除环境 查询环境列表 父主题: 专享版API(V1)(待下线)
查看VPC通道详情 查看VPC通道列表 添加后端实例(云服务器) 删除后端实例(云服务器) 查看后端实例列表(云服务器列表) 父主题: 专享版API(V1)(待下线)
绑定域名 功能介绍 用户自定义的域名,需要CNAME到API分组的子域名上才能生效,具体方法请参见增加A类型记录集。 每个API分组下最多可绑定5个域名。绑定域名后,用户可通过自定义域名调用API。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI
APP管理(待下线) 对象模型 创建APP 修改APP 重置密钥 删除APP 校验APP 查看APP详情 查询APP列表 父主题: 专享版API(V1)(待下线)
group_name String API所属分组的名称 status Integer API的状态 type Integer API类型 version String API版本 req_protocol String API访问协议 req_method String API请求方式 req_uri
APP删除后,将无法再调用任何API;其中,云商店自动创建的APP无法被删除。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI DELETE /v1/{project_id}/apigw/instances/
Integer 绑定的API总数 size Integer 本次查询返回的API数量 apis 字典数据类型 本次查询返回的API列表 表4 apis参数说明 名称 类型 说明 api_id String API编号 api_name String API名称 group_name
String API所属分组的编号 group_name String API所属分组的名称 status Integer API的状态 type Integer API类型 version String API版本 req_protocol String API访问协议 req_method
对象模型 API需要绑定ACL策略,ACL策略才能够对API起到保护作用。本节介绍ACL策略与API的绑定关系的对象模型,如表1所示。 “操作类型”用于描述字段的属性,表示对应字段的值可进行的操作: C:创建;U:更新;R:读取。 “是否必选”列表示对于“操作类型”为“C”的创建操作,对应字段是否为必选字段。
表1 HTTP/HTTPS请求方法以及URI 请求方法 URI GET /v1/{project_id}/apigw/instances/{instance_id}/api-groups/{id} URI中的参数说明如下表所示。 表2 参数说明 名称 是否必选 类型 说明 project_id
环境变量管理(待下线) 对象模型 新建变量 删除变量 查看变量详情 查询变量列表 父主题: 专享版API(V1)(待下线)