ListUserRatePlanInstances - 查询用户套餐实例列表_边缘安全加速(ESA)-阿里云帮助中心

查询该用户已购买的套餐实例及其详细信息。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
esa:ListUserRatePlanInstances	list	全部资源 ``	无	无

请求参数

名称	类型	必填	描述	示例值
CheckRemainingSiteQuota	string	否	是否筛选有剩余站点配额的套餐实例。支持： true：筛选有剩余站点配额的套餐实例。 false：查询用户下所有的套餐实例。	true
Status	string	否	套餐实例状态。支持： online：正常服务状态。 offline：到期但未超期，处于不可用的状态。 disable：已释放状态。 overdue：欠费状态。	online
SortBy	string	否	排序字段，默认按照新购时间排序。支持： CreateTime：新购时间。 ExpireTime：到期时间。	CreateTime
SortOrder	string	否	排序标识，默认为降序。支持： asc：升序。 desc：降序。	asc
PageNumber	integer	否	页码。默认值为 1。取值范围为：1~100000。	1
PageSize	integer	否	页面大小。	500
InstanceId	string	否	套餐实例 ID，可通过调用 ListSites 接口获取。	sp-xcdn-96wblslz****

返回参数

名称	类型	描述	示例值
	object	Schema of Response
RequestId	string	请求 ID。	CB1A380B-09F0-41BB-3C82-72F8FD6DA2FE
InstanceInfo	array<object>	查询到的该用户下符合条件的套餐实例。
Item	object	套餐实例详情。
InstanceId	string	套餐实例 ID。	sp-xcdn-96wblslz****
PlanName	string	套餐实例对应的套餐名称。	basic
PlanType	string	套餐实例对应的套餐类型，取值： normal：固定版套餐。 enterprise：企业版套餐。	normal
SiteQuota	string	套餐实例下的站点数量配额。	1
ExpireTime	string	套餐实例的到期时间。	YYYY-MM-DDThh:mm:ssZ
Duration	integer	套餐实例的购买时长，单位：月。	3
CreateTime	string	套餐实例的新购时间。	YYYY-MM-DDThh:mm:ssZ
Sites	array<object>	已经绑定到当前套餐实例下的站点列表。
Item	object	绑定的站点的详情。
SiteId	long	站点 ID。	123456****
SiteName	string	站点名称。	example.com
SiteStatus	string	站点状态。取值： pending：站点待配置。 active：站点已激活。 offline：站点已下线。 moved：站点已被顶替。	pending
Status	string	套餐实例状态。取值： online：正常服务状态。 offline：到期但未超期，处于不可用的状态。 disable：已释放状态。	online
Coverages	string	该站点可绑定的站点的加速区域范围，多个用（,）隔开。取值： domestic：国内。 overseas：全球（不包含国内）。 global：全球（包含国内）。	domestic,overseas
BillingMode	string	付费类型。支持： PREPAY：预付费。 POSTPAY：后付费。	PREPAY
PageNumber	integer	页码。	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": "YYYY-MM-DDThh:mm:ssZ ",
      "Duration": 3,
      "CreateTime": "YYYY-MM-DDThh:mm:ssZ ",
      "Sites": [
        {
          "SiteId": 0,
          "SiteName": "example.com",
          "SiteStatus": "pending"
        }
      ],
      "Status": "online",
      "Coverages": "domestic,overseas",
      "BillingMode": "PREPAY",
      "PlanTraffic": "",
      "Layer4Traffic": "",
      "Layer4TrafficIntl": "",
      "CrossborderTraffic": "",
      "EdgeRoutineRquest": "",
      "StaticRequest": "",
      "SmartRoutingRequest": "",
      "EdgeWafRequest": "",
      "DdosInstanceLevel": "",
      "DdosBurstableDomesticProtection": "",
      "DdosBurstableOverseasProtection": "",
      "BotInstanceLevel": ""
    }
  ],
  "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.	调用服务失败，请稍后重试或联系客服咨询详情。

访问错误中心查看更多错误码。

变更历史

变更时间	变更内容概要	操作
2024-11-28	OpenAPI 错误码发生变更、OpenAPI 入参发生变更	查看变更详情
2024-11-12	OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更	查看变更详情