API管理

同一类业务API的集合,API开发者以API管理为单位,管理内的所有API。

API管理列表

基础操作

1.登录能力集成中枢实例控制台。

2.点击“服务集成-》API管理”,进入API管理列表页面。

属性说明

属性名称 属性说明
名称 指定应用下的所有API。
请求方法+路径 对应API的访问方法和URI地址。
分组 此API所属的分组。
类型 目前仅支持私有。
运行环境 包括上线或测试环境,或者两者都支持。
操作 对此管理的操作,包括查看、编辑、发布、更多,更多包括调试、下线、删除、导出API。

创建服务API

创建请求

基本操作

1.登录能力集成中枢实例控制台。

2.点击“服务集成-》API管理”,进入API管理列表页面,再点击“创建服务API”按钮,进入创建API请求页面。

属性说明

基础信息属性

属性名称 属性说明
名称 2~60个字符,支持汉字、英文、数字、下划线、中划线,且只能以英文字母或汉字开头,应用名称必须唯一。
选择应用 选择创建API所属应用,一个API只能属于一个应用。
选择分组 选择创建API所属分组,一个API只能属于一个分组。
认证方式 访问API的认证方式,包括免鉴权、IAM认证、APP认证。
请求协议 可选择HTTP、HTTPS、HTTP(S)。
请求方法 选择API的请求方法。POST、GET、PUT、DELETE、OPTIONS、PATCH、HEAD、ANY。
支持跨域 是否开启跨域访问。
描述 不超过200字符。

入参定义信息属性表(选填)

属性名称 属性说明
参数名称 1-40个字符,支持英文,数字,点,中划线,下划线,且只能以英文开头,名称唯一。
参数位置 可选项QUERY、PATH、HEAD。
类型 可选择String、Float、Int、Boolean。
必填 参数是否必填。
默认值 用户不填此参数时,默认值。
描述 不超过200字符。

定义后端服务

基本操作

基于创建请求页面,点击下一步,进入定义后端服务页面。

属性说明

后端基础定义表

属性名称 属性说明
后端类型 可选择HTTP(S)、函数计算、Mock。
后端地址 访问后端服务对应访问地址。
后端路径 访问后端服务的URI。
请求方法 选择API的请求方法。POST、GET、PUT、DELETE、OPTIONS、PATCH、HEAD、ANY。
后端超时 当访问后端服务无响应的最大时间,单位是毫秒。

后端参数映射表(选填)

属性名称 属性说明
请求参数名称 请求参数名称,对应定义请求的参数名,此处不可修改。
请求参数位置 请求参数位置,对应定义请求的参数位置,此处不可修改
后端参数名称 对应后端服务的参数名,1-40个字符,支持英文,数字,点,中划线,下划线,且只能以英文开头,名称唯一。
后端参数位置 对应后端服务的参数位置,可选项QUERY、PATH、HEAD。

后端常量设置属性表(选填)

属性名称 属性说明
参数名称 1-40个字符,支持英文,数字,点,中划线,下划线,且只能以英文开头,名称唯一。
参数值 常量参数对应的值。
参数位置 可选项QUERY、PATH、HEAD。
描述 不超过200字符。

定义返回结果

基本操作

基于创建后端服务页面,点击下一步,进入定义返回结果页面。

属性说明

错误码定义表(选填)

属性名称 属性说明
错误码 定义返回错误码。
错误信息 定义返回错误信息。
描述 不超过200字符。

最终响应Header属性表(选填)

属性名称 属性说明
参数名称 1-40个字符,支持英文,数字,点,中划线,下划线,且只能以英文开头,名称唯一。
描述 不超过200字符。

最终响应Body示例属性表(选填)

属性名称 属性说明
Content-Type 对应后端服务Body类型。
成功返回示例 定义后端调用成功返回的示例。
失败返回示例 定义后端调用失败返回的示例。

最终响应Header映射属性表(选填)

属性名称 属性说明
参数位置 可选项QUERY、PATH、HEAD。
后端参数名称 1-40个字符,支持英文,数字,点,中划线,下划线,且只能以英文开头,名称唯一。
最终响应Header 对应最终响应Header参数名。

创建函数API

基本操作

1.登录能力集成中枢实例控制台。

2.点击“服务集成-》API管理”,进入API管理列表页面,再点击“创建函数API”按钮,进入创建API请求页面。

属性说明

基础信息属性

属性名称 属性说明
名称 2~60个字符,支持汉字、英文、数字、下划线、中划线,且只能以英文字母或汉字开头,应用名称必须唯一。
选择应用 选择创建API所属应用,一个API只能属于一个应用。
选择分组 选择创建API所属分组,一个API只能属于一个分组。
认证方式 访问API的认证方式,包括免鉴权、IAM认证、APP认证。
请求协议 可选择HTTP、HTTPS、HTTP(S)。
请求方法 选择API的请求方法。POST、GET、PUT、DELETE、OPTIONS、PATCH、HEAD、ANY。
支持跨域 是否开启跨域访问。
描述 不超过200字符。

入参定义信息属性表(选填)

属性名称 属性说明
参数名称 1-40个字符,支持英文,数字,点,中划线,下划线,且只能以英文开头,名称唯一。
参数位置 可选项QUERY、PATH、HEAD。
类型 可选择String、Float、Int、Boolean
必填 参数是否必填。
默认值 用户不填此参数时,默认值。
描述 不超过200字符。

查看API

概述

描述此API配置的信息

基础操作

1.登录能力集成中枢实例控制台。

2.方法一:点击“服务集成-》API管理”,进入API管理列表页面,选择具体一个API,再点击操作栏下“查看”链接,进入查看页面。

3.方法二:点击“服务集成-》API管理”,进入API管理列表页面,选择具体一个API,再点击API名连接,进入查看页面。

流量管理

描述此API绑定的流量策略,并可对策略进行管理。

基础操作

1.登录能力集成中枢实例控制台。

2.点击“服务集成-》API管理”,进入API管理列表页面,选择具体一个API,再点击操作栏下“查看”链接,进入查看页面。

3.点击流量管理,进入此API的流量管理页面。

访问控制

描述此API绑定的访问策略,并可对访问控制进行管理。

基础操作

1.登录能力集成中枢实例控制台。

2.点击“服务集成-》API管理”,进入API管理列表页面,选择具体一个API,再点击操作栏下“查看”链接,进入查看页面。

3.点击访问控制,进入此API的访问控制理页面。

授权应用

描述此API已授权的应用,并可对授权进行管理。

基础操作

1.登录能力集成中枢实例控制台。

2.点击“服务集成-》API管理”,进入API管理列表页面,选择具体一个API,再点击操作栏下“查看”链接,进入查看页面。

3.点击授权应用,进入此API的授权应用页面。

签名密钥

描述此API签名密钥。

基础操作

1.登录能力集成中枢实例控制台。

2.点击“服务集成-》API管理”,进入API管理列表页面,选择具体一个API,再点击操作栏下“查看”链接,进入查看页面。

3.点击签名密钥,进入此API的签名密钥页面。

访问统计

描述此API访问的情况。

基础操作

1.登录能力集成中枢实例控制台。

2.点击“服务集成-》API管理”,进入API管理列表页面,选择具体一个API,再点击操作栏下“查看”链接,进入查看页面。

3.点击访问统计,进入此API的访问统计页面。

发布历史

描述此API发布情况。

基础操作

1.登录能力集成中枢实例控制台。

2.点击“服务集成-》API管理”,进入API管理列表页面,选择具体一个API,再点击操作栏下“查看”链接,进入查看页面。

3.点击发布历史,进入此API的发布历史页面。

发布API

基础操作

1.登录能力集成中枢实例控制台。

2.点击“服务集成-》API管理”,进入API管理列表页面,选择具体一个API,再点击操作栏下“发布”链接,进入发布API页面。

属性说明

属性名称 属性说明
API名称 对应API名称。
请求方法和路径 对应API调用的请求方法和URI地址。
选择环境 可选择线上或测试。
发布描述 不超过200字符。