检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
本次查询返回的列表长度 api_versions 字典数据类型 本次查询返回的API历史版本列表 表4 api_versions参数说明 参数 类型 说明 version_id String API历史版本的ID version_no String API的版本号 api_id String API编号
请求方法 URI POST /v1.0/apigw/app-auths 请求消息 表2 参数说明 名称 是否必选 类型 说明 api_ids 是 Array of strings API的编号列表 可以选择租户自己的API，也可以选择从云商店上购买的API。 app_ids 是 Array
在实际的生产中，API提供者可能有多个环境，如开发环境、测试环境、生产环境等，用户可以自由将API发布到某个环境，供调用者调用。对于不同的环境，API的版本、请求地址甚至于包括请求消息等均有可能不同。如：某个API，v1.0的版本为稳定版本，发布到了生产环境供生产使用，同时，该API正处于迭代中，v1
HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI GET /v1.0/apigw/apps/{id} URI中的参数说明如下表所示。 表2 参数说明 名称 是否必选 类型 说明 id 是 String APP的编号
Code，App Code删除后，将无法再通过简易认证访问对应的API。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI DELETE /v1.0/apigw/apps/{app_id}/app-codes/{id}
该操作将导致此API在指定的环境无法被访问，可能会影响相当一部分应用和用户。请确保已经告知用户，或者确认需要强制下线。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI DELETE /v1.0/apigw/envs/{id}
HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI PUT /v1.0/apigw/envs/{id} URI中的参数说明如下表所示。 表2 参数说明 名称 是否必选 类型 说明 id 是 String 环境的ID，可通过查询环境信息获取该ID
导入API 操作场景 API网关支持导入Swagger 2.0定义的API到已有的API分组或新的API分组。Swagger是基于OpenAPI规范构建的开源工具，可以帮助您设计、构建、记录以及使用Rest API。 导入API支持单个API导入和批量API导入，主要取决于Swagger文件中包含的API数量。
调用API API提供者在API网关开放自己的API后，API调用者从API网关中调用API。 调用限制 如果您使用调试域名（创建API分组时系统分配的调试域名）访问API，该调试域名每天最多可以访问1000次。 获取API的调用信息 在调用API前，您需要向API提供者获取API的调用信息。
未解析 2 解析中 3 解析成功 4 解析失败 R 否 ssl_id String 证书的编号 R 否 group_id String API分组的编号 CR 是 表2 证书对象模型 参数 类型 说明 操作类型 是否必选 id String 证书的编号 R - name String
HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI POST /v1.0/apigw/apps/{app_id}/app-codes URI中的参数说明如下表所示。 表2 参数说明 名称 是否必选 类型 说明 app_id
HTTP状态码 常用状态码表如表1所示。 表1 HTTP请求状态返回码 返回值 说明 200 OK 处理正常。 204 No Content 无返回内容。 400 Bad Request 服务器未能处理请求。可能原因： 语义有误，当前请求无法被服务器解析； 请求参数有误。 401
String API分组编号 R - NAME String API分组名称 CRU 是 STATUS Integer API分组状态 1 正常状态 2 禁用状态 3 已删除 默认值1 该字段暂时废弃 R - SL_DOMAIN String API分组的子域名，由API网关分配，用户不可填写和修改
对象模型 管理系统的默认配置，管理租户可以根据系统的实际运行情况对这些配置的值进行修改。 “操作类型”用于描述字段的属性，表示对应字段的值可进行的操作： C：创建；U：更新；R：读取。 “是否必选”列表示对于“操作类型”为“C”的创建操作，对应字段是否为必选字段。 表1 系统配置对象模型
对象模型 本节介绍环境的对象模型。 “操作类型”用于描述字段的属性，表示对应字段的值可进行的操作： C：创建；U：更新；R：读取。 “是否必选”列表示对于“操作类型”为“C”的创建操作，对应字段是否为必选字段。 表1 环境管理对象模型 参数 类型 说明 操作类型 是否必选 id String
roma_app_name String API归属的集成应用名称 暂不支持 ld_api_id String 当API的后端为自定义后端时，对应的自定义后端API编号 暂不支持 backend_api BackendApi object 后端信息 api_group_info ApiGroupCommonInfo
解除绑定 功能介绍 解除API与流控策略的绑定关系。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI DELETE /v1/{project_id}/apigw/instances/{instance_i
String 流控策略的ID CR 是 front_api_id String API的编号 CR 是 env_id String 绑定的环境编号 CR 是 create_time Timestamp 绑定时间 R - 父主题： API绑定流控策略（待下线）
新建变量 功能介绍 将API发布到不同的环境后，对于不同的环境，可能会有不同的环境变量，比如，API的服务部署地址，请求的版本号等。 用户可以定义不同的环境变量，用户在定义API时，在API的定义中使用这些变量，当调用API时，API网关会将这些变量替换成真实的变量值，以达到不同环境的区分效果。
解除授权 功能介绍 解除API对APP的授权关系。解除授权后，APP将不再能够调用该API。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI DELETE /v1.0/apigw/app-auths/{id}
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
