Memcached 公开API目录

• API概览
• 认证方式.md#认证方式)
  • 1.公共请求参数.md#1公共请求参数)
  • 2.签名机制.md#2签名机制)
    • 步骤一：构造规范化请求字符串.md#步骤一构造规范化请求字符串)
    • 步骤二：构造签名字符串.md#步骤二构造签名字符串)
  • 3.获取签名代码.md#2获取签名代码)
• 访问地址
• 实例
  • 1.CreateMemcachedInstance
  • 2.MemcachedInstanceList
  • 3.DescribeMemcachedInstance
  • 4.DeleteMemcachedInstance
  • 5.ClearMemcachedInstance
  • 6.UpdateMemcachedInstance

API概览

Memcached产品提供以下相关API接口。

实例

访问地址

1.CreateMemcachedInstance

Action：CreateMemcached

描述 创建一台或多台按需计费的memcached的机器。

请求地址: cdsapi.capitalonline.net/memcached

请求方法：POST

请求参数:

代码调用示例：

def create_memcached_instance(ConfSize, VdcId, PipeId, RegionId, InstanceName="", Amount=1):
    action = "CreateMemcachedInstance"
    method = "POST"
    url = get_signature(action, AK, AccessKeySecret, method, CCS_URL, param={})
    body = {"ConfSize": ConfSize,
            "VdcId": VdcId,
            "PipeId": PipeId,
            "RegionId": RegionId}
    if InstanceName:
        body["InstanceName"] = InstanceName
    if Amount:
        body["Amount"] = Amount
    res = requests.post(url, json=body)
    result = json.loads(res.content)
    return result

返回示例：

{
    "Code":"Success",
    "Data":{
        "InstanceIds":[
            "4e3bb828-c6a4-11ec-95eb-b2d9e44608b0"
        ],
        "TaskIds":[
            915
        ]
    },
    "Message":"任务下发成功！"
}

返回参数:

错误码:

2.MemcachedInstanceList

Action：MemcachedInstanceList

描述 获取memcached数据库实例列表页。

请求地址: cdsapi.capitalonline.net/memcached

请求方法：POST

请求参数:

代码调用示例：

def memcached_instance_list(VdcId="", Keyword=""):
    action = "MemcachedInstanceList"
    method = "POST"
    url = get_signature(action, AK, AccessKeySecret, method, CCS_URL, param={})
    body = {}
    if VdcId:
        body["VdcId"] = VdcId
    if Keyword:
        body["Keyword"] = Keyword
    res = requests.post(url, json=body)
    result = json.loads(res.content)
    return result

返回示例：

{
    "Code":"Success",
    "Data":{
        "CreatingTotal":0,
        "DeletingTotal":0,
        "ErrorTotal":0,
        "InstanceList":[
            {
                "Address":"10.240.166.8",
                "AppName":"wx-memcache",
                "BillMethod":"0",
                "ConfName":"Memcached单机版",
                "CreateTime":"2022-04-27 18:13:30",
                "InstanceConf":"1G",
                "InstanceId":"439b83f4-c612-11ec-95eb-b2d9e44608b0",
                "InstanceName":"api测试11-pre",
                "Port":"11211",
                "SiteName":"中国大陆-北京-可用区H",
                "Status":"running",
                "UpdateTime":"2022-04-27 18:10:28",
                "Version":"Memcached1.6"
            }
        ],
        "RunningTotal":1,
        "Total":1,
        "UpdatingTotal":0
    },
    "Message":"获取memcached列表成功！"
}

返回参数:

错误码:

3.DescribeMemcachedInstance

Action：DescribeMemcachedInstance

描述 获取memcached数据库实例详情页。

请求地址: cdsapi.capitalonline.net/memcached

请求方法：POST

请求参数:

代码调用示例：

def describe_memcached_instance(InstanceId=""):
    action = "DescribeMemcachedInstance"
    method = "POST"
    url = get_signature(action, AK, AccessKeySecret, method, CCS_URL, param={})
    body = {"InstanceId": InstanceId}
    res = requests.post(url, json=body)
    result = json.loads(res.content)
    return result

返回示例：

{
    "Code":"Success",
    "Data":{
        "Address":"10.240.166.7",
        "AppName":"wx-memcache",
        "BillMethod":"0",
        "Coon":10000,
        "CreateTime":"2022-04-27 10:31:39",
        "GoodsId":"17129",
        "InstanceConf":"2G",
        "InstanceId":"d37e3944-c5d1-11ec-b023-d21e41ec5741",
        "InstanceName":"api测试11-pre",
        "Port":"11211",
        "RunningTime":"0个月1天1小时1分47秒",
        "SiteId":"CN_Beijing_H",
        "SiteName":"中国大陆-北京-可用区H",
        "Status":"running",
        "Version":"Memcached1.6"
    },
    "Message":"获取Memcached详情成功！"
}

返回参数:

错误码:

4.DeleteMemcachedInstance

Action：DeleteMemcachedInstance

描述 删除memcached数据库实例。

请求地址: cdsapi.capitalonline.net/memcached

请求方法：POST

请求参数:

代码调用示例：

def delete_memcached_instance(InstanceId):
    action = "DeleteMemcachedInstance"
    method = "POST"
    url = get_signature(action, AK, AccessKeySecret, method, CCS_URL, param={})
    body = {"InstanceId": InstanceId}
    res = requests.post(url, json=body)
    result = json.loads(res.content)
    return result

返回示例：

{
    "Code":"Success",
    "Data":{
        "TaskId":918
    },
    "Message":"删除实例任务下发成功！"
}

返回参数:

错误码:

5.ClearMemcachedInstance

Action：ClearMemcachedInstance

描述 清空memcached数据库实例。

请求地址: cdsapi.capitalonline.net/memcached

请求方法：POST

请求参数:

代码调用示例：

def clear_memcached_instance(InstanceId):
    action = "ClearMemcachedInstance"
    method = "POST"
    url = get_signature(action, AK, AccessKeySecret, method, CCS_URL, param={})
    body = {"InstanceId": InstanceId}
    res = requests.post(url, json=body)
    result = json.loads(res.content)
    return result

返回示例：

{
    "Code":"Success",
    "Data":{
        "TaskId":917
    },
    "Message":"清空memcached的数据信息成功"
}

返回参数:

错误码:

6.UpdateMemcachedInstance

Action：UpdateMemcachedInstance

描述 更新memcached数据库实例配置。

请求地址: cdsapi.capitalonline.net/memcached

请求方法：POST

请求参数:

代码调用示例：

def UpdateMemcachedInstance(InstanceId, ConfSize):
    action = "UpdateMemcachedInstance"
    method = "POST"
    url = get_signature(action, AK, AccessKeySecret, method, CCS_URL, param={})
    body = {"InstanceId": InstanceId, "ConfSize": ConfSize}
    res = requests.post(url, json=body)
    result = json.loads(res.content)
    return result

返回示例：

{
    "Code":"Success",
    "Data":{
        "TaskId":916
    },
    "Message":"清空memcached的数据信息成功"
}

返回参数:

错误码: