文档中心

缓存数据库Redis API参考手册

最近更新时间：2023-04-16 17:00:00

1 缓存数据库 Redis 管理

1.1 CreateInstance

调用 CreateInstance 接口创建一个缓存数据库 Redis。

1.1.1 使用说明

POST https://{Endpoint}/redis/v1.0/createDBInstance

1.1.2 请求参数

表1-1 body 中的请求参数

1.1.3 返回数据

1.1.4 示例

1. 请求示例
POST https://{Endpoint}/redis/v1.0/createDBInstance
{
     "UpgradeKernelVersion": "",
     "SubnetId": "snet-r3d37vy5l0",
     "DBParamGroupId": "",
     "InstanceName": "cecloud-redis-12345",
     "DBInstanceClass": "redis.ha.logic.sharding.1g.4db.0rodb.4proxy.default",
     "MajorVersion": "5.0",
     "RegionId": "paas-test",
     "Engine": "redis",
     "VpcId": "vpc-iek74ctzjl",
     "ArchType": "1",
     "Category": "cluster",
     "DBIsIgnoreCase": "",
     "DBInstanceStorage": "5",
     "ZoneId": "zone-1",
     "PasswordSetting": "0"
}
2. 正常返回示例
HTTP/1.1 200 OK
Content-Type:application/json
{
     "RequestId": "1822c585-fc53-4805-bf7b-1a391207c31c",
      "InstanceId": "redis-0a5547eace0844e7"
}

1.2 DetailInstance

调用 DetailInstance 接口查看 Redis 实例详情。

1.2.1 使用说明

GET https://{Endpoint}/redis/v1.0/describeDBInstance/{instanceId}

1.2.2 请求参数

表1-2 query 中的请求参数

1.2.3 返回数据

表1-3 BaseInfo 字段数据结构说明

表1-4 ConfigInfo 字段数据结构说明

表1-5 BillingIngInfo 字段数据结构说明

表1-6 RunningInfo 字段数据结构说明

1.2.4 示例

1. 请求示例
GET https://{Endpoint}/redis/v1.0/describeDBInstance/redis-0a5547eace0844e7
2. 正常返回示例
HTTP/1.1 200 OK
Content-Type:application/json
{
     "RequestId": "12dc069b-ba51-4db6-b10e-5bdf8b8b4c19",
      "BaseInfo": {
          "DBInstanceId": "redis-ab64baa797924562",
          "Name": "cecloud-redis-23456",
          "ZoneCode": "可用区 01",
          "TypeAndHaState": "4G 集群版(4 节点)",
          "StorageType": "local_ssd",
         "NetworkAddress": "redis-ab64baa797924562-inner.zone-01.paas-test.cecloudcs.com",
          "NetworkPort": "6379"
      },
      "ConfigInfo": {
          "SpecificationGroup": "",
          "EngineType": "Redis5.0",
          "Cpu": "8",
          "Storage": "4096",
          "MaxIops": "4",
          "MaxLinkNum": "0",
          "KeepingTime": null,
          "Specification": "redis.ha.logic.sharding.1g.4db.0rodb.4proxy.default",
          "AutoUpgrade": "不升级",
          "MaintainTimeStart": "02:00",
          "MaintainTimeEnd": "04:00",
          "NewConnectPerSecondLimit": 40000,
          "MaxConnectionByDirect": 40000,
          "MaxConnectionByProxy": 480000,
          "MaxBandWidth": 192,
        "QPSRefer": 400000,
          "DBVersionType": "Redis5.0",
        "Series": "4G 集群版(4 节点)"
      },
    "BillingIngInfo": {
          "BillingSchema": "2",
          "OrderNo": "220831000003517",
          "ExpiredTime": "2099-12-31 23:59:59",
          "EffectTime": "2022-08-31 15:13:16",
          "FreezedTime": "2100-01-07 23:59:59",
          "ReleaseTime": "2100-01-22 23:59:59"
      },
      "RunningInfo": {
          "State": "1",
          "VpcId": "cecloud-vpc-56160",
          "ReadOnlyInstance": 0,
          "VpcUid": "vpc-iek74ctzjl",
          "ClusterNum": 4,
          "ClusterReplicaNum": 2
      }
}

1.3 RestartInstance

调用 RestartInstance 接口重启缓存数据库 Redis。

1.3.1 使用说明

POST https://{Endpoint}/redis/v1.0/restartDBInstance/{instanceId}

1.3.2 请求参数

表1-7 query 中的请求参数

1.3.3 返回数据

1.3.4 示例

1. 请求示例
POST https://{Endpoint}/redis/v1.0/restartDBInstance/redis-0a5547eace0844e7
2. 正常返回示例
HTTP/1.1 200 OK
Content-Type:application/json
{
"RequestId": "1822c585-fc53-4805-bf7b-1a391207c31c",
"InstanceId": "redis-0a5547eace0844e7"
}

1.4 ReleaseInstance

调用 ReleaseInstance 接口释放缓存数据库 Redis。

1.4.1 使用说明

DELETE https://{Endpoint}/redis/v1.0/releaseDBInstance/{instanceId}

1.4.2 请求参数

表1-8 query 中的请求参数

1.4.3 返回数据

1.4.4 示例

1. 请求示例
DELETE https://{Endpoint}/redis/v1.0/releaseDBInstance/redis-0a5547eace0844e7
2. 正常返回示例
HTTP/1.1 200 OK
Content-Type:application/json
{
"RequestId": "1822c585-fc53-4805-bf7b-1a391207c31c",
"InstanceId": "redis-0a5547eace0844e7"
}

1.5 ResetPassword

调用 ResetPassword 接口修改缓存数据库 Redis 密码。

1.5.1 使用说明

POST https://{Endpoint}/redis/v1.0/resetPassword

1.5.2 请求参数

表1-9 body 中的请求参数

1.5.3 返回数据

1.5.4 示例

1. 请求示例
POST https://{Endpoint}/redis/v1.0/resetPassword
{
     "DBInstanceId": "redis-7c2ca69a2dd9498f",
     "EngineType": "redis",
     "AccountName": "test",
     "AccountPassword": "test",
     "AccountDescription": "test"
}
2. 正常返回示例
HTTP/1.1 200 OK
Content-Type:application/json
{
     "RequestId": "1822c585-fc53-4805-bf7b-1a391207c31c",
      "InstanceId": "redis-0a5547eace0844e7"
}

1.6 QuerySlowLog

调用 QuerySlowLog 接口查询 redis 慢日志。

1.6.1 使用说明

GET https://{Endpoint}/redis/v1.0/slowLog/{instanceId}
默认开启。
关闭方法：调用 ModifyParameters 接口，参数 ConfigKey 的值设置为 slowlog-log-slower-than，ConfigValue 的值设置为-1。

1.6.2 请求参数

表1-10 Query 请求参数

表1-11 Param 请求参数

1.6.3 返回数据

表1-12 SlowLog 结构

1.6.4 示例

1. 请求示例
GET https://{Endpoint}/redis/v1.0/slowLog/redis-0a5547eace0844e7?Number=1
2. 正常返回示例
HTTP/1.1 200 OK
Content-Type:application/json
{
     "code": "0",
    "msg": "调用成功",
    "data": {
         "RequestId": "123456",
          "SlowLog": [
          {
              "ID": 446,
            "Time": "2022-11-09T11:34:59+08:00",
             "ExecutionTime": 14000,
              "Args": [
                  "role"
              ],
              "ClientAddr": "192.168.0.4:52526",
              "ClientName": ""
          },
          {
              "ID": 454,
              "Time": "2022-11-09T11:34:59+08:00",
              "ExecutionTime": 12000,
              "Args": [
                  "role"
              ],
            "ClientAddr": "192.168.0.4:43154",
              "ClientName": ""
          },
        {
              "ID": 419,
            "Time": "2022-11-09T11:34:59+08:00",
              "ExecutionTime": 11000,
              "Args": [
                  "role"
              ],
              "ClientAddr": "192.168.0.4:53614",
              "ClientName": ""
          },
          {
            "ID": 426,
            "Time": "2022-11-09T11:34:59+08:00",
            "ExecutionTime": 11000,
            "Args": [
                "role"
              ],
            "ClientAddr": "192.168.0.4:35582",
              "ClientName": ""
          }
          ]
     }
}

1.7 PurgingDataBase

调用 PurgingDataBase 接口清空数据库。

1.7.1 使用说明

DELETE https://{Endpoint}/redis/v1.0/purgingDataBase/{instanceId}

1.7.2 请求参数

表1-13 请求参数

1.7.3 返回数据

1.7.4 示例

1. 请求示例
DELETE https://{Endpoint}/redis/v1.0/purgingDataBase/redis-cf52998b759c4
2. 正常返回示例
HTTP/1.1 200 OK
Content-Type:application/json
{
"RequestId": "1822c585-fc53-4805-bf7b-1a391207c31c",
"InstanceId": "redis-cf52998b759c4"
}

1.8 ModifyParameters

调用 ModifyParameters 接口修改数据库配置参数。

1.8.1 使用说明

PUT https://{Endpoint}/redis/v1.0/modifyParameters

1.8.2 请求参数

表1-14 Body 请求参数

1.8.3 返回数据

1.8.4 示例

1. 请求示例
PUT https://{Endpoint}/redis/v1.0/modifyParameters
2. 正常返回示例
HTTP/1.1 200 OK
Content-Type:application/json
{
"RequestId": "1822c585-fc53-4805-bf7b-1a391207c31c",
"InstanceId": "redis-cf52998b759c4"
}

意见反馈

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

如您有其他疑问，您也可以通过在线客服来与我们联系探讨在线客服