更新实例名称
更新时间 2025-11-26 15:24:29
最近更新时间: 2025-11-26 15:24:29
接口功能介绍
更新实例名称
接口约束
无
URI
POST /v3/instance/updateName
路径参数 无
Query参数 无
请求参数
请求头header参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionId | 是 | String | 资源池编码 | 100054c0416811e9a6690242ac110002 |
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| prodInstId | 是 | String | 实例ID | ||
| instanceName | 是 | String | 新的实例名称 |
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | String | 接口系统层面状态码。成功:800,失败:900 | ||
| message | String | 描述状态 | ||
| returnObj | Object | 返回对象。此参数所包含的参数请见“响应示例'里面的注释 | ||
| error | String | 错误码,只有非成功才有这个字段,方便快速定位问题 | 201 |
枚举参数
无
请求示例
请求url
https://[endpoint].ctapi.ctyun.cn/v3/instance/updateName
请求头header
无
请求体body
{
"prodInstId":"mq_test",
"instanceName":"70687660456281088"
}
响应示例
响应成功示例
{
"returnObj":{
},
"message":"success",
"statusCode":800
}
响应失败示例
{
"returnObj": {},
"message": "...",
"error":"201",
"statusCode": "900"
}
状态码
请参考 状态码
错误码
请参考 错误码