退订
更新时间 2025-11-18 17:46:16
最近更新时间: 2025-11-18 17:46:16
接口功能介绍
退订
接口约束
无
URI
POST /v3/instance/unsubscribeInst
路径参数 无
Query参数 无
请求参数
请求头header参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionId | 是 | String | 资源池编码 | 100054c0416811e9a6690242ac110002 |
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| prodInstId | 是 | String | 实例ID |
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | String | 接口系统层面状态码。成功：800，失败：900 | ||
| message | String | 描述状态 | ||
| returnObj | Object | 返回对象。此参数所包含的参数请见“响应示例'里面的注释 | returnObj | |
| error | String | 错误码，只有非成功才有这个字段，方便快速定位问题 | 201 | |
| 表 returnObj |
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| data | Object | 响应数据对象 | data | |
| 表 data |
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| errorMessage | String | 错误信息描述 | ||
| batchOrderPlacementResults | Array of Objects | 批量下单结果列表 | batchOrderPlacementResult | |
| 表 batchOrderPlacementResult |
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| errorMessage | String | 错误信息描述 | ||
| submitted | Boolean | 是否提交成功 | ||
| orderPlacedEvents | Array of Objects | 下单事件列表 | orderPlacedEvent | |
| 表 orderPlacedEvent |
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| errorMessage | String | 错误信息描述 | ||
| submitted | String | 是否提交成功 | ||
| newOrderId | String | 订单id | ||
| newOrderNo | String | 订单编号 | ||
| totalPrice | Double | 订单价格 |
枚举参数
无
请求示例
请求url
https://[endpoint].ctapi.ctyun.cn/v3/instance/unsubscribeInst
请求头header
无
请求体body
{ "prodInstId": "string"}
响应示例
响应成功示例
{
"statusCode": 800,
"returnObj": {
"errorMessage": "",
"batchOrderPlacementResults": [
{
"errorMessage": "",
"submitted": true,
"orderPlacedEvents": [
{
"errorMessage": "",
"submitted": true,
"newOrderId": "96ec06154feb4da89bf4262f88ada76e",
"newOrderNo": "20180404165441398225",
"totalPrice": 100
}
]
},
{
"errorMessage": "",
"submitted": true,
"orderPlacedEvents": [
{
"errorMessage": "",
"submitted": true,
"newOrderId": "38159a060c2f4618a762f0982596dac8",
"newOrderNo": "20180404165441476438",
"totalPrice": 100
}
]
},
{
"errorMessage": "",
"submitted": true,
"orderPlacedEvents": [
{
"errorMessage": "",
"submitted": true,
"newOrderId": "cfa120962c5447b3b4b66f9136087295",
"newOrderNo": "20180404165441568372",
"totalPrice": 100
}
]
}
]
},
"message": "success"
}
响应失败示例
{
"returnObj": {},
"message": "...",
"error":"201",
"statusCode": "900"
}
状态码
请参考 状态码
错误码
请参考 错误码
