检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
下线API 操作场景 已发布的API因为其他原因需要暂停对外提供服务，可以暂时将API从相关环境中下线。 该操作将导致此API在指定的环境无法被访问，请确保已经告知使用此API的用户。 前提条件 已创建API分组和分组内的API。 API已发布到该环境。 操作步骤 进入共享版控制台
删除API 操作场景 已发布的API不再提供服务，可以将API删除。 该操作将导致此API无法被访问，可能会影响正在使用此API的应用或者用户，请确保已经告知用户。 已上架云商店的API，无法被删除。 已发布的API，需要先下线API，再删除。 操作步骤 进入共享版控制台。 单击“
删除环境 操作场景 已创建的环境不再提供服务，可以将环境删除。 前提条件 已创建环境。 操作步骤 进入共享版控制台。 选择“开放API > 环境管理”，进入到环境管理信息页面。 在待删除的环境所在行，单击“删除”，弹出对话框。 仅在环境未被API发布时，支持删除。 单击“确定”，完成环境管理信息
开启跨域访问 什么是跨域访问 浏览器出于安全性考虑，会限制从页面脚本内发起的跨域访问（CORS）请求，此时页面只能访问同源的资源，而CORS允许浏览器向跨域服务器，发送XMLHttpRequest请求，从而实现跨域访问。 图1 跨域访问示意图 浏览器将CORS请求分为两类： 简单请求
修改API 功能介绍 修改指定API的信息，包括后端服务信息。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI PUT /v1.0/apigw/apis/{id} URI中的参数说明如下表所示。 表2 参数说明
删除API 功能介绍 删除指定的API。 删除API时，会删除该API所有相关的资源信息或绑定关系，如API的发布记录，绑定的后端服务，对APP的授权信息等。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI
创建APP 功能介绍 APP即应用，是一个可以访问API的身份标识。将API授权给APP后，APP即可调用API。 创建一个APP。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI POST /v1.0/apigw
校验APP 功能介绍 校验APP是否存在，非APP所有者可以调用该接口校验APP是否真实存在。这个接口只展示app的基本信息id 、name、 remark，其他信息不显示。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI
创建环境 功能介绍 在实际的生产中，API提供者可能有多个环境，如开发环境、测试环境、生产环境等，用户可以自由将API发布到某个环境，供调用者调用。对于不同的环境，API的版本、请求地址甚至于包括请求消息等均有可能不同。如：某个API，v1.0的版本为稳定版本，发布到了生产环境供生产使用
对象模型 本节介绍自定义域名及证书的对象模型。 “操作类型”用于描述字段的属性，表示对应字段的值可进行的操作： C：创建；U：更新；R：读取。 “是否必选”列表示对于“操作类型”为“C”的创建操作，对应字段是否为必选字段。 表1 域名对象模型 参数 类型 说明 操作类型 是否必选
对象模型 本节介绍VPC通道的对象模型。 “操作类型”用于描述字段的属性，表示对应字段的值可进行的操作： C：创建；U：更新；R：读取。 “是否必选”列表示对于“操作类型”为“C”的创建操作，对应字段是否为必选字段。 表1 VPC通道对象模型 参数 类型 说明 操作类型 是否必选
查看版本详情 功能介绍 查询某个指定的版本详情。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI GET /v1.0/apigw/apis/versions/{version_id} URI中的参数说明如下表所示
调试API 功能介绍 调试一个API在指定运行环境下的定义，接口调用者需要具有操作该API的权限。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI POST /v1.0/apigw/apis/debug/{
删除分组 操作场景 API分组在创建后，如需对创建的数据进行删除，可以删除此分组。 如果API分组下存在API，API分组无法被删除。 前提条件 已创建分组。 操作步骤 进入共享版控制台。 单击“开放API > API分组”，进入到API分组信息页面。 通过以下任意一种方式，进入“
绑定域名 操作场景 开放API前，您需要为API分组绑定一个或多个独立域名，API网关通过独立域名定位到此分组。 共享版中，不同分组下不能绑定相同的独立域名。 在绑定域名前，您需要理解以下2个概念： 子域名：API分组创建后，系统为分组自动分配一个内部测试用的子域名，此子域名唯一且不可更改
创建API 功能介绍 添加一个API，API即一个服务接口，具体的服务能力。 API分为两部分，第一部分为面向API使用者的API接口，定义了使用者如何调用这个API。第二部分面向API提供者，由API提供者定义这个API的真实的后端情况，定义了API网关如何去访问真实的后端服务。
对象模型 本节介绍环境的对象模型。 “操作类型”用于描述字段的属性，表示对应字段的值可进行的操作： C：创建；U：更新；R：读取。 “是否必选”列表示对于“操作类型”为“C”的创建操作，对应字段是否为必选字段。 表1 环境管理对象模型 参数 类型 说明 操作类型 是否必选 id String
删除环境 功能介绍 删除指定的环境。 该操作将导致此API在指定的环境无法被访问，可能会影响相当一部分应用和用户。请确保已经告知用户，或者确认需要强制下线。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI
绑定域名 功能介绍 用户自定义的域名，需要CNAME到API分组的子域名上才能生效，具体方法请参见增加CNAME类型记录集。 每个API分组下最多可绑定5个域名。绑定域名后，用户可通过自定义域名调用API。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP
发布API 功能介绍 将一个指定的API发布到一个指定的环境，API只有发布后，才能够被调用，且只能在该环境上才能被调用。未发布的API无法被调用。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI POST
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
