退訂共享流量包
更新時間 2023-07-19 13:57:30
最近更新時間: 2023-07-19 13:57:30
分享文章
接口功能介紹
退訂共享流量包。
接口約束
無。
URI
POST /v4/flow_package/refund
請求參數
請求Body參數
| 參數 | 參數類型 | 是否必填 | 說明 | 示例 |
|---|---|---|---|---|
| regionID | String | 是 | 資源池 ID | |
| resourceID | String | 是 | 資源包 ID | 89ae74cb436c40b4ad420ba9fd22f89e |
| clientToken | String | 是 | 客戶端存根,用于保證訂單冪等性, 長度 1 - 64 | 79fa97e3-c48b-xxxx-9f46-6a13d8163678 |
響應參數
| 參數 | 參數類型 | 說明 | 示例 |
|---|---|---|---|
| statusCode | Integer | 返回狀態碼(800為成功,900為失敗) | 800 |
| message | String | statusCode為900時的錯誤信息; statusCode為800時為success, 英文 | success |
| description | String | statusCode為900時的錯誤信息; statusCode為800時為成功, 中文 | 成功 |
| errorCode | String | statusCode為900時為業務細分錯誤碼,三段式:product.module.code; statusCode為800時為SUCCESS | SUCCESS |
| returnObj | Object | - | 接口業務數據 |
表 returnObj
| 參數 | 參數類型 | 說明 | 示例 |
|---|---|---|---|
| masterOrderID | String | 訂單id。 | 55d531d7bf2d47658897c42ffb918423 |
| masterOrderNO | String | 訂單編號, 可以為 null。 | 20221021191602644224 |
| masterResourceStatus | String | 資源狀態: started(啟用) / renewed(續訂) / refunded(退訂) / destroyed(銷毀) / failed(失敗) / starting(正在啟用) / changed(變配)/ expired(過期)/ unknown(未知) | started |
| masterResourceID | String | 可以為 null。 | d48cace2da7b4c81b4c0444768a04608 |
| regionID | String | 可用區id。 | 81f7728662dd11ec810800155d307d5b |
請求示例
POST /v4/flow_package/refund
請求體body
{
"regionID": "100054c0416811e9a6690242ac110002",
"resourceID": "89ae74cb436c40b4ad420ba9fd22f89e",
"clientToken": "xxxxxx"
}
響應示例
{
"statusCode": 800,
"message": "success",
"description": "成功",
"errorCode": "SUCCESS",
"returnObj": {
"masterOrderID": "08b383fc640711ed8a63acde48001122",
"masterOrderNO": null,
"masterResourceID": "dc3d7abe3f5e47ecaa51052316337fac",
"masterResourceStatus": "started",
"regionID": "81f7728662dd11ec810800155d307d5b"
}
}
狀態碼
| 狀態碼 | 描述 |
|---|---|
| 200 | 表示請求成功。 |
錯誤碼
請參考 錯誤碼說明。