产品说明
本开发手册对该系统功能接口进行详细的描述,通过该指南可以对本系统有全面的了解,使技术人员尽快掌握本系统的接口,并能够在本系统上进行开发。
名词解释
名词缩写 |
名词定义 |
客户端 |
本文档中的客户端为ApiPost客户端。 |
服务端 |
本文档中的服务端为用户端。 |
环境变量 |
本系统中动态的KV参数。 |
请求头参数说明
参数名 |
示例值 |
参数类型 |
是否必填 |
参数描述 |
regionId |
bb9fdb42056f11eda1610242ac110002 |
String |
是 |
资源池ID,请参考调用前必知-概述 |
终端节点
终端节点(Endpoint)即调用API的 请求地址 。
Endpoint |
csm-global.ctapi.ctyun.cn |
请求状态码
错误码 |
错误码标识 |
错误描述 |
2000 |
SUCCESS |
成功 |
5000 |
INTERNAL_SERVER_ERROR |
未知的内部错误,稍后重试 |
1000 |
USER_NOT_LOGIN |
用户未登陆 |
1001 |
FORBIDDEN |
禁止访问,没有访问资源的权限 |
1002 |
DATA_EXIST |
数据已存在,请勿重复创建 |
1003 |
DATA_NOT_EXIST |
数据不存在 |
1004 |
OPERATION_TIMEOUT |
操作超时 |
1005 |
OPERATION_TOO_FREQUENT |
操作太频繁 |
1006 |
CACHE_ERROR |
缓存数据库繁忙,稍后重试 |
1007 |
DB_OPERATE_ERROR |
数据库繁忙,稍后重试 |
1008 |
ES_OPERATE_ERROR |
es数据库繁忙,稍后重试 |
1009 |
DATA_ERROR |
数据异常(数据不一致,数据不符合预期,数据值异常等) |
1010 |
SESSION_ERROR |
会话验证失败,请先登录 |
1011 |
SYSTEM_ERROR |
系统繁忙,稍后重试 |
1012 |
UNKNOWN_ERROR |
系统繁忙,稍后重试 |
1013 |
REQUEST_PARAMS_ILLEGAL |
参数不合法 |
1014 |
RPC_EXCEPTION_ERROR |
组件控制台之间RPC返回异常 |
1015 |
RPC_TIME_OUT |
RPC超时 |
1016 |
APP_RPC_TIMEOUT |
APP RPC超时 |
1017 |
UPLOAD_PICTURE_FORMAT_ILLEGAL |
文件上传类型仅支持png,jpg,bmp,cif,gif |
1018 |
MQ_ERROR |
消息队列访问繁忙,稍后重试 |
1019 |
REDISSON_INIT_ERR |
执行器服务初始化错误,需要将RScheduled执行器服务销毁方法设置为空,请更改服务密钥名称或删除密钥 |
1020 |
HTTP_ERROR |
HTTP请求失败 |
1021 |
ASYNC_ERROR |
异步调用异常 |
1022 |
ASYNC_TIMEOUT |
异步超时 |
1023 |
NACOS_INSTANCE_ERROR |
Nacos组件实例异常 |
1024 |
K8s_INSTANCE_ERROR |
K8s组件实例异常 |
1025 |
PAAS_GATEWAY_ERROR |
Paas网关异常 |