文档中心

DescribeCacheCluster

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

功能描述

查询缓存服务详情,根据缓存服务ID获得缓存资源的详细信息以及该缓存资源的订单信息

请求参数

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

  • CacheId
    缓存服务ID
    类型: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
    usedMemory缓存服务已使用内存大小,单位:GB
    类型:bigDecimal

错误信息

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

样例

  • 请求样例
https://kcs.cn-beijing-6.api.ksyun.com/
?Action=DescribeCacheCluster
&Version=2016-07-01
&CacheId=a45949b8-f870-4f77-877e-56ba546e0ce9
  • 返回样例
HttpStatusCode=200

{
  "RequestId": "xxxxxxxxxx",
  "Data": {
    "cacheId": "a45949b8-f870-4f77-877e-56ba546e0ce9",
    "name": "xb-innerapi-1608111151",
    "securityGroupId": "717",
    "engine": "redis",
    "mode": 2,
    "size": 1,
    "port": 6379,
    "vip": "172.31.253.168",
    "status": 2,
    "createTime": "2016-08-11 11:52:17",
    "netType": 2,
    "vpcId": "95f66aa8-75a7-4e16-ba1e-db4e2d532ac4",
    "vnetId": "21d0c9f5-228f-4330-a169-5f896453c117",
    "usedMemory": 0,
    "subOrderId": "REDIS2S160811115217072734",
    "productId": "a7fe62e0-2aac-4f1a-941d-b8b5600ca12f",
    "billType": 1,
    "orderType": 2,
    "orderUse": 1,
    "serviceBeginTime": "2016-08-11 11:52:17",
    "serviceEndTime": "2016-09-11 23:59:59"
  }
}