ListCacheReserveInstances - 查询缓存保持实例列表_边缘安全加速(ESA)-阿里云帮助中心

查询当前用户的缓存保持实例列表。

调试

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

授权信息

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

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

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

请求参数

名称	类型	必填	描述	示例值
Status	string	否	缓存保持实例状态。支持： online：正常服务状态。 offline：到期但未超期，处于不可用的状态。 disable：已释放状态。 overdue：欠费停机状态。	online
SortBy	string	否	排序方式。取值： ExpireTime：过期时间。 CreateTime：新购时间。	ExpireTime
SortOrder	string	否	排序方式。支持： asc：升序。 desc：降序。	desc
PageNumber	integer	否	页码。	1
PageSize	integer	否	分页大小。取值：1~500，默认为 500。	20
InstanceId	string	否	实例 ID。	sp-xcdn-96wblslz****

返回参数

名称	类型	描述	示例值
	object	实例查询详情。
RequestId	string	请求 ID。	65C66B7B-671A-8297-9187-2R5477247B76
InstanceInfo	array<object>	缓存保持实例列表。
Item	object	缓存保持实例详情。
InstanceId	string	实例 ID。	sp-xcdn-96wblslz****
ExpireTime	string	实例到期时间。	2024-10-05T16:00:00Z
Duration	integer	实例的购买时长，单位：月。	3
CreateTime	string	实例的新购时间。	2024-04-12T05:41:51Z
Status	string	实例状态。取值： online：正常服务状态。 offline：到期但未超期，处于不可用的状态。 disable：已释放状态。 overdue：欠费停服状态。	online
CacheReserveRegion	string	缓存保持使用区域。	HK
CacheReserveCapacity	string	缓存保持容量。单位：GB。	512000
PageNumber	integer	页码。默认值：1。	1
PageSize	integer	分页大小，默认 500，取值：1~500。	500
TotalCount	integer	总个数。	16
TotalPage	integer	总页数。	1

示例

正常返回示例

JSON格式

{
  "RequestId": "65C66B7B-671A-8297-9187-2R5477247B76",
  "InstanceInfo": [
    {
      "InstanceId": "sp-xcdn-96wblslz****",
      "ExpireTime": "2024-10-05T16:00:00Z",
      "Duration": 3,
      "CreateTime": "2024-04-12T05:41:51Z",
      "Status": "online",
      "CacheReserveRegion": "HK",
      "CacheReserveCapacity": "512000"
    }
  ],
  "PageNumber": 1,
  "PageSize": 500,
  "TotalCount": 16,
  "TotalPage": 1
}

错误码

HTTP status code	错误码	错误信息	描述
400	InvalidParameter	The specified parameter is invalid.	输入参数规范校验失败。

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