接口功能介紹
此接口提供根據實例id退訂實例。
接口約束
1.入參字段必須按Query參數傳入
2.實例只有在運行中或異常狀態的才允許退訂
3.暫不支持Logstash類型實例退訂
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
//ctcsx-global.ctapi.daliqc.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": {
}
}
狀態碼
請參考
錯誤碼
請參考
