云服务器内容精选

  • 响应示例 状态码: 200 OK { "id" : 1000001} 状态码: 400 Bad Request 示例 1 { "error_code" : "GSL.00020004", "error_msg" : "参数异常"} 示例 2 { "error_code" : "GSL.00027001", "error_msg" : "自定义属性名称不合法,请检查!"} 示例 3 { "error_code" : "GSL.00027002", "error_msg" : "自定义属性名称已存在,请重新输入!"} 示例 4 { "error_code" : "GSL.00027003", "error_msg" : "自定义属性名称和SIM卡管理列字段重复,请重新输入!"} 示例 5 { "error_code" : "GSL.00027004", "error_msg" : "登录用户最多可以创建6个自定义属性。"} 状态码: 500 Internal Server Error { "error_code" : "GSL.00020003", "error_msg" : "系统繁忙,请稍后重试。"}
  • 响应参数 状态码: 200 表2 响应Body参数 参数 参数类型 描述 id Long 自定义属性标识 状态码: 400 表3 响应Body参数 参数 参数类型 描述 error_code String 错误码 最大长度:64 error_msg String 错误描述 最大长度:512 状态码: 500 表4 响应Body参数 参数 参数类型 描述 error_code String 错误码 最大长度:64 error_msg String 错误描述 最大长度:512
  • 响应示例 状态码: 200 自定义属性任务查询成功响应 { "status" : "finished", "result" : { "id" : "3b2dce64-c244-11ed-acf5-0255ac100017", "prop_definition" : { "id" : null, "name" : "custom_prop_name", "type" : "binary", "description" : "custom_prop_description" }, "metrics" : [ { "name" : "rmsd", "value" : 0.73 } ] }}
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 status String 异步任务的状态:等待中、运行中、已完成、失败 枚举值: waiting running finished failed task_data CustomPropsTaskData object 自定义属性任务的请求体 result CustomPropsResult object 自定义属性任务的返回结果 表4 CustomPropsTaskData 参数 参数类型 描述 name String 自定义属性名称 最小长度:1 最大长度:32 description String 自定义属性描述信息 最小长度:0 最大长度:256 type String 属性预测类型 枚举值: binary numerical smiles Array of strings 用于建模的smiles列表 values Array of numbers 用于建模的属性值列表 表5 CustomPropsResult 参数 参数类型 描述 id String 自定义属性ID(API侧) 最小长度:1 最大长度:64 prop_definition PropDefinition object 自定义属性元信息 metrics Array of CustomPropsModelMetric objects 自定义属性建模的评估指标集合 表6 PropDefinition 参数 参数类型 描述 id String 属性业务侧ID 最小长度:1 最大长度:128 name String 属性名称 最小长度:1 最大长度:32 type String 属性类型 枚举值: binary numerical description String 属性具体描述信息 最小长度:0 最大长度:256 value_range ValueRange object 属性有效值域区间 optimal_range ValueRange object 属性最优值域区间 warning_range ValueRange object 属性欠佳值域区间 style String 模型参数呈现类型 枚举值: number probability confidential_interval Boolean 模型推理是否呈现置信区间 表7 ValueRange 参数 参数类型 描述 lower Number 值域下限 lower_inclusive Boolean 是否包含值域下限 upper Number 值域上限 upper_inclusive Boolean 是否包含值域上限 表8 CustomPropsModelMetric 参数 参数类型 描述 name String 评估指标的名称 最小长度:1 最大长度:32 value Float 评估指标的评估结果
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 payload CustomAttributePayload object 实际返回信息 meta_info MetaInfo object 元数据 表5 CustomAttributePayload 参数 参数类型 描述 list Array of CustomAttribute objects 自定义属性列表 page_info PageInfo object 分页信息 表6 CustomAttribute 参数 参数类型 描述 id String id key String 属性名称 value String 属性值 project_id String 项目id create_at Long 创建时间,UTC标准时间毫秒时间戳 表7 PageInfo 参数 参数类型 描述 total Long 资源总数 offset Long 查询偏移量 limit Long 返回个数上限 表8 MetaInfo 参数 参数类型 描述 current_time String 请求时间,UTC时间格式,时间为UTC标准时间
  • URI GET /v1.0/{project_id}/common/warehouses/custom-attributes 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目id,获取方法请参见获取项目ID 表2 Query参数 参数 是否必选 参数类型 描述 offset 否 Integer 查询偏移量 最小值:0 缺省值:0 limit 否 Integer 返回个数上限 最小值:1 最大值:50 缺省值:10 key 否 String 根据自定义属性key值模糊查询 最小长度:0 最大长度:256 value 否 String 根据自定义属性value值模糊查询 最小长度:0 最大长度:256 order 否 String 排序类型 缺省值:CREATE_TIME 枚举值: KEY(按自定义属性key值升序排列) CREATE_TIME(按自定义属性创建时间降序排列)
  • 响应示例 状态码: 200 查询成功 获取 数据仓库 自定义属性列表 { "meta_info" : { "current_time" : "2024-01-02T02:04:22Z" }, "payload" : { "list" : [ { "id" : "fda663d2-bf55-4a88-8084-bfab11999ca5", "key" : "KEY", "value" : "VALUE", "project_id" : "PROJECT_ID", "create_at" : 1700464517072 } ], "page_info" : { "total" : 100, "offset" : 0, "limit" : 1 } }}