API文档
缓存
缓存

概述

美团云弹性缓存服务（ECS，Elastic Cache Service），包括 Memcached 和 Redis

获取 ECS 列表

DescribeECS 接口用于获取 ECS 列表。

请求 URL

https://mosapi.meituan.com/mcs/v1?
    Action=DescribeECS&
    请求参数&
    AUTHDATA

请求参数

参数名
类型
说明
可选值
示例
备注
Limit integer 本次请求返回的数量 可选    
Offset integer 本次请求返回的偏移量 可选    
ECSIds.n string 指定ECS信息查询返回 可选 ECSIds.0=‘faf797b1-8343-4af5-a02b-14b1ab8ea02a’  

返回参数

参数名
类型
说明
示例
备注
 
Status
 string 状态     
Name
 string 名称     
Created_at
 string 创建时间     
Zone
 string 所在区域     
Driver
 string 类型     
Flavor
 string 套餐类型（配置）     
MasterCount
 integer 主节点个数     
ID
 string 资源ID     
Zone_cn
 string 所在区域zone中文名    

返回示例（JSON）

{
  "DescribeECSResponse": {
    "ECSSet": {
      "ECS": [
        {
          "Status": "running",
          "Name": "test",
          "Zone": "yongfeng",
          "Created_at": "2016-10-14T05:33:13Z",
          "Driver": "Redis",
          "Zone_cn": "北京3区",
          "Flavor": "Redis::C1_M1",
          "MasterCount": 1,
          "ID": "faf797b1-8343-4af5-a02b-14b1ab8ea02a"
        },
      ]
    }
  }
}

创建 ECS

CreateECS 接口用于创建ECS资源。

请求 URL

https://mosapi.meituan.com/mcs/v1?
    Action=CreateECS&
    请求参数&
    AUTHDATA

请求参数

参数名
类型
说明
可选值
示例
备注
Name string 名称 必选    
ECSType string 配置类型 必选，可选值有：Memcached，Redis    
Driver string 类型 必选 
如 Memcached::C1_M1
  
MasterCount integer 主节点个数 可选    
AvailabilityZoneId string 分区选择

必选，可以通过DescribeAvailabilityZones查询当前可用zone

    
Description string 描述 & 备注 可选    

返回参数

参数名
类型
说明
示例
备注
 
Status
 string 状态     
Name
 string 名称     
Created_at
 string 创建时间     
Zone
 string 所在区域     
Driver
 string 类型     
Flavor
 string 套餐类型（配置）   预期改名和输入一样 ECSType 
MasterCount
 integer 主节点个数     
ID
 string 资源ID    

返回示例（JSON）

{
  "CreateECSResponse": {
    "ECS": {
      "Status": "start_create",
      "Name": "test",
      "Zone": "yongfeng",
      "Created_at": "2016-10-24T07:17:24Z",
      "Driver": "Memcached",
      "Zone_cn": "北京3区",
      "Flavor": "Memcached::C1_M1",
      "MasterCount": "2",
      "ID": "8dfacb5d-630f-4ad3-84c7-2a51fe4c2dfa"
    }
  }
}

变更 ECS 套餐

ChangeECSType 接口用于变更ECS套餐类型。

请求 URL

https://mosapi.meituan.com/mcs/v1?
    Action=ChangeECSType&
    请求参数&
    AUTHDATA

请求参数

参数名
类型
说明
可选值
示例
备注
ECSId string ECS资源ID 必选    
ECSType string ECS需要调整的配置类型 必选    

返回参数

参数名
类型
说明
示例
备注
 
return

bool

      

返回示例（JSON）

{
  "ChangeECSTypeResponse": {
    "return": true
  }
}

删除 ECS

DeleteECS 接口用于删除ECS。

请求 URL

https://mosapi.meituan.com/mcs/v1?
    Action=DeleteECS&
    请求参数&
    AUTHDATA

请求参数

参数名
类型
说明
可选值
示例
备注
ECSId string ECS资源ID 必选    

返回参数

参数名
类型
说明
示例
备注
 
return
 bool      

返回示例（JSON）

{
  "DeleteECSResponse": {
    "return": true
  }
}

获取 ECS 节点列表

DescribeECSNode 接口用于获取 ECS 的节点列表。

请求 URL

https://mosapi.meituan.com/mcs/v1?
    Action=DescribeECSNode&
    请求参数&
    AUTHDATA

请求参数

参数名
类型
说明
可选值
示例
备注
ECSId string ECS的资源ID      
ECSNodeIds.n string 单节点的ID，n从1开始      

返回参数

参数名
类型
说明
示例
备注
 
Index
 integer node的序号     
CDS_ID
 string ECS集群的ID     
Name
 string 节点名称     
Zone
 string 所在区域     
Created_at
 string 创建时间     
Driver
 string 类型     
PORT
 integer 服务端口     
IPS
 string Node节点ip地址     
Role
 string 节点角色（集群角色）     
ID
 string Node的资源ID    

返回示例（JSON）

{
  "DescribeECSNodeResponse": {
    "RDSNodeSet": {
      "RDSNode": [
        {
          "Index": 0,
          "CDS_ID": "e8c67a81-da94-434a-90ea-419afc81df11",
          "Name": "memcached-lizexi-m4-test-not-delete-0",
          "Zone": "runze",
          "Created_at": "2016-08-24T08:59:39Z",
          "Driver": "Memcached",
          "ID": "0ce0ed45-ce9a-43ac-93f4-ca43eaacc8ed",
          "IPS": [
            "172.16.168.209"
          ],
          "Role": "master",
          "PORT": 11211
        }
      ]
    }
  }
}

创建 ECS 节点

CreateECSNode 接口用于创建 ECS 节点。

请求 URL

https://mosapi.meituan.com/mcs/v1?
    Action=CreateECSNode&
    请求参数&
    AUTHDATA

请求参数

参数名
类型
说明
可选值
示例
备注
ECSId string 要创建节点的ECS集群ID 必选    
Count integer 创建的节点个数 可选，默认1个    

返回参数

参数名
类型
说明
示例
备注
 
return
 bool      

返回示例（JSON）

{
  "CreateECSNodeResponse": {
    "return": true
  }
}

删除节点

DeleteCDSNode 接口用于删除 Node 节点。

请求 URL

https://mosapi.meituan.com/mcs/v1?
    Action=DeleteCDSNode&
    请求参数&
    AUTHDATA

请求参数

参数名
类型
说明
可选值
示例
备注
NodeId string Node节点资源ID 必选    

返回参数

参数名
类型
说明
示例
备注
 
return
 bool      

返回示例（JSON）

{
  "DeleteCDSNodeResponse": {
    "return": true
  }
}