中国站
帮助中心 > 数据库 > 云数据库Redis > API文档 > 账号相关

账号相关

1.账号列表

接口地址

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

HTTP METHOD

POST

HTTP BODY编码格式

application/x-www-form-urlencoded

请求参数

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

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

返回数据








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

item 类型: object

├─ accountIdstring非必须账号ID
├─ accountNamestring非必须账号名
├─ accountTypestring非必须账号类型:normal(普通)
├─ accountStatusstring非必须状态:usable(可用),disable(不可用)
├─ dbPrivilegestring非必须权限:read,write,copy
├─ accountDescriptionstring非必须描述
├─ instanceIdstring非必须实例ID
requestIdstring非必须请求ID

请求示例

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

返回示例

  1. {
  2. "code": 200,
  3. "message": "请求成功",
  4. "data": {
  5. "Accounts": [
  6. {
  7. "accountId": "261",
  8. "accountName": "yisuredis-60ecfbddc5",
  9. "accountType": "super",
  10. "accountStatus": "1",
  11. "dbPrivilege": "write",
  12. "accountDescription": "默认账号",
  13. "instanceId": "237"
  14. }
  15. ]
  16. },
  17. "requestId": "9ba12fd4071cba66cf0cba8c40fbe5df"
  18. }

2.重置账号的密码

接口地址

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

返回数据








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

请求示例

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

返回示例

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

3.设置账号权限

接口地址

  1. 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)

返回数据








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

请求示例

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

返回示例

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

4.设置账号备注

接口地址

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

HTTP METHOD

POST

HTTP BODY编码格式

application/x-www-form-urlencoded

请求参数

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

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

返回数据








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

请求示例

  1. curl -XPOST
  2. "https://api.yisu.com/redis/account/modifyAccountDescription" \
  3. -H "content-type: application/x-www-form-urlencoded" \
  4. -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"

返回示例

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

5.创建账号

接口地址

  1. 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)

返回数据








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

请求示例

  1. curl -XPOST
  2. "https://api.yisu.com/redis/account/createAccount" \
  3. -H "content-type: application/x-www-form-urlencoded" \
  4. -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"

返回示例

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

6.删除账号

接口地址

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

HTTP METHOD

POST

HTTP BODY编码格式

application/x-www-form-urlencoded

请求参数

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

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

返回数据








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

请求示例

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

返回示例

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