部署后端API

project_id

是

String

项目ID，获取方式请参见API参考的“附录 > 获取项目ID”章节。

instance_id

是

String

实例ID

ld_api_id

是

String

后端API的编号

X-Auth-Token

是

String

用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。

deploy_front_api

否

Boolean

是否自动发布API

• true：部署完成后自动创建并发布前端API。此时auth_type，group_id，env_id，protocol必填。

• false：部署完成后不创建前端API

缺省值：true

auth_type

否

String

认证方式

• NONE：无认证

• APP：APP认证

• IAM：IAM认证

• AUTHORIZER：自定义认证

authorizer_id

否

String

自定义认证编号。

认证方式auth_type = AUTHORIZER时必填

group_id

否

String

部署的前端API分组编号

env_id

否

String

部署的环境编号

protocol

否

String

请求协议

缺省值：HTTPS

backend_timeout

否

Integer

超时时间

path

否

String

请求路径

method

否

String

请求方式

cors

否

Boolean

是否支持跨域

• true：支持

• false：不支持

缺省值：false

roma_app_id

否

String

部署到前端的api归属的应用编号，与后端归属的应用编号保持一致

id

String

部署的编号

ld_api_id

String

部署的后端API编号

group_id

String

部署的前端API分组编号

env_id

String

部署的环境编号

api_id

String

部署的前端API编号

deploy_time

String

部署时间

api_definition

LdApiInfo object

自定义后端API详情

name

String

后端API名称。

支持汉字、英文、数字、中划线、下划线、点、斜杠、中英文格式下的小括号和冒号、中文格式下的顿号，且只能以英文、汉字和数字开头。

最小长度：3

最大长度：100

path

String

后端API请求路径。

支持英文、数字、中划线、下划线、点等，且以斜杠（/）开头。

最小长度：2

最大长度：256

method

String

后端API请求方法。

支持GET、PUT、POST、DELETE

description

String

后端API描述。

不支持<，>字符

最小长度：0

最大长度：1000

version

String

后端API版本

支持英文，数字，下划线，中划线，点。

最小长度：2

最大长度：64

content_type

String

后端API返回类型

缺省值：json

api_signature_id

String

后端API为签名认证时绑定的签名密钥编号

最小长度：1

最大长度：64

roma_app_id

String

后端API归属的集成应用编号

最小长度：1

最大长度：65

return_format

Boolean

API响应信息是否格式化

true： 对响应信息进行格式化

false：对响应信息格式化不进行格式化

缺省值：false

parameters

Array of LdApiParameter objects

后端API的请求参数列表

id

String

后端API编号

instance

String

后端API所属实例编号

type

String

后端API类型：

• data：数据后端

• function： 函数后端

status

Integer

后端API状态：

• 1：待开发

• 3：开发中

• 4：已部署

created_time

String

后端API创建时间

modified_time

String

后端API修改时间

scripts

Array of LdApiScript objects

后端API脚本信息

roma_app_name

String

后端API归属的集成应用名称

name

String

参数名称：

• 参数位于Headers、 Parameters时，用户自行定义，支持英文、数字、点、中划线、下划线，且需要英文开头，不区分大小写。

• 参数位于Body时候，参数以application/json、application/xml、application/text为名，但实际是以请求body里的键值对作为参数名和参数值，比如请求消息样例，参数名为application/json，参数值为{"table":"apic01","id":"1"}，后端取table：apic01，id：1这两个键值对作为入参。

• 注意：定义参数不要重名，否则会覆盖掉，当Headers、Parameters重复时候，Parameters会被覆盖，当Parameters和Body里的键值对重复时候，Parameters会被覆盖。

最小长度：1

最大长度：32

in

String

该参数在调用API时候所放的位置：

• Headers ：放于请求头

• Parameters ：放于请求参数

• Body：放于请求体

default

String

参数默认值

最大长度：4000

description

String

参数描述

不支持<，>字符

最小长度：0

最大长度：255

required

Boolean

参数是否必须。true：必须，false：不必须

缺省值：false

ds_id

String

数据源编号，当api_type = data时，必选

ds_name

String

数据源名称

ds_type

String

数据源类型：

• oracle：oracle数据源类型

• mysql：mysql数据源类型

• mongodb：mongodb数据源类型

• redis：redis数据源类型

• postgresql：postgresql数据源类型

• hive：hive数据源类型

• mssql：sqlserver数据源类型

• sqlserver：sqlserver数据源类型

• gauss200：gauss200数据源类型

• dws：dws数据源类型

• gauss100：gauss100数据源类型

• zenith：zenith数据源类型

type

String

脚本类型

• SQL：sql语句

• SP：存储过程

object_name

String

返回对象。

当api_type = data时，必选

最小长度：1

最大长度：32

content

String

API脚本内容

请对脚本进行base64编码

最小长度：1

最大长度：100000

enable_result_paging

Boolean

数据脚本是否结果分页，当api_type = data时有效

缺省值：false

enable_preparestatement

Boolean

数据脚本是否预编译，当api_type = data时有效

缺省值：false

created_time

String

后端API脚本创建时间

modified_time

String

后端API脚本修改时间

error_code

String

错误码

error_msg

String

错误描述

error_code

String

错误码

error_msg

String

错误描述

error_code

String

错误码

error_msg

String

错误描述

error_code

String

错误码

error_msg

String

错误描述

error_code

String

错误码

error_msg

String

错误描述

error_code

String

错误码

error_msg

String

错误描述

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

409

Conflict

500

Internal Server Error