小白接口

8603 添加模型字段 App.Platform_MyModels.AddNewField

接口地址:http://open.phalapi.net/?s=App.Platform_MyModels.AddNewField

接口描述: 为模型添加新字段,每个模型最多可创建100个字段。

接口标签:免费(每月最高10万次)付费(包月/按量/私服)验签

请求协议
HTTP/HTTPS
请求方式
GET/POST(推荐POST)
编码格式
UTF-8
返回格式
JSON

在线测试    添加收藏    直接访问接口    我要调整此接口


接口参数 若无特殊说明,接口参数同时支持GET和POST传递;推荐:查询/删除用GET,创建/更新用POST。

参数名字参数类型是否必须默认值备注参数说明
app_key字符串必须最小:32公共参数 开发者应用的app_key,查看我的app_key,如果还没有,可免费注册开通。
sign字符串可选公共参数 动态签名,签名生成算法请见:如何生成签名,或直接使用封装好的SDK开发包
如果不需要签名,可进入小白开放平台接口签名设置关闭或开启签名。通过在线测试工具可进行签名的对比和调试。 企业版支持专属签名算法定制。
uuid字符串可选最大:32公共参数 UUID,当前登录的应用会员ID,即全局唯一用户ID,查看我的应用会员。传递此参数后,可以在开放平台查看每日活跃会员统计图表。
token字符串可选最小:64;最大:64公共参数 当前登录会员的会话凭证,可通过会员登录接口获得。
return_data字符串可选0公共参数 数据返回结构,其中:
  • return_data=0,返回完整的接口结果,示例:{"ret":200,"data":{"err_code":0,"err_msg":"","title":"Hi YesApi,欢迎使用小白开放接口!"},"msg":"V3.1.0 YesApi App.Hello.World"}
  • return_data=1,返回简洁的接口结果,只返回data字段,结构简化一级,更扁平,示例:{"err_code":0,"err_msg":"V3.1.0 YesApi App.Hello.World","title":"Hi YesApi,欢迎使用小白开放接口!"}
model_name字符串必须模型名称(英文)
field_name字符串必须最小:1;最大:50字段名称(英文),请填写有效的数据库表字段名称,如:demo
field_desc字符串必须最小:1;最大:100字段描述(中文),将会显示在各大菜单,如:示例数据
field_type枚举类型必须范围:tinyint/smallint/mediumint/int/bigint/float/double/char/varchar/tinytext/text/mediumtext/longtext/date/time/year/datetime/timestamp字段类型,可选字段类型如下:
  • tinyint:数值 - tinyint - 小整数值(-128~127)
  • smallint:数值 - smallint - 大整数值(-32768~32767)
  • mediumint:数值 - mediumint - 大整数值(-8388608~8388607)
  • int:数值 - int - 大整数值(-2^31~2^31-1)
  • bigint:数值 - bigint - 极大整数值(-2^63~2^63-1)
  • float:数值 - float - 单精度浮点数值(-3.4E+38~3.4E+38)
  • double:数值 - double - 双精度浮点数值(-1.79E+308~1.79E+308()
  • char:字符串 - char - 定长字符串(1~255 个字节)
  • varchar:字符串 - varchar - 变长字符串(1~255 个字节)
  • tinytext:字符串 - tinytext - 短文本字符串(最大长度255个字节)
  • text:字符串 - text - 长文本数据(最大长度65535个字节)
  • mediumtext:字符串 - mediumtext - 中等长度文本数据(最大长度 16777215 个字节)
  • longtext:字符串 - longtext - 极大文本数据(最大长度4294967295个字节)
  • date:日期时间 - date - 日期值(yyyy-mm-dd)
  • time:日期时间 - time - 时间值或持续时间(hh:mm:ss)
  • year:日期时间 - year - 年份值(yyyy)
  • datetime:日期时间 - datetime - 混合日期和时间值(yyyymmddhhmmss)
  • timestamp:日期时间 - timestamp - 时间戳
field_length整型可选0字段类型长度,重要提示:varchar时长度必填!
field_default字符串可选最大:80各类型的缺省默认值分别是:int为0、double为0、varchar为空字符串,datetime为19 70-01-01 00:00:00,date为1970-01-01。特别地,输入@NULL表示NULL
field_is_null布尔型可选true是否允许空值,1可为NULL,0不可为NULL(即字段必须)
field_index枚举类型可选no范围:no/normal/unique索引,no无索引,normal普通索引,unique唯一索引。注意:如果需要添加唯一索引,请确保现有表数据无重复值,否则会添加失败。索引创建失败不会影响字段的创建。

在线测试

参数是否必填
s 必须
uuid 可选
token 可选
return_data 可选
model_name 必须
field_name 必须
field_desc 必须
field_type 必须
field_length 可选
field_default 可选
field_is_null 可选
field_index 可选

客户端请求示例

查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名

请求:
{你的接口域名}/?s=App.Platform_MyModels.AddNewField&model_name=test&field_name=test_name&field_desc=字段说明&field_type=varchar&field_length=100&field_is_null=1&field_index=no&app_key={你的app_key}&sign={动态签名}

返回:
{
    "ret": 200,
    "data": {
        "err_code": 0,
        "err_msg": ""
    },
    "msg": "V1.4.14 小白开放接口 App.Platform_MyModels.AddNewField"
}

接口使用帮助说明

小白君正在拼命补充中……

返回结构说明

返回字段类型说明
ret整型接口状态码,200表示成功,4xx表示客户端非法请求,5xx表示服务端异常,查看异常错误码
data.err_code整型操作码,0成功,1字段已存在,2字段数量已达到上限,3创建失败请重试,4接口创建失败 5模型不存在
data.err_msg字符串错误提示信息,err_code非0时参考此提示信息
msg字符串提示信息,面向技术人员的帮助或错误提示信息

ret异常错误码

错误码错误类型错误描述信息解决方法
ret = 200成功请求成功
ret = 400客户端非法请求非法请求,参数错误1、根据接口文档的接口参数,提供正确的参数
ret = 404客户端非法请求接口服务不存在1、查看小白接口大全,确保接口服务名称拼写正确
ret = 500小白接口异常如果出现此错误,请联系技术人员处理1、进入QQ交流群897815708,反馈问题;2、或者提交工单,一天内回复
ret = 401客户端非法请求用户未登录,或登录凭证已过期1、如果用户未注册,请先用注册接口;2、如果注册未登录或会话过期,请先用登录接口
ret = 406客户端非法请求非法app_key,请核对你所在的接口域名1、在我的套餐查看并核对接口域名
ret = 407客户端非法请求当前应用已过期1、进行续费或续约,延长应用有效期
ret = 408客户端非法请求当前应用存在异常,已被封号1、联系在线客服人工处理
ret = 409客户端非法请求签名错误1、使用在线测试,校正签名;2、关闭特定或全部签名设置;3、如果过期,可以进行续约/升级
ret = 410客户端非法请求权限不足,非系统管理员1、应用权限不足,可联系在线客服咨询沟通
ret = 411客户端非法请求权限不足,应用管理员未登录1、请提供应用管理员的admin_uuid和admin_token参数后重试
ret = 412客户端非法请求权限不足,非应用管理员1、请在果创云把会员设置为管理员
ret = 413客户端非法请求本月接口流量超出,已被临时冻结1、开通接口流量叠加包,或升级套餐
ret = 414客户端非法请求并发过高1、请降低请求频率,检测是否有死循环调用,或是否被他人恶意使用。如果流量确实很大,可联系在线客服进行定制化或私有云部署。
ret = 415客户端非法请求接口已被开发者关闭1、接口已被开发者关闭,请进入果创云接口开关重新开启
ret = 416客户端非法请求权限不足,个人免费版套餐无法使用专业版接口1、请先升级终身会员/标准版/旗舰版/企业版

常见问题FAQ

Q1 问:出现 414 Request-URI Too Large 时怎么解决?答:对于全部参数,改用POST方式传递,并且从GET链接里面去掉。