查询缓存服务列表

最近更新时间:2019-03-19 11:45:42

DescribeCacheClusters

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

请求参数

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

英文名称 中文名称 类型 是否必须 备注
Action 调用接口名称 String 取固定值:DescribeCacheClusters
Engine 服务引擎 String 取固定值memcached
Version API版本号 String 取固定值: 2018-06-27
CacheId 缓存服务ID String
Name 缓存服务名称 String
Vip 缓存服务IP地址 String
VpcId 虚拟专用网络ID String 只适用于VPC网络下的缓存服务
VnetId 虚拟专用网路EndpointID,或vpclbID String 只适用于VPC网络下的缓存服务
Offset 查询数据的起始位置 Integer 默认为0
Limit 需要从起始位置开始查询的缓存服务的个数 Integer 取值范围为[1~100],默认为10
OrderBy 排序字段 String 可传值为{name,asc,name,desc,created,asc,created,desc},默认按照创建时间降序,只有排序字段时,默认按照升序排列
IamProjectId 项目ID String 默认是0(默认项目),如果查询全部项目,需要传入所有的项目ID,‘,’隔开

请求方式

  GET

返回结果

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

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

错误信息

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

请求样例


https://memcached.cn-shanghai-2.api.ksyun.com/
?Action=DescribeCacheClusters
&Version=2018-06-27
&Engine=memcached
&IamProjectId=0,20,21
&OrderBy=name,desc
&Offset=0
&Limit=2

返回样例

HttpStatusCode=200

{
  "reqId": "xxxxxxxxxx",
  "code": 0,
  "message": "查询缓存服务列表成功",
  "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",
        "iamProjectId":"0",
        "iamProjectName":"默认项目"
      },
      {
        "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",
        "iamProjectId":"0",
        "iamProjectName":"默认项目"
      }
    ],
    "offset": 0,
    "limit": 2,
    "total": 10
  }
}

金山云,开启您的云计算之旅

免费注册