查詢該使用者已購買的套餐執行個體及其詳細資訊。
調試
您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
|
操作 |
存取層級 |
資源類型 |
條件關鍵字 |
關聯操作 |
|
esa:ListUserRatePlanInstances |
list |
*All Resource
|
無 | 無 |
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| CheckRemainingSiteQuota |
string |
否 |
是否篩選有剩餘站點配額的套餐執行個體。支援:
|
true |
| Status |
string |
否 |
套餐執行個體狀態。支援:
|
online |
| SortBy |
string |
否 |
排序欄位,預設按照新購時間排序。支援:
|
CreateTime |
| SortOrder |
string |
否 |
排序識別碼,預設為降序。支援:
|
asc |
| PageNumber |
integer |
否 |
分頁查詢時設定的頁碼。預設值為 1。取值範圍為:1~100000。 |
1 |
| PageSize |
integer |
否 |
分頁查詢時每頁的大小,取值範圍 1-500。 |
500 |
| InstanceId |
string |
否 |
套餐執行個體 ID,可透過呼叫 ListSites 介面獲取。 |
sp-xcdn-96wblslz**** |
| RemainingExpireDays |
integer |
否 |
查詢套餐有效期剩餘天數在指定天數以內的套餐執行個體,只能為正整數,單位為天。 |
30 |
| SubscribeType |
string |
否 |
套餐訂閱類型。取值範圍:
|
basicplan |
| PlanType |
string |
否 |
套餐類型。取值範圍:
|
enterprise |
| PlanNameEn |
string |
否 |
套餐名稱(英文)。 |
entranceplan |
返回參數
|
名稱 |
類型 |
描述 |
樣本值 |
|
object |
Schema of Response |
||
| RequestId |
string |
請求 ID。 |
CB1A380B-09F0-41BB-3C82-72F8FD6DA2FE |
| InstanceInfo |
array<object> |
查詢到的該使用者下符合條件的套餐執行個體。 |
|
|
array<object> |
套餐執行個體詳情。 |
||
| InstanceId |
string |
套餐執行個體 ID。 |
sp-xcdn-96wblslz**** |
| PlanName |
string |
套餐執行個體對應的套餐名稱。 |
basic |
| PlanType |
string |
套餐執行個體對應的套餐類型,取值:
|
normal |
| SiteQuota |
string |
套餐執行個體下的站點數量配額。 |
1 |
| ExpireTime |
string |
套餐執行個體的到期時間,日期格式按照 ISO8601 表示法,並使用 UTC 時間,格式為 yyyy-MM-ddTHH:mm:ssZ。 |
2026-04-19T11:15:20Z |
| Duration |
integer |
套餐執行個體的購買時長,單位:月。 |
3 |
| CreateTime |
string |
套餐執行個體的新購時間,日期格式按照 ISO8601 表示法,並使用 UTC 時間,格式為 yyyy-MM-ddTHH:mm:ssZ。 |
2026-04-19T11:15:20Z |
| Sites |
array<object> |
已經綁定到當前套餐執行個體下的站點列表。 |
|
|
object |
綁定的站點的詳情。 |
||
| SiteId |
integer |
站點 ID。 |
123456**** |
| SiteName |
string |
站點名稱。 |
example.com |
| SiteStatus |
string |
站點狀態。取值:
|
pending |
| Status |
string |
套餐執行個體狀態。取值:
|
online |
| Coverages |
string |
該站點可綁定的站點的加速區域範圍,多個用(,)隔開。取值:
|
domestic,overseas |
| BillingMode |
string |
付費類型。支援:
|
PREPAY |
| PlanTraffic |
string |
套餐中已預支付的 7 層加速流量 (GB)。 |
100 |
| Layer4Traffic |
string |
套餐中已預支付的四層代理流量 (GB) - 中國大陸。 |
100 |
| Layer4TrafficIntl |
string |
套餐中已預支付的四層代理流量 (GB) - 非中國大陸。 |
100 |
| CrossborderTraffic |
string |
套餐中已預支付的中國網路加速流量 (GB)。 |
100 |
| EdgeRoutineRquest |
string |
套餐中已預支付的 ER 請求數(萬次)。 |
100 |
| StaticRequest |
string |
套餐中已預支付的 HTTP 請求數(萬次)。 |
100 |
| SmartRoutingRequest |
string |
套餐中已預支付的智慧路由請求數(萬次)。 |
100 |
| EdgeWafRequest |
string |
套餐中已預支付的 WAF 請求數(萬次)。 |
100 |
| DdosInstanceLevel |
string |
為空時,該套餐未購買高防執行個體;
有返回值時,套餐已購買高防執行個體,值為 |
esa_ddos_instance |
| DdosBurstableDomesticProtection |
string |
套餐中高防執行個體的中國大陸規格。 |
cn_300 |
| DdosBurstableOverseasProtection |
string |
套餐中高防執行個體的非中國大陸規格。 |
overseas_300 |
| BotInstanceLevel |
string |
為空時,套餐未購買 BOT 防護執行個體; 返回值時,套餐購買 BOT 防護執行個體,取值:
|
enterprise_bot |
| BotRequest |
string |
套餐中已預支付的 BOT 請求數(萬次)。 |
100 |
| SubscribeType |
string |
套餐訂閱類型。取值:
|
basicplan |
| ResourceOwner |
integer |
||
| ShareType |
string |
||
| OwnerId |
string |
||
| RenewalStatus |
string |
自動續約狀態。取值:
|
nomal |
| RenewalDuration |
integer |
自動續約的週期,單位為月。 |
6 |
| PageNumber |
integer |
當前頁碼,同請求參數的 PageNumber。 |
1 |
| PageSize |
integer |
每頁大小。 |
10 |
| TotalCount |
integer |
總筆數。 |
68 |
| TotalPage |
integer |
總頁數。 |
1 |
樣本
正常返回樣本
JSON格式
{
"RequestId": "CB1A380B-09F0-41BB-3C82-72F8FD6DA2FE",
"InstanceInfo": [
{
"InstanceId": "sp-xcdn-96wblslz****",
"PlanName": "basic",
"PlanType": "normal",
"SiteQuota": "1",
"ExpireTime": "2026-04-19T11:15:20Z",
"Duration": 3,
"CreateTime": "2026-04-19T11:15:20Z",
"Sites": [
{
"SiteId": 0,
"SiteName": "example.com",
"SiteStatus": "pending"
}
],
"Status": "online",
"Coverages": "domestic,overseas",
"BillingMode": "PREPAY",
"PlanTraffic": "100",
"Layer4Traffic": "100",
"Layer4TrafficIntl": "100",
"CrossborderTraffic": "100",
"EdgeRoutineRquest": "100",
"StaticRequest": "100",
"SmartRoutingRequest": "100",
"EdgeWafRequest": "100",
"DdosInstanceLevel": "esa_ddos_instance",
"DdosBurstableDomesticProtection": "cn_300",
"DdosBurstableOverseasProtection": "overseas_300",
"BotInstanceLevel": "enterprise_bot",
"BotRequest": "100",
"SubscribeType": "basicplan",
"ResourceOwner": 0,
"ShareType": "",
"OwnerId": "",
"RenewalStatus": "nomal",
"RenewalDuration": 6
}
],
"PageNumber": 1,
"PageSize": 10,
"TotalCount": 68,
"TotalPage": 1
}
錯誤碼
|
HTTP status code |
錯誤碼 |
錯誤資訊 |
描述 |
|---|---|---|---|
| 400 | InvalidParameter | The specified parameter is invalid. | 輸入參數規範驗證失敗。 |
| 400 | InternalException | Failed to call the service. Try again later or contact technical support. | 呼叫服務失敗,請稍後重試或聯絡客服諮詢詳情。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊,參考變更詳情。