检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
实例ID,在API网关控制台的“实例信息”中获取。 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 表3 请求Body参数
env_id 是 String 需要授权的环境编号 app_ids 是 Array of strings APP的编号列表 api_ids 是 Array of strings API的编号列表,可以选择租户自己的API,也可以选择从云商店上购买的API。 响应参数 状态码: 201
String 导入成功的API编号 表6 Failure 参数 参数类型 描述 path String API请求路径 error_msg String 导入失败的错误信息 method String API请求方法 error_code String 导入失败的错误码 表7 Swagger
否 Array of TmsMatchesKeyValue objects 搜索字段,key为要匹配的字段,当前限定为resource_name。value为匹配的值。 根据key的值确认是否需要模糊匹配,如resource_name需要实现前缀搜索。 表5 TmsKeyValues
当前实例所在租户该配额对应的数量 config_time String 配额创建时间 remark String 配额描述: API_NUM_LIMIT:租户可以创建的API个数限制 APP_NUM_LIMIT:租户可以创建的APP个数限制 APIGROUP_NUM_LIMIT:租户可以创建的API分组个数限制
域名解绑SSL证书 功能介绍 域名解绑SSL证书。目前暂时仅支持单个解绑,请求体当中的certificate_ids里面有且只能有一个证书ID。在使用自定义入方向端口的特性时,相同的域名会同时解绑证书。 调用方法 请参见如何调用API。 URI POST /v2/{project_id}/ap
SSL证书解绑域名 功能介绍 SSL证书解绑域名。在使用自定义入方向端口的特性时,相同的域名会同时解绑证书。 调用方法 请参见如何调用API。 URI POST /v2/{project_id}/apigw/certificates/{certificate_id}/domains/detach
查看实例特性列表 功能介绍 查看实例特性列表。注意:实例不支持以下特性的需要联系技术支持升级实例版本。 支持配置的特性列表及特性配置示例请参考本手册中的“附录 > 实例支持的APIG特性”章节。 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/ap
删除SSL证书 功能介绍 删除ssl证书接口,删除时只有没有关联域名的证书才能被删除。 调用方法 请参见如何调用API。 URI DELETE /v2/{project_id}/apigw/certificates/{certificate_id} 表1 路径参数 参数 是否必选
功能介绍 导入API。导入文件内容需要符合swagger标准规范,API网关自定义扩展字段请参考《API网关用户指南》的“导入导出API:扩展定义”章节。 调用方法 请参见如何调用API。 URI POST /v2/{project_id}/apigw/instances/{instan
String API的认证方式 group_name String API所属分组的名称 publish_id String API的发布记录编号 throttle_apply_id String 与流控策略的绑定关系编号 apply_time String 已绑定的流控策略的绑定时间 remark
查询实例的终端节点服务的白名单列表 功能介绍 查询当前实例终端节点服务的白名单列表。 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/apigw/instances/{instance_id}/vpc-endpoint/permissions 表1
将API与ACL策略进行绑定 功能介绍 将API与ACL策略进行绑定。 同一个API发布到不同的环境可以绑定不同的ACL策略;一个API在发布到特定环境后只能绑定一个同一种类型的ACL策略。 调用方法 请参见如何调用API。 URI POST /v2/{project_id}/apigw/in
是否支持对请求并发次数做自定义控制? API调用是否存在带宽限制 怎样给指定的用户开放API 配置了身份认证的API,如何在特殊场景下(如指定IP地址)允许不校验身份? API导入导出 API导入失败是什么原因? swagger导入API的扩展字段有没有模板?
ingress_https_port 否 Integer 访问该域名绑定的https协议入方向端口,-1表示无端口且协议不支持,可使用443默认端口,其他有效端口允许的取值范围为1024~49151,需为实例已开放的HTTPS协议的自定义入方向端口。 当创建域名时,该参数未填表示用默认443
删除环境 功能介绍 删除指定的环境。 该操作将导致此API在指定的环境无法被访问,可能会影响相当一部分应用和用户。请确保已经告知用户,或者确认需要强制下线。 环境上存在已发布的API时,该环境不能被删除。 调用方法 请参见如何调用API。 URI DELETE /v2/{proj
域名绑定SSL证书。目前暂时仅支持单个绑定,请求体当中的certificate_ids里面有且只能有一个证书ID。使用实例自定义入方向端口的特性时,相同的域名会同时绑定证书,注意开启/关闭客户端校验会对相同域名的不同端口同时生效。 调用方法 请参见如何调用API。 URI POST /v2/{
call_limits Integer 流控时长内分组下的API的总访问次数限制,默认不限,请根据服务的负载能力自行设置 暂不支持 time_interval Integer 流控时长 暂不支持 time_unit String 流控的时间单位 暂不支持 is_default Integer
枚举 请求参数的枚举值,请求参数的值只能从枚举值中选择,多个枚举值间用英文逗号隔开。 最小长度 参数值的最小长度,仅允许输入数字。 最大长度 参数值的最大长度,仅允许输入数字。 示例 参数值的填写示例。 描述 对于此参数的描述。 单击“确定”,完成入参定义的设置。 单击“下一步”,进入“定义后端服务”页面。
SDK API网关开放的API,安全认证方式可选IAM认证、APP认证、自定义认证或无认证。四者的区别以及如何选择,请参考调用API。 本章节主要提供APP认证的SDK下载以及文档。IAM认证请参考“使用IAM认证调用API”章节。 操作场景 API使用APP认证时,请根据需要下