接口功能介绍
修改当前实例的描述信息。
接口定义
接口名称 | 获取实例详情 |
---|---|
承载协议 | HTTPS |
承载网络 | 外网 |
请求方式 | Post |
数据格式 | |
约束 | 实例处于运行状态 |
测试环境接口URL | https://influxdb-global.ctapi-test.ctyun.cn/v1/console/openapi/instance/desc-update |
生产环境接口URL | https://influxdb-global.ctapi.ctyun.cn/v1/console/openapi/instance/desc-update |
请求参数
header参数
参数名 | 是否必填 | 位置 | 参数类型 | 说明 |
---|---|---|---|---|
regionId | 是 | header | String | 当前实例所属资源池 |
请求体body参数
参数名 | 是否必填 | 位置 | 参数类型 | 说明 |
---|---|---|---|---|
spuInstId | 是 | body | String | 实例id |
desc | 是 | body | String | 描述信息 |
响应结果
响应Body参数
名称 | 类型 | 说明 | 下级对象 |
---|---|---|---|
code | Integer | 返回状态码 | |
message | String | 描述 | |
data | String | 描述信息 |
请求示例
请求头header
"regionId","39h54mest675e11ea91fc9432qw12867"
请求体Boby
{
"spuInstId":"15377b3d15414dbd8efe394e5e981h97",
"desc":"描述信息"
}
响应示例
{
"data":"描述信息保存成功",
"code":0,
"message":"success"
}
状态码
状态码 | 描述 |
---|---|
0 | 请求成功 |