創建 IPv6 帶寬
更新時間 2023-07-19 13:57:29
最近更新時間: 2023-07-19 13:57:29
分享文章
接口功能介紹
創建 IPv6 帶寬。
接口約束
無。
URI
POST /v4/ipv6_bandwidth/create
請求參數
請求體body參數
| 參數 | 參數類型 | 是否必填 | 說明 | 示例 |
|---|---|---|---|---|
| clientToken | String | 是 | 客戶端存根，用于保證訂單冪等性, 長度 1 - 64 | 79fa97e3-c48b-xxxx-9f46-6a13d8163678 |
| regionID | String | 是 | 創建共享帶寬的區域id。 | 81f7728662dd11ec810800155d307d5b |
| bandwidth | Integer | 否 | 共享帶寬的帶寬峰值，如果不傳默認是 1。 | 1 |
| cycleType | String | 是 | 訂購類型：包年/包月訂購，或按需訂購。month / year | year |
| cycleCount | Integer | 是 | 訂閱時長。 | 1 |
| name | String | 是 | 支持拉丁字母、中文、數字，下劃線，連字符，中文 / 英文字母開頭，不能以 http: / https: 開頭，長度 2 - 32 | acl11 |
響應參數
| 參數 | 參數類型 | 說明 | 示例 |
|---|---|---|---|
| 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 | 資源 ID 可以為 null。 | d48cace2da7b4c81b4c0444768a04608 |
| regionID | String | 可用區id。 | 81f7728662dd11ec810800155d307d5b |
| bandwidthID | String | 帶寬 ID | 當 masterResourceStatus 不為 started 時，該取值為 null |
請求示例
POST /v4/ipv6_bandwidth/create
請求體body
{
"regionID": "81f7728662dd11ec810800155d307d5b",
"clientToken": "Xxxxx",
"cycleType": "year",
"bandwidth": 5,
"cycleCount": 1,
"name": "2222"
}
響應示例
{
"statusCode": 800,
"message": "success",
"description": "成功",
"errorCode": "SUCCESS",
"returnObj": {
"masterOrderID": "ee508bcc586211ed961bacde48001122",
"masterOrderNO": null,
"masterResourceID": "d48cace2da7b4c81b4c0444768a04608",
"masterResourceStatus": "started",
"regionID": "81f7728662dd11ec810800155d307d5b",
"bandwidthID": "bandwidth-xxxxx"
}
}
狀態碼
| 狀態碼 | 描述 |
|---|---|
| 200 | 表示請求成功。 |
錯誤碼
請參考 錯誤碼說明。
