检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
HTTP：web后端 FUNCTION：函数工作流 MOCK：mock tag 否 String 服务名称标签 待废弃字段 tags 否 []String 标签 包含一个服务名称标签和若干其它标签 服务名称标签非必填，必须以APIG-SN-开头 其它标签非必填，且不能以APIG-SN-开头
根据版本编号下线API 功能介绍 对某个生效中的API版本进行下线操作，下线后，API在该版本生效的环境中将不再能够被调用。 该接口供FunctionGraph服务使用。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI DELETE
创建告警规则 操作场景 通过创建告警规则，您可自定义监控目标与通知策略，及时了解API网关服务运行状况，从而起到预警作用。 告警规则包括告警规则名称、监控对象、监控指标、告警阈值、监控周期和是否发送通知等参数。 前提条件 API已被调用。 操作步骤 进入共享版控制台。 单击“开放API
删除API 功能介绍 删除指定的API。 删除API时，会删除该API所有相关的资源信息或绑定关系，如API的发布记录，绑定的后端服务，对APP的授权信息等。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI
删除API 功能介绍 删除指定的API。 删除API时，会删除该API所有相关的资源信息或绑定关系，如API的发布记录，绑定的后端服务，对APP的授权信息等。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI
删除签名密钥 操作场景 如果某一个密钥不再提供服务，则可以将其删除。 前提条件 已创建密钥。 操作步骤 进入共享版控制台。 单击“开放API > 签名密钥”，进入签名密钥管理信息页面。 通过以下任意一种方法，弹出对话框。 在待删除的密钥所在行，单击“删除”。 单击“密钥名称”，进
Integer 是否需要编排 1：是 2：否 目前默认为：2 R - backend_type String 后端服务类型： HTTP：web后端 FUNCTION：函数服务 MOCK： MOCK CRU 是 register_time Timestamp API创建时间 R - update_time
Integer 是否需要编排 1：是 2：否 目前默认为：2 R - backend_type String 后端服务类型： HTTP：web后端 FUNCTION：函数服务 MOCK： MOCK CRU 是 register_time Timestamp API创建时间 R - update_time
删除应用 操作场景 已创建的应用不再提供服务，可以将应用删除。 从云商店购买的API生成的应用，不支持删除。 前提条件 已创建应用。 操作步骤 进入共享版控制台。 单击“调用API > 应用管理”，进入到应用管理信息页面。 通过以下任意一种方式，进入对话框。 在待删除的应用所在行，单击“删除”。
自定义认证的函数开发：使用自定义认证时，在函数服务中编写一个函数，将其作为认证服务。 创建用于前端自定义认证的函数：API网关利用函数对收到的API请求进行安全认证。 创建用于后端自定义认证的函数：API后端服务利用函数对来自API网关转发的API请求进行安全认证。 后端服务签名校验开发：若API在A
在“API运行”页面，单击“更多 > 克隆”。 自定义API名称和API前端路径，单击“确定”。 后续操作 API克隆完成后，通过调试API，验证服务是否正常。 父主题： 管理API
查询API列表 功能介绍 查看API列表，返回API详细信息、发布信息等，但不能查看到后端服务信息。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI GET /v1/{project_id}/apigw/
查询API列表 功能介绍 查看API列表，返回API详细信息、发布信息等，但不能查看到后端服务信息。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI GET /v1.0/apigw/apis[?page_size
创建API分组 功能介绍 API分组是API的管理单元，一个API分组等同于一个服务入口，创建API分组时，返回一个子域名作为访问入口。建议一个API分组下的API具有一定的相关性。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI
x-apigateway-backend.httpEndpoints HTTP类型服务定义 httpVpcEndpoints 否 x-apigateway-backend.httpVpcEndpoints HTTP-VPC类型服务定义 functionEndpoints 否 x-apigateway-backend
自定义认证依赖函数工作流服务。如果当前Region没有上线函数工作流服务，则不支持使用自定义认证。 自定义认证的具体使用指导，可参考《API网关开发指南》的自定义认证相关章节。 使用自定义认证调用API的流程如下图所示： 图1 通过自定义认证调用API 前提条件 已在函数工作流服务中完成函数创建。
基础定义：包括API前端请求定义和响应定义，不包括后端服务定义。其中API前端请求定义除了Swagger规范定义项外，还包括API网关的一些Swagger扩展字段。 全量定义：包括API前端请求定义、后端服务定义和响应定义。 扩展定义：包括API前端请求定义、后端服务定义和响应定义，还包括API关联的流量控制、访问控制等策略对象的定义。
下线API 操作场景 已发布的API因为其他原因需要暂停对外提供服务，可以暂时将API从相关环境中下线。 该操作将导致此API在指定的环境无法被访问，请确保已经告知使用此API的用户。 前提条件 已创建API分组和分组内的API。 API已发布到该环境。 操作步骤 进入共享版控制台。
删除API 操作场景 已发布的API不再提供服务，可以将API删除。 该操作将导致此API无法被访问，可能会影响正在使用此API的应用或者用户，请确保已经告知用户。 已上架云商店的API，无法被删除。 已发布的API，需要先下线API，再删除。 操作步骤 进入共享版控制台。 单击“开放API
下线APIG的API 已发布的API因为其他原因需要暂停对外提供服务，可以暂时将API从相关环境中下线。 该操作将导致此API在指定的环境无法被访问，请确保已经告知使用此API的用户。 前提条件 已创建API分组和分组内的API。 API已发布到该环境。 操作步骤 进入API网关控制台页面。
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
