数据治理中心 DATAARTS STUDIO-注册API:配置API参数

时间:2023-11-21 17:10:45

配置API参数

配置API基本信息后,即可配置API参数。这里将配置API的后端服务和请求参数。

表2 API参数配置说明

配置

说明

协议

用于传输请求的协议,支持HTTP和HTTPS协议。

用于数据服务模块向待注册 API服务 传输请求。

请求方式

HTTP请求方法(也称为操作或动词),它告诉服务你正在请求什么类型的操作。用于数据服务模块向待注册API服务传输请求。

GET:请求服务器返回指定资源。

POST:请求服务器新增资源或执行特殊操作。

后端服务HOST

待注册API服务所在的Host,不能以http://或https://开头,并且不包含Path。

后端服务PATH

待注册API服务所在的Path,Path中支持参数,参数要放在{}中,如/user/{userid}。

后端超时(ms)

设置后端超时时间。

后端服务参数

请求参数位置支持Path、Header、Query,不同的请求方式所支持的可选参数位置不一样,请根据产品上提供的可选项按需选择。

常量参数

常量参数即参数值是固定的参数,对调用者不可见,API调用时不需传入常量参数,但后台服务始终接收这里定义好的常量参数及参数值。适用于当您希望把API的某个参数的取值固定为某个值以及要对调用者隐藏参数的场景。

support.huaweicloud.com/usermanual-dataartsstudio/dataartsstudio_01_0307.html