检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
API网关如何开放部署在华为云上的服务? 如果部署在华为云上的服务绑定了公网IP地址,在API网关中创建API时,使用公网IP地址:端口号作为后端服务地址。如果此服务已绑定域名,则优先使用域名作为后端服务地址。创建API的详细步骤请参见创建API。 如果部署在华为云上的服务无公网
"65e6fe53-1ac3-4481-ba36-9f0bc6f22057" ] } 响应消息 表3 参数说明 名称 类型 说明 - 字典数据类型 API与签名密钥的绑定关系列表 表4 字典类型响应参数 名称 类型 说明 id String 绑定关系的ID api_id String API编号 api_name
d}/domains URI中的参数说明如下表所示。 表2 参数说明 名称 是否必选 类型 说明 group_id 是 String 分组的编号 请求消息 表3 参数说明 参数 是否必选 类型 说明 url_domain 是 String 自定义域名。 长度为0-255位的字符串,需要符合域名规范。
和头信息字段。预检通过后,浏览器向服务器发送简单请求。 开启跨域访问 API网关默认不开启跨域访问,如果您需要开启,请参考以下说明完成跨域配置。 简单请求的跨域访问 如果是创建新的API,在定义API请求时,打开“支持跨域(CORS)”开关。详细的使用指导,可参考简单请求。 图2
[?action] URI中的参数说明如下表所示。 表2 参数说明 名称 是否必选 类型 说明 action 是 String 必须为delete 请求消息 表3 参数说明 参数 是否必选 类型 说明 acl_bindings 否 String Array 需要解除绑定的ACL策略ID列表
0/apigw/authorizers/{id} URI中的参数说明如下表所示。 表2 参数说明 名称 是否必选 类型 说明 id 是 String 自定义认证的ID 请求消息 表3 参数说明 名称 是否必选 类型 说明 name 是 String 自定义认证的名称。 长度为3 ~ 64位的字符串,字符
"DEFAULT_ENVIRONMENT_RELEASE_ID" } 响应消息 表3 参数说明 名称 类型 说明 -- 字典数据类型 API与APP的授权关系列表 表4 API与APP授权关系列表消息说明 名称 类型 说明 id String 授权关系编号 api_id String API编号 app_id
本节介绍API及后端服务的对象模型。 “操作类型”用于描述字段的属性,表示对应字段的值可进行的操作: C:创建;U:更新;R:读取。 “是否必选”列表示对于“操作类型”为“C”的创建操作,对应字段是否为必选字段。 表1 API对象模型 参数 类型 说明 操作类型 是否必选 id String API的编号
API分组编号 响应消息 表3 参数说明 名称 类型 说明 total Integer 满足查询条件的API的总个数 size Integer 本次查询返回的API列表长度 apis 字典数据类型 本次查询返回的API列表 表4 apis参数说明 参数 类型 说明 id String API编号
0/apigw/acls[?action] URI中的参数说明如下表所示。 表2 参数说明 名称 是否必选 类型 说明 action 是 String 必须为delete 请求消息 表3 参数说明 参数 是否必选 类型 说明 acls 否 String Array 需要删除的ACL策略ID列表 请求消息样例:
管理API 管理API概述 查看或编辑APIG的API信息 配置API的自定义认证 配置API的参数编排规则 自定义API的错误响应信息 克隆APIG的API 下线APIG的API 导入导出API APIG的API设计文件扩展定义
本节介绍API及后端服务的对象模型。 “操作类型”用于描述字段的属性,表示对应字段的值可进行的操作: C:创建;U:更新;R:读取。 “是否必选”列表示对于“操作类型”为“C”的创建操作,对应字段是否为必选字段。 表1 API对象模型 参数 类型 说明 操作类型 是否必选 id String API的编号
响应消息 表3 参数说明 名称 类型 说明 total Integer 本次查询满足条件的API总数 size Integer 本次查询返回的API列表长度 bindings 字典数据类型 本次查询返回的API列表 表4 bindings参数说明 参数 类型 说明 id String 绑定关系的ID
action] URI中的参数说明如下表所示。 表2 参数说明 名称 是否必选 类型 说明 action 否 String online:发布 offline:下线 请求消息 表3 参数说明 参数 是否必选 类型 说明 apis 是 String Array 需要发布或下线的API ID列表
表2 参数说明 名称 是否必选 类型 说明 id 是 String 自定义认证的ID 请求消息 无 响应消息 表3 参数说明 名称 类型 说明 id String 编号 name String 自定义认证的名称 type String 自定义认证类型: FRONTEND:前端 BACKEND:后端
无 响应消息 表3 参数说明 名称 类型 说明 variables 字典数据类型 本次返回的环境变量列表 total Integer 满足条件的环境变量总数 size Integer 本次返回的列表长度 表4 variables参数说明 参数 类型 说明 id String 环境变量编号
名称 是否必选 类型 说明 app_id 是 String APP的编号 请求消息 无 响应消息 表3 参数说明 名称 类型 说明 total Integer 符合条件的APP总数 size Integer 本次查询返回的列表长度 app_codes 字典数据类型 App Code列表
_uri 响应消息 表3 参数说明 名称 类型 说明 total Integer 符合条件的API总数 size Integer 本次查询返回的列表长度 apis 字典数据类型 本次查询到的API列表 表4 apis参数说明 参数 类型 说明 id String API编号 name
名称 是否必选 类型 说明 api_id 是 String API的编号 sign_id 否 String 签名密钥的编号 sign_name 否 String 签名密钥的名称 env_id 否 String 环境编号 请求消息 无 响应消息 表3 参数说明 名称 类型 说明 total
"19asdfaf-adfadf" } 响应消息 表4 参数说明 名称 类型 说明 id String 编号 acl_name String 名称 acl_type String 类型 PERMIT(白名单类型) DENY(黑名单类型) acl_value String ACL策略的值 update_time