查询该用户已购买的套餐实例及其详细信息。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
esa:ListUserRatePlanInstances |
list |
*全部资源
|
无 | 无 |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| 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 |
| 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",
"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. | 调用服务失败,请稍后重试或联系客服咨询详情。 |
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。