套餐管理：訂購
更新時間 2025-10-24 11:00:29
最近更新時間(jian): 2025-10-24 11:00:29
分享文章(zhang)
接口功能介紹
調(diao)用此接口可訂購套餐包。
接口約束
參見請求參數說明。
URI
POST /v4/monitor/order/place
路徑參數 無
Query參數 無
請求參數
請求頭header參數 無
請求體body參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| autoPay | 否 | Boolean | 本參數表示是否自動支付，默認值false，取值范圍： true：自動支付。 false：不是自動支付。 根據以上范圍取值。 | true | |
| payVoucherPrice | 否 | String | 支付代金券金額，默認值0，格式為：兩位小數，不能為負數，支付代金券金額只適用于預付費客戶自動支付，若代金券支付金額傳0或者空字符串，不使用代金券支付 | 50.00 | |
| isOnDemand | 是 | Boolean | 是否按需 | true | |
| autoRenewStatus | 否 | Integer | 此參數表示是否開啟自動續訂，默認值0，取值范圍： 0：關閉自動續訂。 1：開啟自動續訂。 根據以上范圍取值。 | 1 | |
| orders | 是 | Array of Objects | 訂單信息 | order | |
| 表 order |
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| instanceCnt | 是 | Integer | 實例數量，取值范圍：1-50。 根據以上范圍取值。 | 10 | |
| cycleCnt | 是 | Integer | 訂購時長，取值范圍： 1：資源類型resourceType為SMSP時。 6：資源類型resourceType為VOIP時。 根據以上范圍取值。 | 1 | |
| cycleType | 是 | Integer | 此參數表示訂購周期，取值范圍： 6：兩年（資源類型resourceType為SMSP時）。 3：月（資源類型resourceType為VOIP時）。 根據以上范圍取值。 | 6 | |
| items | 是 | Array of Objects | 訂單項信息 | item | |
| 表 item |
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| master | 是 | Boolean | 是否為主資源 | true | |
| resourceType | 是 | String | 此參數表示資源類型，取值范圍： SMSP：短信通知套餐包。 VOIP：語音通知套餐包。 根據以上范圍取值。 | SMSP | |
| serviceTag | 是 | String | 此參數表示服務平臺， 取值范圍： CM：云監控。 根據以上范圍取值。 | CM | |
| itemValue | 是 | Integer | 此參數表示訂單項值。 資源類型resourceType為SMSP時的取值范圍， 1000， 2000， 5000， 10000， 20000， 50000， 100000。 資源類型resourceType為VOIP時的取值范圍： 500， 1000， 2000， 5000， 10000。 根據以上范圍取值。 | 10000 | |
| itemConfig | 是 | Object | 訂單項配置信息 | itemConfig | |
| 表 itemConfig |
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| bundleSize | 是 | Integer | 此參數表示規格數，與itemValue值需一致，取值范圍： 500：500條。 1000：1000條。 2000：2000條。 5000：5000條。 10000：10000條。 20000：20000條。 50000：50000條。 100000：100000條。 根據以上范圍取值。 | 10000 | |
| validityPeriod | 是 | Integer | 此參數表示有效期， 取值范圍： 2：2年（資源類型resourceType為SMSP時）。 6：6個月（資源類型resourceType為VOIP時）。 根據以上范圍取值。 | 2 | |
| version | 是 | String | 版本號，固定值：v1。 | v1 | |
| type | 是 | String | 屬性值，固定值：standard。 | standard |
響應參數
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| statusCode | Integer | 返回狀態碼（800為成功，900為失敗），默認值：800 | 800 | |
| errorCode | String | 失敗時的錯誤代碼，參見公共錯誤碼說明 | ||
| message | String | 失敗時的錯誤描述，一般為英文描述 | Success | |
| msgDesc | String | 失敗時的錯誤描述，適配中英文 | 成功 | |
| description | String | 失敗時的錯誤描述，適配中英文 | 成功 | |
| error | String | 錯誤碼，請求成功時，不返回該字段 | Openapi.Parameter.Error | |
| returnObj | Object | 返回參數，參考returnObj對象結構 | returnObj | |
| 表 returnObj |
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| newOrderID | String | 訂單ID | 1b86e7cebc0b446f97db2b75598d5187 | |
| newOrderNo | String | 訂單號 | 20241108151204881770 | |
| totalPrice | Integer | 總價 | 30000 | |
| orderDetailUrl | String | 付款鏈接 | //wwwtest.daliqc.cn:21443/order/order_detail/481bbe3148ac4de98255d458507d4404&lang=zh-cn | |
| submitted | Boolean | 是否提交 | true | |
| errorMessage | String | 錯誤消息 |
枚舉參數
無
請求示例
請求url
/v4/monitor/order/place
請求頭header
無
請求體body
{
"autoPay": true,
"payVoucherPrice": "",
"isOnDemand": false,
"autoRenewStatus": 0,
"orders": [
{
"instanceCnt": 50,
"cycleCnt": 1,
"cycleType": 6,
"items": [
{
"master": true,
"resourceType": "SMSP",
"serviceTag": "CM",
"itemValue": 10000,
"itemConfig": {
"bundleSize": 10000,
"validityPeriod": 2,
"version": "v1",
"type": "standard"
}
}
]
}
]
}
響應示例
{
"statusCode": 800,
"returnObj": {
"newOrderNo": "20241112153401938817",
"totalPrice": 25000,
"errorMessage": "",
"submitted": true,
"orderDetailUrl": "//wwwtest.daliqc.cn:21443/console/expense/order/detail?orderId=eec12ea273dc4947bb60e1ab085d0502&lang=zh-cn",
"newOrderID": "eec12ea273dc4947bb60e1ab085d0502"
},
"errorCode": "",
"message": "Success",
"msgDesc": "成功",
"description": "成功"
}
狀態碼
請參考
錯誤碼
請參考
