文档中心

DescribeCacheClusters

功能描述
请求参数
请求方式
返回结果
错误信息
样例

功能描述

查询缓存服务列表,允许您根据特定的条件查询缓存资源,并支持对缓存资源的排序,默认每次查出10个缓存服务

请求参数

关于所有操作需要的通用参数,请参照通用请求-公共参数

  • CacheId
    缓存服务ID
    类型:string
    是否必须:否
  • Name
    缓存服务名称
    类型:string
    是否必须:否
  • Vip
    缓存服务IP地址
    类型:string
    是否必须:否
  • VpcId
    虚拟专用网络ID,只适用于VPC网络下的缓存服务
    类型:string
    是否必须:否
  • VnetId
    虚拟专用网路EndpointID,或vpclbID,只适用于VPC网络下的缓存服务
      类型:string
    是否必须:否
  • Offset
    查询数据的起始位置,默认为0
    类型:integer
    是否必须:否
  • Limit
    需要从起始位置开始查询的缓存服务的个数,取值范围为[1~100],默认为10
    类型:integer
    是否必须:否
  • OrderBy
    排序字段
    限制:可传值为{name,asc,name,desc,created,asc,created,desc},默认按照创建时间降序,只有排序字段时,默认按照升序排列
    类型:string
    是否必须:否

请求方式

GET

返回结果

请求的返回信息请参照样例,包含以下字段。

  • cacheId
    缓存服务ID
    类型:string
  • name
    缓存服务名称
    类型:string
  • engine
    缓存服务引擎
    类型:string
  • mode
    缓存服务方式,1表示集群方式,2表示单主从方式
    类型:byte
     *size__
    缓存服务内存大小,单位:GB
    类型:integer
  • port
    缓存服务端口号 类型:integer
  • vip
    缓存服务IP地址
    类型:string
  • status
    缓存服务当前状态,对照关系请见缓存服务状态通用信息
    类型:byte
  • createTime
    缓存服务创建时间
    类型:date
  • netType 缓存服务网络类型,1表示基础网络,2表示VPC网络
    类型:byte
  • vpcId 虚拟专用网络ID,只适用于VPC网络下的缓存服务
    类型:string
  • vnetId
    虚拟专用网路EndpointID,或vpclbID,只适用于VPC网络下的缓存服务
    类型:string
  • billType
    订单类型: 1-包年包月
    类型:integer
  • serviceBeginTime
    服务开始时间
    类型:date
  • serviceEndTime
    服务结束时间
    类型:date
  • offset
    查询数据的起始位置
    类型:integer
  • limit 需要从起始位置开始查询的缓存服务的个数
    类型:integer
  • total
    总记录数
    类型:integer

错误信息

关于所有操作返回的错误信息,请参照通用请求-通用错误信息

样例

  • 请求样例
https://kcs.cn-beijing-6.api.ksyun.com/

?Action=DescribeCacheClusters

&Version=2016-07-01

&OrderBy=name,desc

&Offset=0

&Limit=2
  • 返回样例
HttpStatusCode=200

{
  "RequestId": "xxxxxxxxxx",
  "Data": {
    "list": [
      {
        "cacheId": "b4a45b78-7baa-41a0-937e-63b94c3d7390",
        "name": "hdh-test-2",
        "securityGroupId": "687",
        "engine": "redis",
        "mode": 2,
        "size": 1,
        "port": 6379,
        "vip": "172.31.253.133",
        "status": 2,
        "createTime": "2016-08-08 20:14:49",
        "netType": 2,
        "vpcId": "95f66aa8-75a7-4e16-ba1e-db4e2d532ac4",
        "vnetId": "21d0c9f5-228f-4330-a169-5f896453c117",
        "billType": 1,
        "serviceBeginTime": "2016-09-21 17:24:42",
        "serviceEndTime": "2016-10-21 23:59:59"
      },
      {
        "cacheId": "4bd89c73-b51d-47ed-a4e3-88d88ff14434",
        "name": "gbz-test-2",
        "securityGroupId": "683",
        "engine": "redis",
        "mode": 2,
        "size": 1,
        "port": 6379,
        "vip": "172.31.253.131",
        "status": 2,
        "createTime": "2016-08-03 15:14:20",
        "netType": 2,
        "vpcId": "95f66aa8-75a7-4e16-ba1e-db4e2d532ac4",
        "vnetId": "21d0c9f5-228f-4330-a169-5f896453c117"
        "billType": 1,
        "serviceBeginTime": "2016-09-21 17:24:42",
        "serviceEndTime": "2016-10-21 23:59:59"
      }
    ],
    "offset": 0,
    "limit": 2,
    "total": 10
  }
}