查询缓存服务列表

最近更新时间:2021-09-07 10:43:24

查看PDF

DescribeCacheClusters

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

请求方式

GET

请求参数

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

英文名称 中文名称 类型 是否必填 备注
Action 接口名称 String 固定值:DescribeCacheClusters
Version 接口版本 String 固定值:2016-07-01
AvailableZone 可用区 String 默认:对应机房的a区
CacheId 缓存服务ID String 缓存服务ID
Name 缓存服务名称 String 缓存服务名称
Vip 缓存服务IP String 缓存服务VIP
VpcId 虚拟网络ID String 只适用于VPC网络下的缓存服务
VnetId 终端子网ID String 只适用于VPC网络下的缓存服务
Offset 数据偏移量 Integer 默认:0
Limit 每页数量 Integer 默认:10,取值范围为[1~100]
OrderBy 排序字段 String 传值为{name,asc,name,desc,created,asc,created,desc},默认按照创建时间降序,只有排序字段时,默认按照升序排列
IamProjectId 项目ID String 默认:查询全部项目,可传入多个的项目ID,‘,’隔开
FuzzySearch 模糊条件查询 String 可根据ID,IP,名称进行过滤
Protocol 版本号 String 默认:查询所有,版本号:4.0、5.0
TagKey 标签的key String 标签名,标签过滤查询(必须同标签值一同传入)
TagValue 标签的value String 标签值,标签过滤查询(必须同标签值一同传入)

响应结果

英文名称 中文名称 类型 备注
英文名称 中文名称 类型 备注
RequestId 请求ID String 请求标识
Data 返回数据信息 Object 参照请见-缓存列表返回信息

缓存列表返回信息

英文名称 中文名称 类型 备注
list 请求ID Array 参照请见-缓存服务列表数据结构
offset 数据偏移量 Integer 数据偏移量
limit 每页数据量 Integer 每页数据量
total 数据总量 Integer 数据总量

错误信息

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

请求样例

https://kcs.api.ksyun.com/?Action=DescribeCacheClusters&Version=2016-07-01

返回样例

{
    "RequestId": "983797af-c8d5-48c7-a8ad-7a2bacb3e8be",
    "Data": {
        "list": [
            {
                "cacheId": "9ad1b20b-ba6a-4cf1-b00a-f5a9fcb8c4b3",
                "region": "cn-beijing-6",
                "az": "cn-beijing-6a",
                "name": "Kingsoft_Redis_Test",
                "engine": "redis",
                "mode": 2,
                "size": 1,
                "port": 6379,
                "vip": "10.0.1.93",
                "status": 2,
                "createTime": "2021-09-03 10:58:20",
                "netType": 2,
                "vpcId": "0bdaf89b-b6e6-4edb-9918-8660667ad5b2",
                "vnetId": "e702e2cd-1b2b-4912-9a81-55e9c4a8b9e1",
                "billType": 1,
                "orderType": 2,
                "source": 3,
                "serviceStatus": 2,
                "serviceBeginTime": "2021-09-03 11:00:00",
                "serviceEndTime": "2021-10-03 23:59:59",
                "iamProjectId": "0",
                "iamProjectName": "默认项目",
                "protocol": "redis 4.0",
                "eip": "",
                "eipRo": "",
                "tags": [],
                "area": "单可用区",
                "directVips": "",
                "directSupported": "false",
                "directConnEnabled": 0
            }
        ],
        "offset": 0,
        "limit": 10,
        "total": 1
    }
}

文档内容是否对您有帮助?

根本没帮助
文档较差
文档一般
文档不错
文档很好

在文档使用中是否遇到以下问题

内容不全,不深入
内容更新不及时
描述不清晰,比较混乱
系统或功能太复杂,缺乏足够的引导
内容冗长

更多建议

0/200

评价建议不能为空

提交成功!

非常感谢您的反馈,我们会继续努力做到更好!

问题反馈