云数据库Redis

实例相关

1.获取实例列表

接口地址

  1. https://api.yisu.com/redis/instance/getInstanceList

HTTP METHOD

POST

HTTP BODY编码格式

application/x-www-form-urlencoded

请求参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

名称 类型 是否必填 说明
currentPage string
pageSize string

返回数据








名称类型是否必须默认值备注其他信息
codenumber非必须错误码
messagestring非必须错误信息
dataobject非必须返回数据
├─ Instancesobject []非必须实例列表

item 类型: object

├─ instanceIdstring非必须实例ID
├─ instanceNamestring非必须实例名称
├─ innerAddressstring非必须内网连接地址
├─ instanceVersionstring非必须版本ID
├─ instanceStatusstring非必须状态:Running(运行中),Creating(创建中),Recovering(备份恢复中),Reloading(重启中),Overdue(已过期),Abnormal(异常),Forbidden(已禁用),Flushing(清除数据中),Backuping(备份中)
├─ instanceExpirednumber非必须是否过期
├─ instanceConfigurestring非必须配置
├─ instanceMemorystring非必须内存(G)
├─ versionClassstring非必须版本号(2.8, 4.0, 5.0)
├─ memoryUsagestring非必须内存使用率
├─ maxInnerBandwidthstring非必须最大内网带宽
├─ maxConnectionsstring非必须最大连接数
├─ createTimestring非必须开通时间
├─ expireTimestring非必须有效期
├─ regionIdnumber非必须机房ID
├─ currentPagenumber非必须页码
├─ pageSizestring非必须每页数量
├─ totalResultstring非必须总记录数
requestIdstring非必须请求ID

请求示例

  1. curl -XPOST
  2. "https://api.yisu.com/redis/instance/getInstanceList" \
  3. -H "content-type: application/x-www-form-urlencoded" \
  4. -d "accessId=abcdefghijklmnop&nonce=48693365&signature=wm8pQlU34oA5NAEffMtc8NQHues%3D¤tPage=2=pageSize=2"

返回示例

  1. {
  2. "code": 200,
  3. "message": "请求成功",
  4. "data": {
  5. "Instances": [
  6. {
  7. "instanceId": "yisuredis-60exxxxx663-40223956",
  8. "instanceName": "yisuredis-60exxxxxx663-40223956",
  9. "innerAddress": "172.248.190.40",
  10. "instanceVersion": "Redis 5.0",
  11. "instanceStatus": "normal",
  12. "instanceExpired": 0,
  13. "instanceConfigure": "2G主从版",
  14. "instanceMemory": "2",
  15. "versionClass": "5.0",
  16. "memoryUsage": "0.06%",
  17. "maxInnerBandwidth": "16",
  18. "maxConnections": "10000",
  19. "createTime": "2021-07-13 10:35:09",
  20. "expireTime": "2021-08-13 00:00:00",
  21. "regionId": 2
  22. }
  23. ],
  24. "currentPage": 1,
  25. "pageSize": "2",
  26. "totalResult": "1"
  27. },
  28. "requestId": "916638ac440ee68523bc0a64696e3ed5"
  29. }

2.获取实例明细

接口地址

  1. https://api.yisu.com/redis/instance/getInstanceDetails

HTTP METHOD

POST

HTTP BODY编码格式

application/x-www-form-urlencoded

请求参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

名称 类型 是否必填 说明
instanceId string 实例ID

返回数据








名称类型是否必须默认值备注其他信息
codenumber非必须错误码
messagestring非必须错误信息
dataobject非必须返回数据
├─ instanceAttributeobject非必须实例信息
├─ instanceIdstring非必须实例ID
├─ instanceNamestring非必须实例名
├─ innerAddressstring非必须内网连接地址
├─ instanceVersionstring非必须版本ID
├─ instanceStatusstring非必须状态:Running(运行中),Creating(创建中),Recovering(备份恢复中),Reloading(重启中),Overdue(已过期),Abnormal(异常),Forbidden(已禁用),Flushing(清除数据中),Backuping(备份中)
├─ instanceExpirednumber非必须是否过期
├─ instanceConfigurestring非必须配置
├─ instanceMemorynumber非必须内存
├─ versionClassstring非必须版本号
├─ memoryUsagestring非必须内存使用率
├─ maxInnerBandwidthnumber非必须最大内网带宽
├─ maxConnectionsnumber非必须最大连接数
├─ createTimestring非必须开通时间
├─ expireTimestring非必须过期时间
├─ regionIdnumber非必须机房ID
requestIdstring非必须请求ID

请求示例

  1. curl -XPOST
  2. "https://api.yisu.com/redis/instance/getInstanceDetails" \
  3. -H "content-type: application/x-www-form-urlencoded" \
  4. -d "accessId=abcdefghijklmnop&nonce=48693365&signature=wm8pQlU34oA5NAEffMtc8NQHues%3D&instanceId=yisuredis-60exxxxxxx663-40223956"

返回示例

  1. {
  2. "code": 200,
  3. "message": "请求成功",
  4. "data": {
  5. "instanceAttribute": {
  6. "instanceId": "yisuredis-60exxxxxx663-40223956",
  7. "instanceName": "yisuredis-60exxxxxxx663-40223956",
  8. "innerAddress": "172.248.190.40",
  9. "instanceVersion": "Redis 5.0",
  10. "instanceStatus": "normal",
  11. "instanceExpired": 0,
  12. "instanceConfigure": "2G主从版",
  13. "instanceMemory": 2,
  14. "versionClass": "5.0",
  15. "memoryUsage": "0.06%",
  16. "maxInnerBandwidth": 16,
  17. "maxConnections": 10000,
  18. "createTime": "2021-07-13 10:35:09",
  19. "expireTime": "2021-08-13 00:00:00",
  20. "regionId": 2
  21. }
  22. },
  23. "requestId": "31efe98f2c7004f76508f0fa477b6b1b"
  24. }

3.修改实例信息

接口地址

  1. https://api.yisu.com/redis/instance/modifyInstanceInfo

HTTP METHOD

POST

HTTP BODY编码格式

application/x-www-form-urlencoded

请求参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

名称 类型 是否必填 说明
instanceId string 实例ID
instanceName string 实例名称

返回数据








名称类型是否必须默认值备注其他信息
codenumber非必须错误码
messagestring非必须错误信息
requestIdstring非必须请求ID

请求示例

  1. curl -XPOST
  2. "https://api.yisu.com/redis/instance/modifyInstanceInfo" \
  3. -H "content-type: application/x-www-form-urlencoded" \
  4. -d "accessId=abcdefghijklmnop&nonce=48693365&signature=wm8pQlU34oA5NAEffMtc8NQHues%3D&instanceId=yisuredis-60exxxxxxx663-40223956=instanceName=api%E6%B5%8B%E8%AF%95Redis"

返回示例

  1. {
  2. "code": 200,
  3. "message": "请求成功",
  4. "requestId": "ada0f4dae3c74e11fcba7afc3de6fdc4"
  5. }

4.重启实例

接口地址

  1. https://api.yisu.com/redis/instance/reloadInstance

HTTP METHOD

POST

HTTP BODY编码格式

application/x-www-form-urlencoded

请求参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

名称 类型 是否必填 说明
instanceId string 实例ID

返回数据








名称类型是否必须默认值备注其他信息
codenumber非必须错误码
messagestring非必须错误信息
requestIdstring非必须请求ID

请求示例

  1. curl -XPOST
  2. "https://api.yisu.com/redis/instance/reloadInstance" \
  3. -H "content-type: application/x-www-form-urlencoded" \
  4. -d "accessId=abcdefghijklmnop&nonce=48693365&signature=wm8pQlU34oA5NAEffMtc8NQHues%3D&instanceId=yisuredis-60exxxxxxx663-40223956"

返回示例

  1. {
  2. "code": 200,
  3. "message": "请求成功",
  4. "requestId": "07917179235e9350c37f6e8a88c80716"
  5. }

5.清除实例数据

接口地址

  1. https://api.yisu.com/redis/instance/flushInstance

HTTP METHOD

POST

HTTP BODY编码格式

application/x-www-form-urlencoded

请求参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

名称 类型 是否必填 说明
instanceId string 实例ID

返回数据








名称类型是否必须默认值备注其他信息
codenumber非必须错误码
messagestring非必须错误信息
requestIdstring非必须请求ID

请求示例

  1. curl -XPOST
  2. "https://api.yisu.com/redis/instance/flushInstance" \
  3. -H "content-type: application/x-www-form-urlencoded" \
  4. -d "accessId=abcdefghijklmnop&nonce=48693365&signature=wm8pQlU34oA5NAEffMtc8NQHues%3D&instanceId=yisuredis-60exxxxxxx663-40223956"

返回示例

  1. {
  2. "code": 200,
  3. "message": "请求成功",
  4. "requestId": "a1c0bb820c24cd37d12e1e00039dfc6e"
  5. }

6.创建实例

接口地址

  1. https://api.yisu.com/redis/public/createInstance

HTTP METHOD

POST

HTTP BODY编码格式

application/x-www-form-urlencoded

请求参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

名称 类型 是否必填 说明
instanceMonth string 购买月份
regionId string 机房ID
versionClass string 版本号
configureId string 配置ID
instanceNum string 购买数量
isAutoPwd string 是否自动生成密码
password string 密码
confirmPassword string 确认密码

返回数据








名称类型是否必须默认值备注其他信息
codenumber非必须错误码
messagestring非必须错误信息
dataobject非必须返回数据
├─ orderIdstring必须订单ID
├─ instanceIdstring必须实例ID
├─ expireTimestring必须到期时间
requestIdstring非必须请求ID

请求示例

  1. curl -XPOST
  2. "https://api.yisu.com/redis/public/createInstance" \
  3. -H "content-type: application/x-www-form-urlencoded" \
  4. -d "accessId=abcdefghijklmnop&nonce=48693365&signature=wm8pQlU34oA5NAEffMtc8NQHues%3D&instanceMonth=1=regionId=2=versionClass=4.0=configureId=868=instanceNum=1=isAutoPwd=1=password==confirmPassword="

返回示例

  1. {
  2. "code": 17031,
  3. "message": "当前配置不存在",
  4. "requestId": "b3a2d08b7388f3c4397d7a298fa8da5c"
  5. }

7.实例续费

接口地址

  1. https://api.yisu.com/redis/instance/renewInstance

HTTP METHOD

POST

HTTP BODY编码格式

application/x-www-form-urlencoded

请求参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

名称 类型 是否必填 说明
instanceId string 实例ID
instanceMonth string 续费月份

返回数据








名称类型是否必须默认值备注其他信息
codenumber非必须错误码
messagestring非必须错误信息
dataobject非必须返回数据
├─ orderIdstring非必须订单ID
├─ instanceIdstring非必须实例ID
├─ expireTimestring非必须到期时间
requestIdstring非必须请求ID