文档中心

缓存数据库Redis API参考手册

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

2 缓存数据库 Redis 产商品数据管理

2.1 DescribeRegions

调用 DescribeRegions 接口查询 Region、Zone 信息。

2.1.1 使用说明

GET https://{Endpoint}/redis/v1.0/describeRegions

2.1.2 请求参数

无

2.1.3 返回数据

2.1.4 示例

1. 请求示例
GET https://{Endpoint}/redis/v1.0/describeRegions
2. 正常返回示例
HTTP/1.1 200 OK
Content-Type:application/json
{
     "RequestId": "123456",
      "Items": [
      {
          "RegionId": "paas-test",
          "RegionName": "paas-test",
          "ZoneList": [
          {
             "ZoneId": "zone-1",
              "ZoneName": "可用区 01"
          }
          ]
    }
      ]
}

2.2 DescribeSpecSeries

调用 DescribeSpecSeries 接口查询系列信息。

2.2.1 使用说明

调用 DescribeSpecSeries 接口查询系列信息。

2.2.2 请求参数

表2-1 Params 中的请求参数

2.2.3 返回数据

2.2.4 示例

1. 请求示例
GET https://{Endpoint}/redis/v1.0/describeSpecSeries?RegionId=paas-test
2. 正常返回示例
HTTP/1.1 200 OK
Content-Type:application/json
{
     "RequestId": "123456",
      "Items": [
      {
        "Text": "集群版",
          "Value": "cluster"
      }
      ]
}

2.3 DescribeDbEngine

调用 DescribeDbEngine 接口查询数据库类型。

2.3.1 使用说明

GET https://{Endpoint}/redis/v1.0/describeDbEngine

2.3.2 请求参数

表2-2 Params 中的请求参数

2.3.3 返回数据

2.3.4 示例

1. 请求示例
GET https://{Endpoint}/redis/v1.0/describeDbEngine?RegionId=paas-test&ArchType=1
2. 正常返回示例
HTTP/1.1 200 OK
Content-Type:application/json
{
     "RequestId": "123456",
      "Items": [
      {
        "Text": "Redis5.0",
        "Value": "Redis5.0"
      }
      ]
}

2.4 DescribeEngines

调用 DescribeEngines 接口查询数据库类型。

2.4.1 使用说明

GET https://{Endpoint}/redis/v1.0/describeEngines

2.4.2 请求参数

表2-3 Params 中的请求参数

2.4.3 返回数据

2.4.4 示例

1. 请求示例
GET https://{Endpoint}/redis/v1.0/describeEngines?RegionId=paas-test
2. 正常返回示例
HTTP/1.1 200 OK
Content-Type:application/json
{
     "RequestId": "123456",
      "Items": [
      {
          "Text": "Redis",
         "Value": "Redis"
      }
      ]
}

2.5 DescribeArchTypes

调用 DescribeArchTypes 接口查询系统架构。

2.5.1 使用说明

GET https://{Endpoint}/redis/v1.0/describeArchTypes

2.5.2 请求参数

表2-4 Params 中的请求参数

2.5.3 返回数据

2.5.4 示例

1. 请求示例
GET https://{Endpoint}/redis/v1.0/describeArchTypes?RegionId=paas-test
2. 正常返回示例
HTTP/1.1 200 OK
Content-Type:application/json
{
     "RequestId": "123456",
      "Items": [
      {
          "Text": "飞腾计算",
          "Value": "1"
      },
      {
          "Text": "X86 计算",
          "Value": "2"
      }
      ]
}

2.6 DescribeShard

调用 DescribeShard 接口查询分片数。

2.6.1 使用说明

GET https://{Endpoint}/redis/v1.0/describeShard

2.6.2 请求参数

表2-5 Params 中的请求参数

2.6.3 返回数据

2.6.4 示例

1. 请求示例
GET https://{Endpoint}/redis/v1.0/describeShard?RegionId=paas-test&ArchType=1
2. 正常返回示例
HTTP/1.1 200 OK
Content-Type:application/json
{
     "RequestId": "123456",
      "Items": [
      {
          "Text": "16 分片",
          "Value": "16"
      },
      {
          "Text": "4 分片",
          "Value": "4"
      }
      ]
}

2.7 DescribeReplica

调用 DescribeReplica 接口查询副本数。

2.7.1 使用说明

GET https://{Endpoint}/redis/v1.0/describeReplica

2.7.2 请求参数

表2-6 Params 中的请求参数

2.7.3 返回数据

2.7.4 示例

1. 请求示例
GET https://{Endpoint}/redis/v1.0/describeReplica?RegionId=paas-test&ArchType=1
2. 正常返回示例
HTTP/1.1 200 OK
Content-Type:application/json
{
     "RequestId": "123456",
    "Items": [
      {
          "Text": "2 副本",
          "Value": "2"
      }
     ]
}

2.8 DescribeAvailableClasses

调用 DescribeAvailableClasses 接口查询规格。

2.8.1 使用说明

GET https://{Endpoint}/redis/v1.0/describeAvailableClasses

2.8.2 请求参数

表2-7 Params 中的请求参数

2.8.3 返回数据

2.8.4 示例

1. 请求示例
GET https://{Endpoint}/redis/v1.0/describeAvailableClasses?RegionId=paas-test&ZoneId=zone-
1&DbEngine=Redis5.0&ArchType=1&Shard=4&Series=cluster
2. 正常返回示例
HTTP/1.1 200 OK
Content-Type:application/json
{
     "RequestId": "123456",
      "Items": [
     {
          "Text": "4G 集群版(4 节点)",
          "Value": "redis.ha.logic.sharding.1g.4db.0rodb.4proxy.default"
      },
      {
          "Text": "8G 集群版(4 节点)",
          "Value": "redis.ha.logic.sharding.2g.4db.0rodb.4proxy.default"
      },
      {
          "Text": "16G 集群版(4 节点)",
          "Value": "redis.ha.logic.sharding.4g.4db.0rodb.4proxy.default"
      },
      {
        "Text": "32G 集群版(4 节点)",
          "Value": "redis.ha.logic.sharding.8g.4db.0rodb.4proxy.default"
     }
      ]
}

意见反馈

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

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