检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
对象模型 本节介绍API及后端服务的对象模型。 “操作类型”用于描述字段的属性，表示对应字段的值可进行的操作： C：创建；U：更新；R：读取。 “是否必选”列表示对于“操作类型”为“C”的创建操作，对应字段是否为必选字段。 表1 API对象模型 参数 类型 说明 操作类型 是否必选
授权 功能介绍 APP创建成功后，还不能访问API，如果想要访问某个环境上的API，需要将该API在该环境上授权给APP。授权成功后，APP即可访问该环境上的这个API。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法
解除授权 功能介绍 解除API对APP的授权关系。解除授权后，APP将不再能够调用该API。 调用方法 请参见如何调用API。 URI DELETE /v2/{project_id}/apigw/instances/{instance_id}/app-auths/{app_auth_id}
校验API定义 功能介绍 校验API定义。校验API的路径或名称是否已存在 调用方法 请参见如何调用API。 URI POST /v2/{project_id}/apigw/instances/{instance_id}/apis/check 表1 路径参数 参数 是否必选 参数类型
创建APP 功能介绍 APP即应用，是一个可以访问API的身份标识。将API授权给APP后，APP即可调用API。 创建一个APP。 调用方法 请参见如何调用API。 URI POST /v2/{project_id}/apigw/instances/{instance_id}/apps
按需规格变更 功能介绍 创建按需规格变更订单。 调用方法 请参见如何调用API。 URI POST /v2/{project_id}/apigw/instances/{instance_id}/postpaid-resize 表1 路径参数 参数 是否必选 参数类型 描述 project_id
调试API 功能介绍 调试一个API在指定运行环境下的定义，接口调用者需要具有操作该API的权限。 调用方法 请参见如何调用API。 URI POST /v2/{project_id}/apigw/instances/{instance_id}/apis/debug/{api_id}
查询API详情 功能介绍 查看指定的API的详细信息。 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/apigw/instances/{instance_id}/apis/{api_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id
创建API分组 操作场景 创建API前，需要先创建API分组。API分组相当于API的集合，API提供者以API分组为单位，管理分组内的所有API。 一个API只能属于某一个API分组。 操作步骤 进入共享版控制台。 单击“开放API > API分组”，进入到API分组信息页面。
查看应用绑定的API详情 操作场景 在应用绑定API后，查看应用绑定的API详情。 前提条件 已创建应用。 应用已绑定API。 操作步骤 进入共享版控制台。 选择“调用API > 应用管理”，进入到应用管理信息页面。 单击待查看的应用名称，进入应用详情页面。 单击待查看的API名
自定义APIG的客户端访问端口 API网关提供自定义实例入端口功能，支持客户端通过不同的端口来访问不同的后端服务。 约束与限制 新增端口时，一个端口仅允许配置一种协议。当前仅支持HTTP和HTTPS协议。 独立域名与端口相关约束与限制内容，请参考约束与限制。 操作步骤 进入API网关控制台页面。
查询插件详情 功能介绍 查询插件详情。 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/apigw/instances/{instance_id}/plugins/{plugin_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id
修改APP 功能介绍 修改指定APP的信息。其中可修改的属性为：name、remark，当支持用户自定义key和secret的开关开启时，app_key和app_secret也支持修改，其它属性不可修改。 调用方法 请参见如何调用API。 URI PUT /v2/{project
修改域名 功能介绍 修改绑定的域名所对应的配置信息。使用实例自定义入方向端口的特性时，注意开启/关闭客户端校验会对相同域名的不同端口同时生效。 调用方法 请参见如何调用API。 URI PUT /v2/{project_id}/apigw/instances/{instance_
查询API列表 功能介绍 查看API列表，返回API详细信息、发布信息等，但不能查看到后端服务信息。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI GET /v1.0/apigw/apis[?page_size
查看ACL策略详情 功能介绍 查询指定ACL策略的详情。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI GET /v1.0/apigw/acls/{id} URI中的参数说明如下表所示。 表2 参数说明
绑定域名 功能介绍 用户自定义的域名，需要增加A记录才能生效，具体方法请参见《云解析服务用户指南》的“添加A类型记录集”章节。 每个API分组下最多可绑定5个域名。绑定域名后，用户可通过自定义域名调用API。 调用方法 请参见如何调用API。 URI POST /v2/{proj
删除API 功能介绍 删除指定的API。 删除API时，会删除该API所有相关的资源信息或绑定关系，如API的发布记录，绑定的后端服务，对APP的授权信息等。 调用方法 请参见如何调用API。 URI DELETE /v2/{project_id}/apigw/instances
删除APP 功能介绍 删除指定的APP。 APP删除后，将无法再调用任何API；其中，云商店自动创建的APP无法被删除。 调用方法 请参见如何调用API。 URI DELETE /v2/{project_id}/apigw/instances/{instance_id}/apps/{app_id}
查看版本详情 功能介绍 查询某个指定的版本详情。 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/apigw/instances/{instance_id}/apis/versions/{version_id} 表1 路径参数 参数 是否必选 参数类型
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
