绑定域名 功能介绍 用户自定义的域名,需要增加A记录才能生效,具体方法请参见《云解析服务用户指南》的“添加A类型记录集”章节。 每个API分组下最多可绑定5个域名。绑定域名后,用户可通过自定义域名调用API。 调用方法 请参见如何调用API。
通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。
将鼠标移至左侧图标展开服务列表,输入“标签管理服务”搜索。 进入标签管理服务控制台,填写搜索信息搜索,过滤实例资源。 区域:选择API网关所在区域。 资源类型:选择“APIG”。 资源标签:选择已添加的标签键。 父主题: 管理APIG实例
通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 表3 请求Body参数 参数 是否必选 参数类型 描述 acl_name 是 String ACL策略名称。支持汉字,英文,数字,下划线,且只能以英文和汉字开头,3 ~ 64字符。
query、path origin 是 String 参数映射来源,支持REQUEST、CONSTANT description 否 String 参数含义描述 表18 后端httpEndpoints参数说明 名称 是否必选 参数类型 说明 address 是 String 后端服务地址
query、path origin 是 String 参数映射来源,支持REQUEST、CONSTANT description 否 String 参数含义描述 表18 后端httpEndpoints参数说明 名称 是否必选 参数类型 说明 address 是 String 后端服务地址
签名密钥 签名密钥由一对Key和Secret组成,用于后端服务验证API网关的身份,在API网关请求后端服务时,保障后端服务的安全。
500 Internal Server Error 服务器遇到了一个未曾预料的状况,导致无法完成对请求的处理。 501 Not Implemented 请求未完成。服务器不支持所请求的功能。 502 Bad Gateway 请求未完成。服务器从上游服务器收到一个无效的响应。
浏览器询问服务器,当前页面所在的源是否在服务器的许可名单之中,以及可以使用哪些HTTP请求方法和头信息字段。预检通过后,浏览器向服务器发送简单请求。 开启跨域访问 API网关默认不开启跨域访问,如果您需要开启,请参考以下说明完成跨域配置。
浏览器询问服务器,当前页面所在的源是否在服务器的许可名单之中,以及可以使用哪些HTTP请求方法和头信息字段。预检通过后,浏览器向服务器发送简单请求。 开启跨域访问 API网关默认不开启跨域访问,如果您需要开启,请参考以下说明完成跨域配置。
下线APIG的API 已发布的API因为其他原因需要暂停对外提供服务,可以暂时将API从相关环境中下线。 该操作将导致此API在指定的环境无法被访问,请确保已经告知使用此API的用户。 前提条件 已创建API分组和分组内的API。 API已发布到指定环境。
创建API的负载通道(可选) 如果需要访问指定服务器中已部署的后端服务,可通过创建负载通道来实现。反之,跳过此步骤。 创建API 把已有后端服务封装为标准RESTFul API或GRPC API,并对外开放。 API创建成功后,您可根据业务需求配置API策略,管理API等。
通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。
定义的后端服务协议须与用户的后端业务协议保持一致。 后端服务地址 仅在不使用负载通道时,需要设置。 填写后端服务的访问地址,格式:“主机:端口”。主机为后端服务的访问IP地址/域名;端口为后端服务的端口。
在创建API时,配置双向认证,在API网关和后端服务间启用双向认证。配置请参考创建API章节中的“TLS双向认证”参数说明。 共享版:不支持,API网关仅做HTTPS的单向认证。 父主题: API认证
创建API分组 功能介绍 API分组是API的管理单元,一个API分组等同于一个服务入口,创建API分组时,返回一个子域名作为访问入口。建议一个API分组下的API具有一定的相关性。 调用方法 请参见如何调用API。
下线API 操作场景 已发布的API因为其他原因需要暂停对外提供服务,可以暂时将API从相关环境中下线。 该操作将导致此API在指定的环境无法被访问,请确保已经告知使用此API的用户。 前提条件 已创建API分组和分组内的API。 API已发布到该环境。
删除API 操作场景 已发布的API不再提供服务,可以将API删除。 该操作将导致此API无法被访问,可能会影响正在使用此API的应用或者用户,请确保已经告知用户。 已发布的API,需要先下线API,再删除。 操作步骤 进入共享版控制台。
开放API 将成熟的业务能力(如服务、数据等)作为后端服务,在API网关中开放API,提供给API调用者使用,实现业务能力变现。
您可以通过调整请求参数与参数值,发送不同的请求,验证API服务。 相关文档 API调试成功后,您可以将API发布到环境,以便API调用者调用。或者出于API的安全性考虑,为API添加策略。 父主题: 开放API