云数据库RedisAPI文档_实例相关 - 帮助中心

1.获取实例列表

接口地址

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

HTTP METHOD

POST

HTTP BODY编码格式

application/x-www-form-urlencoded

请求参数

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

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

返回数据

名称	类型	是否必须	备注	其他信息
code	number	非必须	错误码
message	string	非必须	错误信息
data	object	非必须	返回数据
├─ Instances	object []	非必须	实例列表	item 类型: object
├─ instanceId	string	非必须	实例ID
├─ instanceName	string	非必须	实例名称
├─ innerAddress	string	非必须	内网连接地址
├─ instanceVersion	string	非必须	版本ID
├─ instanceStatus	string	非必须	状态：Running(运行中),Creating(创建中),Recovering(备份恢复中),Reloading(重启中),Overdue(已过期),Abnormal(异常),Forbidden(已禁用),Flushing(清除数据中),Backuping(备份中)
├─ instanceExpired	number	非必须	是否过期
├─ instanceConfigure	string	非必须	配置
├─ instanceMemory	string	非必须	内存（G）
├─ versionClass	string	非必须	版本号(2.8, 4.0, 5.0)
├─ memoryUsage	string	非必须	内存使用率
├─ maxInnerBandwidth	string	非必须	最大内网带宽
├─ maxConnections	string	非必须	最大连接数
├─ createTime	string	非必须	开通时间
├─ expireTime	string	非必须	有效期
├─ regionId	number	非必须	机房ID
├─ currentPage	number	非必须	页码
├─ pageSize	string	非必须	每页数量
├─ totalResult	string	非必须	总记录数
requestId	string	非必须	请求ID

请求示例

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

返回示例

{
    "code": 200,
    "message": "请求成功",
    "data": {
        "Instances": [
            {
                "instanceId": "yisuredis-60exxxxx663-40223956",
                "instanceName": "yisuredis-60exxxxxx663-40223956",
                "innerAddress": "172.248.190.40",
                "instanceVersion": "Redis 5.0",
                "instanceStatus": "normal",
                "instanceExpired": 0,
                "instanceConfigure": "2G主从版",
                "instanceMemory": "2",
                "versionClass": "5.0",
                "memoryUsage": "0.06%",
                "maxInnerBandwidth": "16",
                "maxConnections": "10000",
                "createTime": "2021-07-13 10:35:09",
                "expireTime": "2021-08-13 00:00:00",
                "regionId": 2
            }
        ],
        "currentPage": 1,
        "pageSize": "2",
        "totalResult": "1"
    },
    "requestId": "916638ac440ee68523bc0a64696e3ed5"
}

2.获取实例明细

接口地址

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

HTTP METHOD

POST

HTTP BODY编码格式

application/x-www-form-urlencoded

请求参数

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

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

返回数据

名称	类型	是否必须	备注
code	number	非必须	错误码
message	string	非必须	错误信息
data	object	非必须	返回数据
├─ instanceAttribute	object	非必须	实例信息
├─ instanceId	string	非必须	实例ID
├─ instanceName	string	非必须	实例名
├─ innerAddress	string	非必须	内网连接地址
├─ instanceVersion	string	非必须	版本ID
├─ instanceStatus	string	非必须	状态：Running(运行中),Creating(创建中),Recovering(备份恢复中),Reloading(重启中),Overdue(已过期),Abnormal(异常),Forbidden(已禁用),Flushing(清除数据中),Backuping(备份中)
├─ instanceExpired	number	非必须	是否过期
├─ instanceConfigure	string	非必须	配置
├─ instanceMemory	number	非必须	内存
├─ versionClass	string	非必须	版本号
├─ memoryUsage	string	非必须	内存使用率
├─ maxInnerBandwidth	number	非必须	最大内网带宽
├─ maxConnections	number	非必须	最大连接数
├─ createTime	string	非必须	开通时间
├─ expireTime	string	非必须	过期时间
├─ regionId	number	非必须	机房ID
requestId	string	非必须	请求ID

请求示例

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

返回示例

{
    "code": 200,
    "message": "请求成功",
    "data": {
        "instanceAttribute": {
            "instanceId": "yisuredis-60exxxxxx663-40223956",
            "instanceName": "yisuredis-60exxxxxxx663-40223956",
            "innerAddress": "172.248.190.40",
            "instanceVersion": "Redis 5.0",
            "instanceStatus": "normal",
            "instanceExpired": 0,
            "instanceConfigure": "2G主从版",
            "instanceMemory": 2,
            "versionClass": "5.0",
            "memoryUsage": "0.06%",
            "maxInnerBandwidth": 16,
            "maxConnections": 10000,
            "createTime": "2021-07-13 10:35:09",
            "expireTime": "2021-08-13 00:00:00",
            "regionId": 2
        }
    },
    "requestId": "31efe98f2c7004f76508f0fa477b6b1b"
}

3.修改实例信息

接口地址

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

HTTP METHOD

POST

HTTP BODY编码格式

application/x-www-form-urlencoded

请求参数

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

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

返回数据

名称	类型	是否必须	备注
code	number	非必须	错误码
message	string	非必须	错误信息
requestId	string	非必须	请求ID

请求示例

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

返回示例

{
    "code": 200,
    "message": "请求成功",
    "requestId": "ada0f4dae3c74e11fcba7afc3de6fdc4"
}

4.重启实例

接口地址

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

HTTP METHOD

POST

HTTP BODY编码格式

application/x-www-form-urlencoded

请求参数

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

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

返回数据

名称	类型	是否必须	备注
code	number	非必须	错误码
message	string	非必须	错误信息
requestId	string	非必须	请求ID

请求示例

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

返回示例

{
    "code": 200,
    "message": "请求成功",
    "requestId": "07917179235e9350c37f6e8a88c80716"
}

5.清除实例数据

接口地址

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

HTTP METHOD

POST

HTTP BODY编码格式

application/x-www-form-urlencoded

请求参数

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

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

返回数据

名称	类型	是否必须	备注
code	number	非必须	错误码
message	string	非必须	错误信息
requestId	string	非必须	请求ID

请求示例

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

返回示例

{
    "code": 200,
    "message": "请求成功",
    "requestId": "a1c0bb820c24cd37d12e1e00039dfc6e"
}

6.创建实例

接口地址

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	是	确认密码

返回数据

名称	类型	是否必须	备注
code	number	非必须	错误码
message	string	非必须	错误信息
data	object	非必须	返回数据
├─ orderId	string	必须	订单ID
├─ instanceId	string	必须	实例ID
├─ expireTime	string	必须	到期时间
requestId	string	非必须	请求ID

请求示例

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

返回示例

{
    "code": 17031,
    "message": "当前配置不存在",
    "requestId": "b3a2d08b7388f3c4397d7a298fa8da5c"
}

7.实例续费

接口地址

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

HTTP METHOD

POST

HTTP BODY编码格式

application/x-www-form-urlencoded

请求参数

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

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

返回数据

名称	类型	是否必须	备注
code	number	非必须	错误码
message	string	非必须	错误信息
data	object	非必须	返回数据
├─ orderId	string	非必须	订单ID
├─ instanceId	string	非必须	实例ID
├─ expireTime	string	非必须	到期时间
requestId	string	非必须	请求ID