云服务器内容精选

  • 响应示例 查询成功 { "success": [ { "id": "7e2d346e-d907-4871-bf51-a17fc7e52ad4", "key": "2", "value": "2", "value_type": "text", "create_revision": 3, "update_revision": 3, "status": "enabled", "create_time": 1636374809, "update_time": 1636374809, "labels": { "2": "2", "environment": "production" } }, { "id": "907b3891-c691-4ae0-816f-e91eba705e28", "key": "1", "value": "1", "value_type": "text", "create_revision": 4, "update_revision": 4, "status": "enabled", "create_time": 1636374809, "update_time": 1636374809, "labels": { "1": "1", "environment": "production" } } ], "failure": [] }
  • 请求示例 导入配置文件,当存在相同配置时,会强制导入覆盖重复项,按body的label导入。 POST https://{endpoint}/v1/{project_id}/kie/file/override=force ----WebKitFormBoundary7MA4YWxkTrZu0gW Content-Disposition: form-data; name="upload_file"; filename="custom_1663124521493.json" Content-Type: application/json ----WebKitFormBoundary7MA4YWxkTrZu0gW
  • URI POST /v1/{project_id}/kie/file 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户子项目的唯一标识,字符长度为1~64位,获取方法请参考获取项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 override 是 String force:强制导入,会覆盖重复项。 skip:跳过导入,会跳过重复项。 abort:终止导入,遇到重复项会停止导入操作。 label 否 String 指定label导入,格式为:{标签key}:{标签value},如果不填则按body的label导入。
  • 请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 x-engine-id 是 String 待上传配置的引擎id,获取方法请参考查询微服务引擎专享版列表。 X-Enterprise-Project-ID 否 String 企业项目id。 如果不配置此参数,则默认企业项目为“default”,ID为0。 表4 请求Body参数 参数 是否必选 参数类型 描述 upload_file 是 File 导入的文件,文件名格式为:fileName.json 文件格式为: { "data": [ { "key": "keyItem1", "value": "valueItem1", "labels":{ "1": "1" }, "status": "enabled", "value_type": "text" } ] }
  • 响应参数 状态码: 200 表7 响应Body参数 参数 参数类型 描述 success Array of GetKieConfigs objects 导入成功的配置项列表。 failure Array of failure objects 导入失败的配置项及其错误列表。 表8 GetKieConfigs 参数 参数类型 描述 id String 配置项的id。 key String 配置项的key。 labels Object 配置项的标签。 value String 配置项的值。 value_type String 配置项value的类型。 status String 配置项的状态。 create_time Integer 创建时间。 update_time Integer 更新时间。 表9 failure 参数 参数类型 描述 key String 导入失败配置的key labels Object 导入失败配置的label error_code String 导入失败的错误码 error_message String 导入失败的原因 状态码: 400 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误信息。 detail String 详细定位信息。 状态码: 500 表11 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误信息。 detail String 详细定位信息。
  • URI POST /v1/{project_id}/kie/file 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户子项目的唯一标识。字符长度为1~64。 表2 Query参数 参数 是否必选 参数类型 描述 override 否 String 覆盖策略,force 强制覆盖、abort 遇到第一个重复时终止导入后续的kv、skip 跳过重复的key 缺省值:force 枚举值: force abort skip label 否 String 指定label导入,格式为:{标签key}:{标签value},如果不填则按body的label导入
  • 请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 X-Enterprise-Project-ID 否 String 如果不带则默认企业项目为"default",ID为"0" 缺省值:0 Content-Type 是 String 该字段内容填为 "application/json;charset=UTF-8" Accept 是 String 该字段内容填为 "application/json" 表4 请求Body参数 参数 是否必选 参数类型 描述 metadata 否 metadata object 导出文件的描述信息 data 否 Array of CreateKieReq objects 导出的配置项列表。 表5 metadata 参数 是否必选 参数类型 描述 version 否 String 导出数据的版本号 annotations 否 Object 导出文件的其他信息 表6 CreateKieReq 参数 是否必选 参数类型 描述 key 否 String 配置项的key。 缺省值:$random(6)-$date(yyyy-MM-dd-HH-mm-ss) labels 否 Object 配置项的标签 value 否 String 配置项的值。 缺省值:$random(20) value_type 否 String 配置项value的类型。 缺省值:text status 否 String 配置项的状态。 缺省值:enabled
  • 响应示例 查询成功 { "success": [ { "id": "7e2d346e-d907-4871-bf51-a17fc7e52ad4", "key": "2", "value": "2", "value_type": "text", "create_revision": 3, "update_revision": 3, "status": "enabled", "create_time": 1636374809, "update_time": 1636374809, "labels": { "2": "2", "environment": "production" } }, { "id": "907b3891-c691-4ae0-816f-e91eba705e28", "key": "1", "value": "1", "value_type": "text", "create_revision": 4, "update_revision": 4, "status": "enabled", "create_time": 1636374809, "update_time": 1636374809, "labels": { "1": "1", "environment": "production" } } ], "failure": [] }
  • 请求示例 导入配置文件,当存在相同配置时,会强制导入覆盖重复项,按body的label导入。 POST https://{endpoint}/v1/{project_id}/kie/file/override=force----WebKitFormBoundary7MA4YWxkTrZu0gWContent-Disposition: form-data; name="upload_file"; filename="custom_1663124521493.json"Content-Type: application/json----WebKitFormBoundary7MA4YWxkTrZu0gW
  • 响应示例 查询成功 { "success": [ { "id": "7e2d346e-d907-4871-bf51-a17fc7e52ad4", "key": "2", "value": "2", "value_type": "text", "create_revision": 3, "update_revision": 3, "status": "enabled", "create_time": 1636374809, "update_time": 1636374809, "labels": { "2": "2", "environment": "production" } }, { "id": "907b3891-c691-4ae0-816f-e91eba705e28", "key": "1", "value": "1", "value_type": "text", "create_revision": 4, "update_revision": 4, "status": "enabled", "create_time": 1636374809, "update_time": 1636374809, "labels": { "1": "1", "environment": "production" } } ], "failure": []}
  • URI POST /v1/{project_id}/kie/file 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户子项目的唯一标识,字符长度为1~64位,获取方法请参考获取项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 override 是 String force:强制导入,会覆盖重复项。 skip:跳过导入,会跳过重复项。 abort:终止导入,遇到重复项会停止导入操作。 label 否 String 指定label导入,格式为:{标签key}:{标签value},如果不填则按body的label导入。
  • 请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 x-engine-id 是 String 待上传配置的引擎id,获取方法请参考查询微服务引擎专享版列表。 X-Enterprise-Project-ID 否 String 企业项目id。 如果不配置此参数,则默认企业项目为“default”,ID为0。 Authorization 否 String 若微服务引擎专享版开启了安全认证,此参数必填。否则,无此参数。 开启了安全认证的微服务引擎专享版Token,格式为: Authorization:Bearer {Token} Token获取方法,请参考获取微服务引擎专享版用户Token。 表4 请求Body参数 参数 是否必选 参数类型 描述 upload_file 是 File 导入的文件,文件名格式为:fileName.json 文件格式为: { "data": [ { "key": "keyItem1", "value": "valueItem1", "labels":{ "1": "1" }, "status": "enabled", "value_type": "text" } ]}