云数据库RedisAPI文档_账号相关 - 帮助中心

1.账号列表

接口地址

https://api.yisu.com/redis/account/getAccountList

HTTP METHOD

POST

HTTP BODY编码格式

application/x-www-form-urlencoded

请求参数

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

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

返回数据

名称	类型	是否必须	备注	其他信息
code	number	非必须	错误码
message	string	非必须	错误信息
data	object	非必须	返回数据
├─ Accounts	object []	非必须	账号列表	item 类型: object
├─ accountId	string	非必须	账号ID
├─ accountName	string	非必须	账号名
├─ accountType	string	非必须	账号类型：normal(普通)
├─ accountStatus	string	非必须	状态：usable(可用)，disable(不可用)
├─ dbPrivilege	string	非必须	权限：read，write，copy
├─ accountDescription	string	非必须	描述
├─ instanceId	string	非必须	实例ID
requestId	string	非必须	请求ID

请求示例

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

返回示例

{
    "code": 200,
    "message": "请求成功",
    "data": {
        "Accounts": [
            {
                "accountId": "261",
                "accountName": "yisuredis-60ecfbddc5",
                "accountType": "super",
                "accountStatus": "1",
                "dbPrivilege": "write",
                "accountDescription": "默认账号",
                "instanceId": "237"
            }
        ]
    },
    "requestId": "9ba12fd4071cba66cf0cba8c40fbe5df"
}

2.重置账号的密码

接口地址

https://api.yisu.com/redis/account/resetAccountPassword

HTTP METHOD

POST

HTTP BODY编码格式

application/x-www-form-urlencoded

请求参数

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

名称	类型	是否必填	说明
instanceId	string	是	实例ID
accountName	string	是	账号名
Password	string	是	密码
confirmPassword	string	是	确认密码

返回数据

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

请求示例

    curl -XPOST
    "https://api.yisu.com/redis/account/resetAccountPassword" \
    -H "content-type: application/x-www-form-urlencoded" \
    -d "accessId=abcdefghijklmnop&nonce=48693365&signature=wm8pQlU34oA5NAEffMtc8NQHues%3D&instanceId=yisuredis-60ecfbddc5e663-40223956=accountName=yisuredis-60ecfbddc5=Password=Yisu1234=confirmPassword=Yisu1234"

返回示例

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

3.设置账号权限

接口地址

https://api.yisu.com/redis/account/modifyAccountPrivilege

HTTP METHOD

POST

HTTP BODY编码格式

application/x-www-form-urlencoded

请求参数

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

名称	类型	是否必填	说明
instanceId	string	是	实例ID
accountName	string	是	账号名
dbPrivilege	string	是	权限（read, write,copy）

返回数据

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

请求示例

    curl -XPOST
    "https://api.yisu.com/redis/account/modifyAccountPrivilege" \
    -H "content-type: application/x-www-form-urlencoded" \
    -d "accessId=abcdefghijklmnop&nonce=48693365&signature=wm8pQlU34oA5NAEffMtc8NQHues%3D&instanceId=yisuredis-60ecfbddc5e663-40223956=accountName=yisuredis-60ecfbddc5=dbPrivilege=read"

返回示例

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

4.设置账号备注

接口地址

https://api.yisu.com/redis/account/modifyAccountDescription

HTTP METHOD

POST

HTTP BODY编码格式

application/x-www-form-urlencoded

请求参数

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

名称	类型	是否必填	说明
instanceId	string	是	实例ID
accountName	string	是	账号名
accountDescription	string	是	账号描述

返回数据

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

请求示例

    curl -XPOST
    "https://api.yisu.com/redis/account/modifyAccountDescription" \
    -H "content-type: application/x-www-form-urlencoded" \
    -d "accessId=abcdefghijklmnop&nonce=48693365&signature=wm8pQlU34oA5NAEffMtc8NQHues%3D&instanceId=yisuredis-60ecfbddc5e663-40223956=accountName=yisuredis-60ecfbddc5=accountDescription=%E9%BB%98%E8%AE%A4%E8%B4%A6%E5%8F%B7%E6%8F%8F%E8%BF%B0api%E6%B5%8B%E8%AF%95"

返回示例

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

5.创建账号

接口地址

https://api.yisu.com/redis/account/createAccount

HTTP METHOD

POST

HTTP BODY编码格式

application/x-www-form-urlencoded

请求参数

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

名称	类型	是否必填	说明
instanceId	string	是	实例ID
accountName	string	是	账号名
accountDescription	string	否	备注
Password	string	是	密码
confirmPassword	string	是	确认密码
Privilege	string	是	权限（read, write, copy）

返回数据

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

请求示例

    curl -XPOST
    "https://api.yisu.com/redis/account/createAccount" \
    -H "content-type: application/x-www-form-urlencoded" \
    -d "accessId=abcdefghijklmnop&nonce=48693365&signature=wm8pQlU34oA5NAEffMtc8NQHues%3D&instanceId=yisuredis-60ecfbddc5e663-40223956=accountName=yisu_test=accountDescription=api%E6%B5%8B%E8%AF%95%E5%88%9B%E5%BB%BA%E8%B4%A6%E5%8F%B7=Password=Yisu1234=confirmPassword=Yisu1234=Privilege=write"

返回示例

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

6.删除账号

接口地址

https://api.yisu.com/redis/account/deletedAccount

HTTP METHOD

POST

HTTP BODY编码格式

application/x-www-form-urlencoded

请求参数

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

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

返回数据

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

请求示例

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

返回示例

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