接口功能介绍
此接口提供根据实例id退订实例。
接口约束
1.入参字段必须按Query参数传入
2.实例只有在运行中或异常状态的才允许退订
URI
GET /os/openapi/v1/order/refund
路径参数
无
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| clusterId | 是 | String | 实例id | OpenSearch-UTLGQLHQPJNJSDCRPPJBP |
请求参数
请求头header参数
无
请求体body参数
无
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 状态码，成功：200，失败：500 | 200 | |
| error | String | 错误码，请求成功时，不返回该字段 | OS_400000 | |
| message | String | 用来简述当前接口调用状态以及必要提示信息 | 请求成功 | |
| returnObj | Array of Objects | 返回结果 | 表 returnObj |
表 returnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| errorMessage | String | 错误信息 | ||
| submitted | Boolean | 提交订单 | ||
| newOrderId | String | 订单id | ||
| newOrderNo | String | 订单编号 | ||
| totalPrice | Double | 价格 |
枚举参数
无
请求示例
请求url
https://ctcsx-global.ctapi.ctyun.cn/os/openapi/v1/order/refund
请求头header
无
请求体body
无
响应示例
请求成功示例：
{
"statusCode": 200,
"message": "success",
"returnObj": [
{
"errorMessage": "",
"submitted": true,
"newOrderId": "1825ded866c7485fb3bb4918e4e3b805",
"newOrderNo": "20241202110327910353",
"totalPrice": 0.00
}
]
}
请求失败示例：
{
"statusCode": 500,
"error": "OS_400000",
"message": "请求失败"
}
ak 传错示例：
{
"statusCode": "CTAPI_10002",
"returnObj": {
},
"code": "10002",
"message": "ctyun-EOP: Invalid APP ID in request",
"error": "10002",
"requestId": "b0747f9e5ef24a7e95ad9324dbe6d885",
"eopErrCode": "10002"
}
sk传错示例:
{
"statusCode": "CTAPI_10009",
"returnObj": {
},
"code": "10009",
"message": "ctyun-EOP: signature verification failed",
"error": "10009",
"requestId": "ee133410bed24812b8f70cc27299401b",
"eopErrCode": "10009"
}
请求参数值无效示例：
{
"statusCode": 500,
"error": "OS_401002",
"message": "请求参数值无效",
"returnObj": "{"clusterId":"不能为空"}"
}
用户无权限:
{
"statusCode": 500,
"error": "OS_401004",
"message": "非法操作",
"returnObj": {
}
}
状态码
请参考 状态码
错误码
请参考 错误码
